保持開發者之間的JS格式代碼一致？

Question

我們一直遇到 JavaScript 開發人員在編輯器上使用不同代碼格式的問題。 一些開發人員使用 VSCode、Sublime 或 PHPStorm。 當開發人員創建 PR (Github) 時，我們會遇到不一致的代碼格式。

有沒有一種方法可以讓開發人員運行一個命令（npm 格式）來自動格式化代碼。 還有 CI 會做代碼格式檢查嗎？

Answer 1

如果您只是在尋找代碼格式化程序， Prettier是一個不錯的選擇。 使用 Prettier，您可以擁有一個中央配置（例如，4 個間隔的制表符、雙引號等），並且運行單個命令將清理您的文件。

您可以使用Husky擴展它，這是我對 git hooks 的首選。 然后，您可以設置一個預提交掛鈎，它會在提交任何新代碼之前使用 Prettier 自動清理您的文件。

在將devDependencies和 Husky 添加為devDependencies后，您可以將以下內容添加到package.json ：

{
  "scripts": {
    "prettier-format": "prettier --write 'src/**/*.js'"
  },
  "husky": {
    "hooks": {
      "pre-commit": "npm run prettier-format"
    }
  }
}

您還可以使用 Onchange，它可以配置為在保存任何文件更改后運行 Prettier： https ://prettier.io/docs/en/watching-files.html

Answer 2

你可以試試Nx ，它為你處理 Prettier、TSLint 和許多其他的東西。 然后你可以運行nx format:check （它也可以通過運行npm run format:check輕松嵌入到管道中）來檢查你的格式。 nx format:write / npm run format:write將為您編寫規則。 工程在VSCode選項編輯器組合確實不錯：在保存格式打開，高度推薦。