我们一直有问题Javascript开发人员在编辑器上使用不同的代码格式。一些开发人员使用VSCode,Sublime或PHPStorm。当开发人员创建PR(Github)时,我们会得到不一致的代码格式。
有没有办法开发人员可以运行命令(npm格式),它将自动格式化代码。 CI还会做代码格式检查吗?
如果您只是在寻找代码格式化程序,Prettier是一个很好的选择。使用Prettier,您可以拥有一个中央配置(例如,4个间隔选项卡,双引号等),运行单个命令将清理您的文件。
您可以使用Husky扩展它,这是git hooks的首选。然后,您可以设置一个预提交钩子,它将在提交任何新代码之前使用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