在线文档教程

The CLI

The stylelint CLI

安装

stylelint 是一个 npm 包。使用以下命令进行安装:

npm install -g stylelint

用法

stylelint --help 打印命令行的文档。

命令行将格式化后的结果输出到 process.stdout,你可以自行阅读或输出到其他地方(如,将信息写到一个文件)

例子

查找 .stylelintrc,检测 foo 目录下的所有的 .css 文件:

stylelint "foo/*.css"

查找 .stylelintrc,检测 stdin

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

使用 bar/mySpecialConfig.json 配置,检测 foo 目录下的所有的 .css 文件,然后写入到 myTestReport.txt

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

使用 bar/mySpecialConfig.json 配置,启用安静模式,检测 foo 目录及其子目录下的所有的 .css 文件,bar directory下的 .css 文件,然后以 JSON 格式输出到 myJsonReport.json

stylelint "foo/**/*.css bar/*.css" -q -f json --config bar/mySpecialConfig.json > myJsonReport.json

使用 syntax 选项,检测 foo 目录下的所有 .scss 文件:

stylelint "foo/**/*.scss" --syntax scss

除了 --syntax scss,默认情况下,stylelint 也支持 --syntax less--syntax sugarss。如果你使用了其中的一个,你可以不提供 --syntax 选项:非标准的远方可以根据 .less.scss.sss的扩展名推断出来是哪种语法。

此外,stylelint 可以接受一个自定义的 PostCSS 兼容语法。为了使用自定 语法,需要提供一个语法的模块名或语法文件的路径:--custom-syntax custom-syntax--custom-syntax ./path/to/custom-syntax

但是请注意,stylelint 对核心规则与非默认的语法是否可以正常工作不提供任何保证。

语法错误

命令行会通知你 CSS 文件中的语法错误。它使用同检测警告同样的格式。错误名称是 CssSyntaxError

退出代码

命令行退出进程使用以下退出码:

  • 1: Something unknown went wrong.