使开发人员之间的JS格式代码保持一致?

时间:2019-03-31 16:13:28

标签: javascript node.js code-formatting prettier js-beautify

我们一直遇到Javascript开发人员在编辑器上使用不同代码格式的问题。一些开发人员使用VSCode,Sublime或PHPStorm。开发人员创建PR(Github)时,我们得到的代码格式不一致。

开发人员是否可以运行一种命令(npm格式)来自动格式化代码。 CI也将进行代码格式检查吗?

2 个答案:

答案 0 :(得分:1)

如果您只是在寻找代码格式化程序,Prettier是一个不错的选择。使用Prettier,您可以进行集中配置(例如4个空格的制表符,双引号等),然后运行一个命令即可清除文件。

您可以使用Husky扩展它,这是我对git hook的首选。然后,您可以设置一个预提交钩子,该钩子将在提交任何新代码之前使用Prettier自动清除文件。

在将Prettier和Husky添加为package.json之后,您可以将以下内容添加到devDependencies中:

{
  "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

答案 1 :(得分:0)

您可以尝试Nx,它可以为您处理漂亮,TSLint和许多其他内容。然后,您可以运行nx format:check(也可以通过运行npm run format:check将其轻松地嵌入到管道中)以检查格式。 nx format:write / npm run format:write将为您编写规则。强烈建议将VSCode选项与编辑器:“保存时格式化” 组合为打开,效果很好。