madikon/grumphp-typoscript-lint

A typoscript linter task for grumphp

1.2.0 2023-08-07 10:27 UTC

Requires

• helmich/typo3-typoscript-lint: ^3.1
• phpro/grumphp: ^2

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.16
• phpstan/phpstan: ^1

MIT

README

Grumphp Typoscript Lint

A TypoScript lint task for GrumPHP. Based on the TypoScript Linter of Martin Helmich martin-helmich/typo3-typoscript-lint

Installation

Install composer package

composer require --dev madikon/grumphp-typoscript-lint

Add the extension loader to your grumphp.yml

grumphp:
  extensions:
    - Madikon\GrumphpTypoScriptLint\Extension\Loader

Usage

Default configuration for grumphp

grumphp:
  tasks:
    typoscriptlint:
      config: "path/to/your/typoscriptlint-config.yaml"
      paths:
        - "path/to/include"
      exclude:
        - "path/or/file/to/exclude"
      triggered_by:
        - typoscript
        - tsconfig
      format: "compact"
      fail-on-warnings: true
      output: "-"

Results in the folowing command line call

vendor/bin/typoscript-lint --config=path/to/your/typoscriptlint-config.yaml --format=compact --output=- --fail-on-warnings file1.typoscript file2.typoscript

Linter Configuration

For more detailed documentation and configuration please refer to https://github.com/martin-helmich/typo3-typoscript-lint#configuration