nystudio107 / craft-twigfield

src/assetbundles/twigfield/TwigfieldAsset.php

<?php
/**
 * Twigfield for Craft CMS
 *
 * Provides a twig editor field with Twig & Craft API autocomplete
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2022 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\twigfield\assetbundles\twigfield;

use craft\web\AssetBundle;
use craft\web\View;

/**

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   Twigfield

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 @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class TwigfieldAsset extends AssetBundle
{
    // Public Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function init()
    {
        $this->sourcePath = '@nystudio107/twigfield/web/assets/dist';
        $this->depends = [
        ];
        $this->css = [
            'css/vendors.css',
            'css/styles.css',
        ];
        $this->js = [
            'js/runtime.js',
            'js/vendors.js',
            'js/javascript-editor.js'
        ];

        parent::init();
    }

    /**

Missing short description in doc comment

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

     * @inheritdoc
     */

Missing @return tag in function comment

    public function registerAssetFiles($view): void
    {
        parent::registerAssetFiles($view);

        if ($view instanceof View) {
            $view->registerTranslations('twigfield', [

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

                'Twig code is supported.'
            ]);

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

        }
    }
}