lint
一個以代理為優先的 Tailwind 設計系統檢查工具。撰寫代理可驗證的設計系統規則。
lint 是什麼?
一個以代理為優先的 Tailwind 設計系統檢查工具。撰寫代理可驗證的設計系統規則。
lint 概覽
這是什麼
@shadcn/lint 是一個以代理程式為優先的 linter,專為 Tailwind 設計系統打造。你可以撰寫設計系統規則,讓程式碼代理程式能夠驗證。此工具支援 Tailwind v4 專案,不強制要求使用 shadcn/ui。它同時適用於 ESLint 和 Oxlint,並支援 React、Svelte 和 Vue。
主要功能
- 定義設計系統中允許的規則;當代理程式違反規則時,錯誤訊息會說明問題並根據元件、變體和主題提供修正建議。
- 可與現有設計系統搭配使用,無需重寫。
- 可程式化:支援自訂錯誤訊息,並可使用佔位符(例如 {{sizes}}、{{component}}、{{file}})從專案的元件和主題中提取資訊。
- 合約功能允許為每個元件設定不同規則,例如讓不同元件部分有不同的允許範圍(如佈局、排版、間距)。
- 包含
shadcn/no-restyle和shadcn/no-arbitrary-values等規則。 - 專為代理程式設計:錯誤訊息會告訴代理程式哪裡出錯、該改用什麼,以及到哪裡尋找。
- 經過超過 150 次任務測試;在每次模型的一次執行中,錯誤在 lint 回饋後降至零。
- 在 Claude 控制執行中,使用 lint 回饋修正違規的成本比僅使用規則低 10% 至 48%。
使用情境
- 在 UI 開發中強制執行設計系統規則,特別是當程式碼代理程式產生程式碼時。
- 讓代理程式撰寫 UI 的同時確保其不違反設計限制(例如間距、排版、顏色)。
- 在多個專案間共享 lint 規則,同時允許每個專案定義自己的合約。
- 對第三方套件的元件套用規則,無需 fork 或包裝。
快速開始
需要 Node.js 20.19 或更新版本(或 Bun 1.3 或更新版本),以及你的 linter 支援的版本。 React 搭配 ESLint(需要 ESLint 9.30 或更新版本): bash npm install -D @shadcn/lint eslint @typescript-eslint/parser 建立 eslint.config.mjs: js import { plugin as shadcn } from '@shadcn/lint' import tsParser from '@typescript-eslint/parser' import { defineConfig } from 'eslint/config' export default defineConfig([ { files: ['**/*.{js,jsx,ts,tsx}'], languageOptions: { parser: tsParser, parserOptions: { ecmaFeatures: { jsx: true } }, }, plugins: { shadcn }, rules: { 'shadcn/no-arbitrary-values': 'error', }, }, ]) bash npx eslint . React 搭配 Oxlint(需要 Oxlint 1.80 或更新版本): bash npm install -D @shadcn/lint oxlint 完整設定請參閱儲存庫的 README。
授權與價格
本專案採用 MIT 授權條款,為開放原始碼。價格資訊未另行說明。
內容整理自該專案公開的 README 與儲存庫資訊。