跳至主要內容

命令列介面 (CLI)

您可以在命令列上使用 Stylelint。例如

npx stylelint "**/*.css"

您應該在檔案 glob 周圍加上引號。

如果您使用 npm 腳本，您需要跳脫引號

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

使用 npx stylelint --help 來列印 CLI 文件。

選項​

CLI 接受

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

當 glob 模式與任何檔案不符時，程序會在不擲回錯誤的情況下結束。 更多資訊。

--cache-location​

快取位置的檔案或目錄路徑。 更多資訊。

--cache-strategy​

快取用來偵測已變更檔案的策略。可以是「metadata」或「content」。更多資訊。

--cache​

儲存已處理檔案的結果，讓 Stylelint 只會針對已變更的檔案進行操作。預設情況下，快取會儲存在 process.cwd() 中的 ./.stylelintcache。 更多資訊。

--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​

列印給定輸入路徑的設定檔。不支援 Glob。

--quiet, -q​

僅註冊具有「錯誤」層級嚴重性的規則問題（忽略「警告」層級）。 更多資訊。

--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 輸入為空，也接受 stdin 輸入。

--version, -v​

顯示目前安裝的 Stylelint 版本。

使用範例​

CLI 預期輸入為 檔案 glob 或 process.stdin。它會將格式化的結果輸出至 process.stdout。

您應該在檔案 glob 周圍加上引號。

範例 A - 遞迴​

遞迴檢查 foo 目錄中所有 .css 檔案的 linting。

stylelint "foo/**/*.css"

範例 B - 多個檔案副檔名​

檢查所有 .css、.scss 和 .sass 檔案的 linting。

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

範例 C - stdin​

檢查 stdin 的 linting。

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

範例 D - 否定​

在輸入 glob 中使用否定，檢查所有 .css 檔案的 linting，但排除 docker 子資料夾中的檔案。

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

範例 E - 快取​

快取已處理的 .scss 檔案 foo 目錄。

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

範例 F - 編寫報告​

檢查 foo 目錄中所有 .css 檔案的 linting，然後將輸出寫入 myTestReport.txt。

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

範例 G - 指定設定檔​

使用 bar/mySpecialConfig.json 作為設定檔，檢查 foo 目錄及其所有子目錄中所有 .css 檔案的 linting。

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

範例 H - 使用自訂語法​

使用自訂語法遞迴檢查 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 - 程式碼檢查問題
  • 64 - CLI 使用方式無效
  • 78 - 設定檔無效