本周，我擴展了對軟件開發(fā)中代碼格式化重要性的了解。正如我們依靠具有拼寫檢查功能的文字處理軟件來識別和糾正拼寫錯誤一樣，開發(fā)人員應該利用提供格式化和 linting 功能的代碼編輯器來維護代碼質量。

為什么使用靜態(tài)分析工具

為了提高代碼質量并減少開發(fā)時間，程序員使用靜態(tài)分析工具至關重要。當與多個貢獻者合作項目時，遵守編碼標準變得至關重要，因為它可以讓其他人更輕松地閱讀和理解代碼。這種必要性導致了針對不同編程語言定制的各種工具的出現(xiàn)。對于本周的項目，我選擇為我的 JavaScript 代碼庫實現(xiàn) Prettier。除了格式化工具之外，linter 也是必不可少的。 linter 可幫助開發(fā)人員識別被忽視的錯誤，這些錯誤可能不會影響程序的執(zhí)行，但如果不加以檢查，可能會導致代碼中出現(xiàn)重大問題。為此，我選擇了 ESLint。

更漂亮

為了使用 Prettier，我使用以下命令將其本地安裝在我的項目中：

npm install --save-dev --save-exact prettier

接下來，我創(chuàng)建了兩個配置文件：.prettierrc 和 .prettierignore：

• .prettierrc：此配置文件包含格式化規(guī)則。

我將其保留為空對象，因為我想使用默認的 Prettier 設置而不覆蓋任何規(guī)則。

• .prettierignore：此文件列出了 Prettier 不應格式化的文件或目錄。

我包含了所有我不希望 Prettier 接近的文件和文件夾。其中大部分是配置文件和自行生成的文件。

注釋：

• 這兩個文件都必須放在項目的根目錄下。
• 安裝后，我可以通過運行來測試 Prettier 的功能：

npx 更漂亮。 --寫

• 為了更輕松地運行該命令，我制作了一個將在命令行中運行的腳本。在 package.json 文件中，我添加了一個名為 format 的新腳本。

要使用它，您只需輸入以下命令：

npm 運行格式

除了本地安裝和命令行使用之外，Prettier 還可以通過擴展集成到代碼編輯器（例如 VSCode）中。安裝后，它會在保存文件時自動格式化代碼。

短絨

ESLint 是一款旨在識別和報告 ECMAScript/JavaScript 代碼中的模式的工具，旨在增強代碼一致性并最大限度地減少錯誤。您可以使用以下命令安裝和配置 ESLint：

npm init @eslint/config@latest

執(zhí)行此命令后，一系列問題將引導您完成終端中的設置，并將創(chuàng)建一個名為 .eslint.config.mjs 的新配置文件。由于我使用的是 ESLint 版本 9.x，因此所有配置都將在此文件中指定。我還列出了 ESLint 不需要的文件和文件夾，以便使用忽略屬性來忽略。

為了簡化 linting 過程，我在 package.json 中添加了一個腳本以便于執(zhí)行。

要運行腳本，只需鍵入以下命令：

npm run lint

編輯器集成

雖然上述設置足以滿足單個項目的需求，但確保所有貢獻者擁有統(tǒng)一的開發(fā)環(huán)境在協(xié)作環(huán)境中至關重要。因此，我在根目錄中創(chuàng)建了一個 .vscode 文件夾，其中包含兩個文件：

• extensions.json：該文件列出了開發(fā)者在打開項目時應安裝的必要擴展，并在項目啟動時提供提示。

• settings.json：此配置可確保：

  • 編輯器使用 Prettier 在保存時格式化代碼。
  • ESLint 自動修復保存時的 linting 問題。
  • ESLint 驗證 JavaScript 文件。
  • Prettier 需要一個配置文件來格式化代碼。

通過使用settings.json和extensions.json建立.vscode文件夾，我確保所有貢獻者共享一致的開發(fā)環(huán)境，并將Prettier和ESLint無縫集成到Visual Studio Code中。此設置有助于根據(jù)項目的配置自動進行代碼格式化和 linting，從而簡化代碼質量和一致性的維護。

解決格式問題

• 運行 Prettier 后，我發(fā)現(xiàn)了一些需要手動調整的文件，主要是向對象的最后一個元素添加逗號。

• 在 ESLint 運行之后，我發(fā)現(xiàn)了 13 個問題，其中大部分是由于使用了不需要初始化的全局對象進程造成的。為了解決這個問題，我在受影響的文件頂部添加了以下注釋：

/* eslint-disable no-undef */

此外，還有一些導入的值沒有被使用；對于這些情況，我只是將它們刪除。

結論

通過對靜態(tài)分析工具的探索，我對它們的重要性有了更深入的了解，特別是在協(xié)作項目中。這些工具的主要目標是促進團隊合作并保持高代碼質量，我現(xiàn)在了解如何有效地建立一個項目來從一開始就集成這些基本工具。

以上是超越拼寫檢查：靜態(tài)分析工具如何增強編碼協(xié)作的詳細內容。更多信息請關注PHP中文網(wǎng)其他相關文章！