DEV Community
·
开源开发 - 实验室 - 6 - 代码格式化工具
内容提要
在Hacktoberfest结束后，我们回到第一个开源项目，添加了prettier进行代码格式化和eslint进行代码检查，以确保代码风格一致。同时，我创建了contributing.md文件以简化文档。通过npm设置prettier和eslint，实现了代码格式化和检查的自动化，提高了开发效率。
关键要点
-
Hacktoberfest结束后，回到第一个开源项目，添加了代码格式化工具prettier和代码检查工具eslint。
-
代码格式化工具在开源项目中非常必要，以确保代码风格一致。
-
选择prettier进行代码格式化和eslint进行代码检查，基于之前的使用经验。
-
创建了contributing.md文件，以简化文档并提供开发者使用说明。
-
通过npm设置prettier，添加了.prettierrc文件，包含项目应遵循的编码规范。
-
运行prettier脚本后，代码库的90%发生了变化，Scrappy在更改后正常工作。
-
通过npm设置eslint，运行npx eslint --init生成config.js文件，完成代码检查配置。
-
在VS Code中添加了.vscode/settings.json文件，以便每次保存文件时自动运行prettier。
-
设置这些工具的过程是一个很好的复习，展示了配置对项目的重大影响。
延伸问答
为什么在开源项目中使用代码格式化工具很重要？
代码格式化工具可以确保代码风格一致，避免不同开发者使用不同的编码风格，从而提高代码的可读性和维护性。
选择prettier和eslint的原因是什么？
选择prettier和eslint是因为之前有使用经验，能够更好地实施和配置这些工具。
如何在项目中设置prettier和eslint？
通过npm安装prettier和eslint，分别创建.prettierrc和config.js文件进行配置，并在npm脚本中添加运行命令。
运行prettier后代码库发生了什么变化？
运行prettier后，代码库的90%发生了变化，确保了代码符合设定的格式规范。
contributing.md文件的作用是什么？
contributing.md文件提供了开发者如何参与项目的具体说明，简化了文档内容。
如何在VS Code中自动运行prettier？
在VS Code中添加.vscode/settings.json文件，配置为每次保存文件时自动运行prettier。
