nystudio107 / craft-vite

src/Vite.php

<?php
/**
 * Vite plugin for Craft CMS
 *
 * Allows the use of the Vite.js next generation frontend tooling with Craft CMS
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2021 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace nystudio107\vite;

use Craft;
use craft\base\Model;
use craft\base\Plugin;
use craft\cloud\cli\controllers\UpController;
use craft\events\CancelableEvent;
use craft\events\RegisterCacheOptionsEvent;
use craft\events\TemplateEvent;
use craft\utilities\ClearCaches;
use craft\web\twig\variables\CraftVariable;
use craft\web\View;
use nystudio107\vite\models\Settings;
use nystudio107\vite\services\ServicesTrait;
use nystudio107\vite\variables\ViteVariable;
use yii\base\Event;

/**
 * Class Vite
 *
 * @author    nystudio107

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   Vite

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     1.0.0

The tag in position 3 should be the @author tag

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

 */

Missing @link tag in class comment

Missing @license tag in class comment

Missing @category tag in class comment

class Vite extends Plugin
{
    // Traits
    // =========================================================================

    use ServicesTrait;

    // Static Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var Vite
     */
    public static Plugin $plugin;

    /**

Missing short description in doc comment

     * @var string
     */
    public static string $templateName;

    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var string
     */
    public string $schemaVersion = '1.0.0';

    /**

Missing short description in doc comment

     * @var bool
     */
    public bool $hasCpSettings = false;

    /**

Missing short description in doc comment

     * @var bool
     */
    public bool $hasCpSection = false;

    // Public Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function init(): void
    {
        parent::init();
        self::$plugin = $this;
        // Add our event listeners
        $this->installEventListeners();
        // Log that the plugin has loaded
        Craft::info(
            Craft::t(
                'vite',
                '{name} plugin loaded',
                ['name' => $this->name]
            ),
            __METHOD__
        );
    }

    /**
     * Clear all the caches!
     */

Missing @return tag in function comment

    public function clearAllCaches(): void
    {
        // Clear all of Vite's caches
        $this->vite->invalidateCaches();
    }

    // Protected Methods
    // =========================================================================

    /**
     * Install our event listeners.
     */

Missing @return tag in function comment

    protected function installEventListeners(): void
    {
        // Register our variable
        Event::on(
            CraftVariable::class,
            CraftVariable::EVENT_INIT,
            function(Event $event) {

Expected 1 space after FUNCTION keyword; 0 found

                /** @var CraftVariable $variable */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                $variable = $event->sender;
                $variable->set('vite', [

The opening parenthesis of a multi-line function call should be the last content on the line.

                    'class' => ViteVariable::class,
                    'viteService' => $this->vite,
                ]);

For multi-line function calls, the closing parenthesis should be on a new line.

            }
        );
        // Handler: ClearCaches::EVENT_REGISTER_CACHE_OPTIONS
        Event::on(
            ClearCaches::class,
            ClearCaches::EVENT_REGISTER_CACHE_OPTIONS,
            function(RegisterCacheOptionsEvent $event) {

Expected 1 space after FUNCTION keyword; 0 found

                Craft::debug(
                    'ClearCaches::EVENT_REGISTER_CACHE_OPTIONS',
                    __METHOD__
                );
                // Register our caches for the Clear Cache Utility
                $event->options = array_merge(
                    $event->options,
                    $this->customAdminCpCacheOptions()
                );
            }
        );
        // Remember the name of the currently rendering template
        // Handler: View::EVENT_BEFORE_RENDER_PAGE_TEMPLATE
        Event::on(
            View::class,
            View::EVENT_BEFORE_RENDER_PAGE_TEMPLATE,
            static function(TemplateEvent $event) {

Expected 1 space after FUNCTION keyword; 0 found

                self::$templateName = $event->template;
            }
        );
        // Clears cache after craft cloud/up is run, which Craft Cloud runs on deploy
        // Handler: UpController::EVENT_AFTER_UP
        if (class_exists(UpController::class)) {
            Event::on(
                UpController::class,
                UpController::EVENT_AFTER_UP,
                function(CancelableEvent $event) {

The parameter $event is not used and could be removed.

Expected 1 space after FUNCTION keyword; 0 found

                    $this->clearAllCaches();
                }
            );
        }
    }

    /**
     * Returns the custom Control Panel cache options.
     *
     * @return array
     */
    protected function customAdminCpCacheOptions(): array
    {
        return [
            // Manifest cache
            [
                'key' => 'vite-file-cache',
                'label' => Craft::t('vite', 'Vite Cache'),
                'action' => [$this, 'clearAllCaches'],
            ],
        ];
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    protected function createSettingsModel(): ?Model
    {
        return new Settings();
    }
}