nystudio107 / craft-vite

src/services/Helper.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\services;

use Craft;
use craft\base\Component;
use craft\helpers\Html;
use nystudio107\pluginvite\helpers\FileHelper;
use nystudio107\pluginvite\helpers\ManifestHelper;
use nystudio107\vite\models\Settings;
use nystudio107\vite\Vite;
use Twig\Error\LoaderError;

/**

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.5

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

class Helper extends Component
{
    /**
     * Returns the Critical CSS file for $template wrapped in <style></style>
     * tags
     *
     * @param null|string $name

Missing parameter comment

     * @param array $attributes additional HTML key/value pair attributes to add to the resulting tag

Expected 7 spaces after parameter type; 1 found

     *
     * @return string
     * @throws LoaderError
     */
    public function getCriticalCssTags(?string $name = null, array $attributes = []): string
    {
        // Resolve the template name
        $template = Craft::$app->getView()->resolveTemplate($name ?? Vite::$templateName ?? '');
        if ($template) {
            /** @var Settings $settings */

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

            $settings = Vite::$plugin->getSettings();
            $name = FileHelper::createUrl(
                pathinfo($template, PATHINFO_DIRNAME),

It seems like pathinfo($template, nystudio107\vite\services\PATHINFO_DIRNAME) can also be of type array; however, parameter $url of nystudio107\pluginvite\helpers\FileHelper::createUrl() does only seem to accept string, maybe add an additional type check?

                pathinfo($template, PATHINFO_FILENAME)

It seems like pathinfo($template, nystudio107\vite\services\PATHINFO_FILENAME) can also be of type array; however, parameter $path of nystudio107\pluginvite\helpers\FileHelper::createUrl() does only seem to accept string, maybe add an additional type check?

            );
            $dirPrefix = 'templates/';
            if (defined('CRAFT_TEMPLATES_PATH')) {
                $dirPrefix = CRAFT_TEMPLATES_PATH;
            }
            $name = strstr($name, $dirPrefix);
            $pos = strpos($name, $dirPrefix);
            if ($pos !== false) {
                $name = (string)substr_replace($name, '', $pos, strlen($dirPrefix));
            }
            $path = FileHelper::createUrl(
                    $settings->criticalPath,

This line of the multi-line function call does not seem to be indented correctly. Expected 16 spaces, but found 20.

                    $name

This line of the multi-line function call does not seem to be indented correctly. Expected 16 spaces, but found 20.

                ) . $settings->criticalSuffix;

This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.

            return $this->getCssInlineTags($path, $attributes);
        }

        return '';
    }

    /**
     * Returns the passed in CSS file at the specified file system path or URL, wrapped in
     * <style></style> tags
     *
     * @param string $path

Missing parameter comment

     * @param array $attributes additional HTML key/value pair attributes to add to the resulting tag

Expected 2 spaces after parameter type; 1 found

     *
     * @return string
     */
    public function getCssInlineTags(string $path, array $attributes = []): string
    {
        /** @var Settings $settings */

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

        $settings = Vite::$plugin->getSettings();
        $result = FileHelper::fetch($path, null, $settings->cacheKeySuffix);
        if ($result) {
            $config = [];

            return Html::style($result, array_merge($config, $attributes));

It seems like $result can also be of type array; however, parameter $content of yii\helpers\BaseHtml::style() does only seem to accept string, maybe add an additional type check?

        }

        return '';
    }

    /**
     * Return the hash value for the first CSS file bundled with the module specified via $path
     *
     * @param $path

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function getCssHash($path): string
    {
        /** @var Settings $settings */

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

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

Missing short description in doc comment

        $settings = Vite::$plugin->getSettings();
        ManifestHelper::fetchManifest($settings->manifestPath);
        $tags = ManifestHelper::manifestTags($path, false);
        foreach ($tags as $tag) {
            if (!empty($tag) && $tag['type'] === 'css') {
                // Extract only the Hash Value
                $modulePath = pathinfo($tag['url']);
                $moduleFilename = $modulePath['filename'];
                $hashPos = strpos($moduleFilename, '.') ?: strlen($moduleFilename);
                $moduleHash = substr($moduleFilename, $hashPos + 1);
                // Vite 5 now uses a `-` to separate the version hash, so account for that as well
                if (empty($moduleHash) && str_contains($moduleFilename, '-')) {
                    $moduleHash = substr($moduleFilename, strpos($moduleFilename, '-') + 1);
                }

                return $moduleHash;
            }
        }

        return '';
    }
}