README

grumphp-typoscript-task

GrumPHP task to lint TYPO3 CMS TypoScript files.

This package adds a TYPO3 CMS TypoScript file linter task to grumphp based on martin-helmich/typo3-typoscript-lint of Martin Helmich.

Quick guide

grumphp.yml

Basic inclusion in grumphp.yml:

parameters:
    tasks:
        typoscriptlint: ~ 
    extensions:
        - Pluswerk\TypoScriptLinter\ExtensionLoader

Composer

composer require --dev pluswerk/grumphp-typoscript-task

Configuration

typoscript linter

The linter can be configured in the grumphp.yml file in the same way as without grumphp see TypoScript Linter configuration

Example:

parameters:
  tasks:
    typoscriptlint:
      sniffs:
        - class: Indentation
          parameters:
            useSpaces: true
            indentPerLevel: 2
            indentConditions: true
        - class: DeadCode
  extensions:
    - Pluswerk\TypoScriptLinter\ExtensionLoader

triggered_by

The file extensions, which trigger the linter.

parameters:
  tasks:
    typoscriptlint:
      triggered_by:
        - 'typoscript'

ignore_patterns

Ignore file with grumphp ignore patterns.

parameters:
  tasks:
    typoscriptlint:
      ignore_patterns:
        - 'pattern'