space48/grumphp-stylelint-task

一个GrumPHP扩展,通过stylelint添加CSS代码风格检查支持。

1.0.1 2021-11-11 16:22 UTC

This package is auto-updated.

Last update: 2024-09-11 22:34:07 UTC


README

GrumPHP添加stylelint代码风格检查任务。

安装

通过composer安装

composer require --dev space48/grumphp-stylelint-task

配置

示例配置

# grumphp.yml
grumphp:
  tasks:
    stylelint:
      bin: "node_modules/.bin/stylelint"
      triggered_by: ["css", "scss"]
      allowed_paths: 
        - /^resources\/css/
      ignore_paths: 
        - /^ignored-folder\/css/
      max_warnings: 3
  extensions:
    - Space48\GrumPHPStylelintTask\Extension

可用选项

bin

默认: null

默认情况下,任务将使用您$PATH中的stylelint。使用此选项可以覆盖它。您可以将stylelint可执行文件的路径指定为字符串,或将执行stylelint的命令指定为数组,例如,通过npx运行stylelint: bin: ["npx", "stylelint"]

triggered_by

默认: ["css", "less", "scss", "sass", "pcss"]

定义将触发stylelint任务的文件扩展名列表。

allowed_paths

默认: []

此选项允许您指定要过滤将由任务检查的文件的正则表达式模式列表。

config

默认: null

指定stylelint的替代配置文件。如果未指定,则让stylelint决定使用哪个配置文件(stylelint.io)。

disable_default_ignores

默认: false

防止stylelint自动忽略某些目录中的文件,例如node_modulesstylelint.io)。

format

默认: null

指定输出格式。如果未指定,将使用stylelint的默认输出格式。您可以在stylelint.io上找到有效选项的列表。

max_warnings

默认: null

指定在检查器退出并显示错误之前允许的最大警告数(stylelint.io)。

quiet

默认: false

仅输出错误,不输出警告(stylelint.io)。

更新日志

CHANGELOG.md

许可证

此项目受MIT许可证许可。