我们一直遇到 Javascript 开发人员在编辑器上使用不同代码格式的问题。一些开发人员使用 VSCode、Sublime 或 PHPStorm。当开发人员创建 PR (Github) 时,我们的代码格式不一致。
有没有一种方法可以让开发人员运行一个命令(npm 格式)来自动格式化代码。CI也会做代码格式检查吗?
我们一直遇到 Javascript 开发人员在编辑器上使用不同代码格式的问题。一些开发人员使用 VSCode、Sublime 或 PHPStorm。当开发人员创建 PR (Github) 时,我们的代码格式不一致。
有没有一种方法可以让开发人员运行一个命令(npm 格式)来自动格式化代码。CI也会做代码格式检查吗?
如果您只是在寻找代码格式化程序,Prettier是一个不错的选择。使用 Prettier,您可以进行集中配置(例如,4 个间隔制表符、双引号等),并且运行单个命令将清理您的文件。
您可以使用Husky扩展它,这是我使用 git hooks 的首选。然后,你可以设置一个 pre-commit 钩子,它会在提交任何新代码之前使用 Prettier 自动清理你的文件。
package.json
添加 Prettier 和 Husky 作为后,您可以添加以下内容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
你可以试试Nx,它可以为你处理 Prettier、TSLint 和许多其他东西。然后您可以运行nx format:check
(它也可以通过运行轻松嵌入到管道中npm run format:check
)来检查您的格式。nx format:write
/npm run format:write
将为您编写规则。与 VSCode 选项编辑器结合使用非常好:打开保存时格式化,强烈推荐。