設定開發環境

ESLint 有一個非常輕巧的開發環境，讓程式碼更新快速又容易。這是一步一步的指南，用於設定本機開發環境，讓您能回饋貢獻給專案。

步驟 1：安裝 Node.js

前往 https://node.dev.org.tw/ 下載並安裝適用於您作業系統的最新穩定版本。

大多數安裝程式都已包含 npm，但如果因某些原因 npm 無法在您的系統上運作，您可以按照網站上的說明手動安裝。

前往 https://github.com/eslint/eslint 並按一下「Fork」按鈕。請按照 GitHub 文件進行 fork 和複製。

複製您的 fork

git clone https://github.com/<Your GitHub Username>/eslint
1

複製儲存庫後，執行 npm install 以取得所有必要的相依性

cd eslint
npm install
1
2

您必須連線到網際網路才能執行此步驟。您會看到許多公用程式正在下載。

注意： 建議您每次從主要儲存庫提取時都重新執行 npm install，以確保您擁有最新的開發相依性。

上游來源是主要 ESLint 儲存庫，所有活躍的開發都在此進行。雖然您沒有推送至上游的權限，但您具有提取權限，可讓您隨時提取最新的程式碼。

若要新增 ESLint 的上游來源，請在您的儲存庫中執行以下指令

git remote add upstream git@github.com:eslint/eslint.git
1

現在，遠端 upstream 指向上游來源。

Yeoman 是一個 scaffold 產生器，ESLint 使用它來協助簡化新規則的開發。如果您尚未安裝 Yeoman，可以透過 npm 安裝

npm install -g yo
1

然後，您可以安裝 ESLint Yeoman 產生器

npm install -g generator-eslint
1

請參閱產生器文件，以取得如何使用它的說明。

執行測試是確保您已正確設定開發環境的最佳方式。請確保您在 eslint 目錄中，然後執行

npm test
1

測試需要幾分鐘才能完成。如果任何測試失敗，這可能表示環境設定的一個或多個部分未正確完成。上游測試一律通過。

ESLint 的目錄和檔案結構如下

bin - 安裝 ESLint 時可用的可執行檔案
conf - 預設的設定資訊
docs - 專案的文件
lib - 包含原始程式碼
- formatters - 所有定義格式化器的原始檔
- rules - 所有定義規則的原始檔
tests - 主要單元測試資料夾
- lib - 原始程式碼的測試
  - formatters - 格式化器的測試
  - rules - 規則的測試

安裝開發環境後，您可以變更並提交 ESLint 原始檔。若要成功執行此動作，需要仔細遵守我們的提取請求提交工作流程。

ESLint 有幾個建置指令碼，可協助進行開發的各個部分。

主要要使用的指令碼是 npm test，它會執行幾個動作

請務必在變更後且在傳送包含您變更的提取請求之前執行此操作。

注意： 完整的程式碼涵蓋範圍報告輸出至 /coverage。

僅對儲存庫執行 JavaScript 和 JSON 的程式碼風格檢查。

產生 build/eslint.js，一個可在瀏覽器中使用的 ESLint 版本。

編輯此頁面