madikon / grumphp-typoscript-lint

为 grumphp 的 TypoScript 检查器任务

1.2.0 2023-08-07 10:27 UTC

This package is auto-updated.

Last update: 2024-09-17 12:08:12 UTC


README

Test

Grumphp Typoscript Lint

GrumPHP 提供的 TypoScript 检查器任务。基于 Martin Helmich 的 TypoScript Linter martin-helmich/typo3-typoscript-lint

安装

安装 composer 包

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

将扩展加载器添加到您的 grumphp.yml

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

使用

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: "-"

以下命令行调用将产生结果

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

检查器配置

有关更详细的文档和配置,请参阅 https://github.com/martin-helmich/typo3-typoscript-lint#configuration