project-nos/spryker-twig-code-sniffer

This package aims to be for twig templates in spryker what phpcs is to php. It checks your codebase for violations on coding standards.

v1.1.1 2024-02-12 17:06 UTC

Requires

• php: >=8.1
• spryker/kernel: ^3.52.0
• vincentlanglet/twig-cs-fixer: 2.0.*

Requires (Dev)

• phpstan/phpstan: ^1.10
• spryker/code-sniffer: *
• spryker/testify: *

MIT

• Andreas Penz

• twig
• static analysis
• standards
• spryker

README

This package aims to be for twig templates in spryker what phpcs is to php. It checks your codebase for violations on coding standards.

Installation

composer require --dev project-nos/spryker-twig-code-sniffer

Setup

To use the provided console commands you will need to register the namespace Nos in config/Shared/config_default.php.

$config[KernelConstants::CORE_NAMESPACES] = [
    // add 'Nos' as a core namespace
    'Nos',
];

In src/Pyz/Yves/Console/ConsoleDependencyProvider.php you need to register the console command plugin for deploy tasks.

use Nos\Yves\TwigCodeSniffer\Plugin\Console\TwigCodeSnifferConsole;

    protected function getConsoleCommands(Container $container): array
    {
        $commands = [
            // other registered console plugins ...
            new TwigCodeSnifferConsole(),
        ];

Then you should see a new command in the code section:

code
   ...
   code:sniff:twig  Sniff and fix twig code style
   ...

Definition

Description:
  Sniff and fix twig code style

Usage:
  code:sniff:twig [options] [--] [<paths>...]

Arguments:
  paths                 Paths of files and folders to parse

Options:
      --level=LEVEL     Allowed values are notice, warning or error [default: "NOTICE"]
      --report=REPORT   Report format [default: "text"]
      --fix             Automatically fix all the fixable violations
      --no-cache        Disable cache while running the fixer

Coding Standard

This package attempts to mimic the official coding standard with the following exceptions:

• One (and only one) space before and after the | (pipe) operator.

License

Copyright (c) Andreas Penz. Licensed under the MIT License.