跳至主要内容

命令行界面 (CLI)

您可以在命令行中使用 Stylelint。例如

npx stylelint "**/*.css"

您应该在文件通配符周围包含引号。

如果您使用的是 npm 脚本，则需要转义引号

{
  "scripts": {
    "lint": "stylelint \"**/*.css\""
  }
}

使用 npx stylelint --help 打印 CLI 文档。

选项​

CLI 接受

--allow-empty-input, --aei​

当通配符模式不匹配任何文件时，进程退出而不抛出错误。 更多信息.

--cache-location​

缓存位置的文件或目录的路径。 更多信息.

--cache-strategy​

缓存用于检测更改文件的策略。可以是“metadata”或“content”。 更多信息.

--cache​

存储已处理文件的結果，以便 Stylelint 仅对已更改的文件进行操作。默认情况下，缓存存储在 ./.stylelintcache 中，位于 process.cwd() 中。 更多信息.

--color, --no-color​

强制启用/禁用颜色。

--config-basedir​

定义“extends”、“plugins”和“customSyntax”的相对路径所相对于的目录的绝对路径。仅当这些值是相对路径时才需要。 更多信息.

--config, -c​

包含您的 配置对象 的 JSON、YAML 或 JS 文件的路径。 更多信息.

--custom-syntax​

指定要在代码中使用的自定义语法。 更多信息.

--disable-default-ignores, --di​

禁用默认忽略。Stylelint 不会自动忽略 node_modules 的内容。 更多信息.

--fix​

尽可能自动修复规则报告的问题。 更多信息.

--formatter, -f | --custom-formatter​

指定格式化程序来格式化您的结果。 更多信息.

--globbyOptions, --go​

传递给 globby 的 JSON 格式的选项。 更多信息.

--ignore-disables, --id​

忽略 stylelint-disable（例如 /* stylelint-disable block-no-empty */）注释。 更多信息.

--ignore-path, -i​

包含描述要忽略的文件的模式的文件的路径。该路径可以是绝对路径或相对于 process.cwd() 的路径。您可以重复该选项以提供多个路径。默认情况下，Stylelint 在 process.cwd() 中查找 .stylelintignore。 更多信息.

--ignore-pattern, --ip​

要忽略的文件的模式（除了 .stylelintignore 中的文件）。

--max-warnings, --mw​

设置可接受警告数量的限制。 更多信息.

--output-file, -o​

要写入报告的文件的路径。Stylelint 将报告输出到指定 filename，除了标准输出。

--print-config​

打印给定输入路径的配置。不支持通配符。

--quiet, -q​

仅为具有“error”级别严重性的规则注册问题（忽略“warning”级别）。 更多信息.

--quiet-deprecation-warnings​

忽略弃用警告。 更多信息.

--report-descriptionless-disables, --rdd​

生成没有描述的 stylelint-disable 注释的报告。 更多信息.

--report-invalid-scope-disables, --risd​

生成对在配置对象中不存在的规则使用的 stylelint-disable 注释的报告。 更多信息.

--report-needless-disables, --rd​

生成报告以清理您的代码库，仅保留有用的 stylelint-disable 注释。 更多信息.

--stdin-filename​

要分配给输入的文件名。 更多信息.

--stdin​

即使输入为空，也接受 stdin 输入。

--version, -v​

显示当前安装的 Stylelint 版本。

使用示例​

CLI 将输入视为 文件通配符 或 process.stdin。它将格式化的结果输出到 process.stdout。

您应该在文件通配符周围包含引号。

示例 A - 递归​

递归地 lint foo 目录中的所有 .css 文件

stylelint "foo/**/*.css"

示例 B - 多个文件扩展名​

lint 所有 .css、.scss 和 .sass 文件

stylelint "**/*.{css,scss,sass}"

示例 C - stdin​

lint stdin

echo "a { color: pink; }" | stylelint

示例 D - 否定​

lint 所有 .css 文件，除了 docker 子文件夹中的文件，在输入通配符中使用否定

stylelint "**/*.css" "!**/docker/**"

示例 E - 缓存​

缓存已处理的 foo 目录中的 .scss 文件

stylelint "foo/**/*.scss" --cache --cache-location "/Users/user/.stylelintcache/"

示例 F - 写入报告​

lint foo 目录中的所有 .css 文件，然后将输出写入 myTestReport.txt

stylelint "foo/*.css" --output-file myTestReport.txt

示例 G - 指定配置​

使用 bar/mySpecialConfig.json 作为配置来 lint foo 目录及其任何子目录中的所有 .css 文件

stylelint "foo/**/*.css" --config bar/mySpecialConfig.json

示例 H - 使用自定义语法​

使用自定义语法递归地 lint foo 目录中的所有 .css 文件

stylelint "foo/**/*.css" --custom-syntax path/to/my-custom-syntax.js

示例 I - 成功时打印​

确保在成功运行时输出

stylelint -f verbose "foo/**/*.css"

示例 J - 打印配置​

打印用于给定输入文件的配置

stylelint test.css --print-config

示例 K - 将报告管道到另一个命令​

通过管道将报告用作另一个命令的输入

stylelint -f json "*.css" 2>&1 | jq '[.[] | .warnings | length] | add'

退出代码​

CLI 可以使用以下退出代码退出进程

  • 1 - 致命错误
  • 2 - lint 问题
  • 64 - 无效的 CLI 使用
  • 78 - 无效的配置文件