版本

擴充 ESLint 的方式

ESLint 具有高度可插拔性和可設定性。您可以使用多種方式來擴充 ESLint 的功能。

此頁面說明擴充 ESLint 的方式,以及這些擴充功能如何組合在一起。

外掛程式

外掛程式讓您可以將自己的 ESLint 自訂規則和自訂處理器新增到專案中。您可以將外掛程式發布為 npm 模組。

外掛程式很有用,因為您的專案可能需要某些未包含在核心 eslint 套件中的 ESLint 設定。例如,如果您使用的是前端 JavaScript 函式庫(如 React)或框架(如 Vue),這些工具的某些功能需要 ESLint 核心規則範圍之外的自訂規則。

通常,外掛程式會與 ESLint 的設定配對,該設定會將外掛程式中的一組功能應用於專案。您也可以在外掛程式中包含設定。

例如,eslint-plugin-react 是一個 ESLint 外掛程式,其中包含專門針對 React 專案的規則。這些規則包括強制執行 React 元件生命週期方法的一致用法,以及在渲染動態列表時要求使用 key 屬性。

若要深入瞭解如何建立您可以包含在外掛程式中的擴充功能,請參閱以下文件

若要深入瞭解如何將這些擴充功能捆綁到外掛程式中,請參閱外掛程式

可分享設定

ESLint 可分享設定是 ESLint 的預先定義設定,您可以在專案中使用。它們將規則和其他設定捆綁在一個 npm 套件中。您可以放在設定檔中的任何內容都可以放在可分享設定中。

您可以獨立發布可分享設定,也可以作為外掛程式的一部分發布。

例如,一個流行的可分享設定是 eslint-config-airbnb,其中包含各種規則以及一些解析器選項。這是 ESLint 的一組規則,旨在符合 Airbnb JavaScript 風格指南 使用的風格指南。透過使用 eslint-config-airbnb 可分享設定,您可以自動在專案中強制執行 Airbnb 風格指南,而無需手動設定每個規則。

若要深入瞭解如何建立可分享設定,請參閱分享設定

自訂格式器

自訂格式器會取得 ESLint 檢查結果,並以您定義的格式輸出結果。自訂格式器可讓您以最符合您需求的格式顯示檢查結果,無論是特定的檔案格式、特定的顯示樣式,還是針對特定工具最佳化的格式。只有在內建格式器無法滿足您的使用案例時,才需要建立自訂格式器。

例如,自訂格式器 eslint-formatter-gitlab 可用於在 GitLab 程式碼品質報告中顯示 ESLint 結果。

若要深入瞭解如何建立自訂格式器,請參閱自訂格式器

自訂解析器

ESLint 自訂解析器是一種擴充 ESLint 的方式,以支援檢查程式碼中新的語言功能或自訂語法。解析器的職責是取得您的程式碼並將其轉換為抽象語法樹 (AST),然後 ESLint 可以分析和檢查。

ESLint 隨附內建的 JavaScript 解析器 (Espree),但自訂解析器可讓您檢查其他語言或擴充內建解析器的檢查功能。

例如,自訂解析器 @typescript-eslint/parser 擴充了 ESLint 以檢查 TypeScript 程式碼。

自訂解析器也可以包含在外掛程式中。

若要深入瞭解如何建立自訂解析器,請參閱自訂解析器

變更語言