nystudio107 / craft-twigpack

src/models/Settings.php

<?php
/**
 * Twigpack plugin for Craft CMS 3.x
 *
 * Twigpack is the conduit between Twig and webpack, with manifest.json &
 * webpack-dev-server HMR support
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2018 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\twigpack\models;

use craft\base\Model;

/**

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   Twigpack

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 Settings extends Model
{
    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var bool If `devMode` is on, use webpack-dev-server to all for HMR (hot
     *      module reloading)
     */
    public bool $useDevServer = true;

    /**

Missing short description in doc comment

     * @var bool If true, enforces Absolute Urls, if false, allows relative
     */
    public bool $useAbsoluteUrl = true;

    /**

Missing short description in doc comment

     * @var array|string The JavaScript entry from the manifest.json to inject on
     *      Twig error pages
     */
    public array|string $errorEntry = '';

    /**

Missing short description in doc comment

     * @var string String to be appended to the cache key
     */
    public string $cacheKeySuffix = '';

    /**

Missing short description in doc comment

     * @var array Manifest file names
     */
    public array $manifest = [
        'legacy' => 'manifest-legacy.json',
        'modern' => 'manifest.json',
    ];

    /**

Missing short description in doc comment

     * @var array Public server config
     */
    public array $server = [
        'manifestPath' => '/',
        'publicPath' => '/',
    ];

    /**

Missing short description in doc comment

     * @var array webpack-dev-server config
     */
    public array $devServer = [
        'manifestPath' => 'http://localhost:8080/',
        'publicPath' => 'http://localhost:8080/',
    ];

    /**

Missing short description in doc comment

     * @var string defines which bundle will be used from the webpack dev server.
     *      Can be 'modern', 'legacy' or 'combined'. Defaults to 'modern'.
     */
    public string $devServerBuildType = 'modern';

    /**

Missing short description in doc comment

     * @var string Whether to include a Content Security Policy "nonce" for inline
     *      CSS or JavaScript. Valid values are 'header' or 'tag' for how the CSP
     *      should be included. c.f.:
     *      https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src#Unsafe_inline_script
     */
    public string $cspNonce = '';

    /**

Missing short description in doc comment

     * @var array Local files config
     */
    public array $localFiles = [
        'basePath' => '@webroot/',
        'criticalPrefix' => 'dist/criticalcss/',
        'criticalSuffix' => '_critical.min.css',
    ];

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

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function rules(): array
    {
        return [
            ['useDevServer', 'boolean'],
            ['useDevServer', 'default', 'value' => true],
            ['errorEntry', 'string'],
            ['devServerBuildType', 'string'],
            ['cspNonce', 'string'],
            [
                [
                    'manifest',
                    'server',
                    'devServer',
                    'localFiles',
                ],
                'each',
                'rule' => ['string'],
            ],
        ];
    }
}