nystudio107 / craft-plugin-vite

src/variables/ViteVariableTrait.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\pluginvite\variables;

use craft\helpers\Template;
use nystudio107\pluginvite\services\ViteService;
use Twig\Markup;
use yii\base\InvalidConfigException;

/**

Missing short description in doc comment

 * @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.4

The tag in position 3 should be the @author tag

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

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

trait ViteVariableTrait
{
    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var null|ViteService the Vite service
     */
    public ?ViteService $viteService = null;

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

    /**
     * Return the appropriate tags to load the Vite script, either via the dev server or
     * extracting it from the manifest.json file
     *
     * @param string $path

Missing parameter comment

     * @param bool $asyncCss

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     * @param array $scriptTagAttrs

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param array $cssTagAttrs

Expected 2 spaces after parameter type; 1 found

Missing parameter comment

     *
     * @return Markup
     */
    public function script(string $path, bool $asyncCss = true, array $scriptTagAttrs = [], array $cssTagAttrs = []): Markup
    {
        return Template::raw(
            $this->viteService->script($path, $asyncCss, $scriptTagAttrs, $cssTagAttrs)

The method script() does not exist on null.

        );
    }

    /**
     * Register the appropriate tags to the Craft View to load the Vite script, either via the dev server or
     * extracting it from the manifest.json file
     *
     * @param string $path

Missing parameter comment

     * @param bool $asyncCss

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     * @param array $scriptTagAttrs

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param array $cssTagAttrs

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     *
     * @return Markup
     * @throws InvalidConfigException
     */
    public function register(string $path, bool $asyncCss = true, array $scriptTagAttrs = [], array $cssTagAttrs = []): Markup
    {
        $this->viteService->register($path, $asyncCss, $scriptTagAttrs, $cssTagAttrs);

        return Template::raw('');
    }

    /**
     * Return the URL for the given entry
     *
     * @param string $path

Missing parameter comment

     *
     * @return Markup
     */
    public function entry(string $path): Markup
    {
        return Template::raw(
            $this->viteService->entry($path)
        );
    }

    /**
     * Return the integrity hash (or an empty string if not present) for the given entry
     *
     * @param string $path

Missing parameter comment

     *
     * @return string
     */
    public function integrity(string $path): string
    {
        return Template::raw(
            $this->viteService->integrity($path)
        );
    }

    /**

Parameter $public should have a doc-comment as per coding-style.

     * Return the URL for the given asset
     *
     * @param string $path

Missing parameter comment

     *
     * @return Markup
     */
    public function asset(string $path, bool $public = false): Markup
    {
        return Template::raw(
            $this->viteService->asset($path, $public)
        );
    }

    /**
     * Inline the contents of a local file (via path) or remote file (via URL) in your templates.
     * Yii2 aliases and/or environment variables may be used
     *
     * @param string $pathOrUrl

Missing parameter comment

     *
     * @return Markup
     */
    public function inline(string $pathOrUrl): Markup
    {
        $file = $this->viteService->fetch($pathOrUrl);
        if ($file === null) {
            $file = '';
        }

        return Template::raw($file);

It seems like $file can also be of type array; however, parameter $value of craft\helpers\Template::raw() does only seem to accept string, maybe add an additional type check?

    }

    /**
     * Determine whether the Vite dev server is running
     *
     * @return bool
     */
    public function devServerRunning(): bool
    {
        return $this->viteService->devServerRunning();
    }
}