有人会问:既然项目已经使用了 eslint 和 prettier,为什么还需要 EditorConfig?
为什么需要 EditorConfig?
.editorconfig 是一个用于定义和维护跨不同编辑器和开发环境的一致编码样式的文件。它可以确保整个团队在使用不同编辑器时遵循相同的编码规范,以提高代码的一致性和可读性。
尽管 ESLint 和 Prettier 可以处理一些代码风格问题和格式化要求,但它们的主要目的是不同的:
- ESLint 是一个强大的静态代码分析工具,用于检查代码中的潜在问题和错误,以及强制执行代码规范和最佳实践。
- Prettier 是一个代码格式化工具,用于自动调整代码的格式,以确保代码具有一致的样式,并减少团队成员之间的格式争议。
.editorconfig 文件可以与 ESLint 和 Prettier 协同工作,以进一步提高代码质量和一致性。例如,你可以使用 .editorconfig 文件来定义一些编辑器相关的设置,如缩进风格、换行符类型和字符编码等,以确保整个团队在不同的编辑器中都使用相同的设置。
如何配置 EditorConfig?
在项目根目录下新建一个 .editorconfig 文件,配置如下(cv到项目中的时候注释可以删掉):
# // 当打开一个文件时,EditorConfig插件会在打开文件的目录和每个父目录中寻找一个名为.editorconfig的文件。
# // 如果达到根文件路径或找到一个root=true的EditorConfig文件,对.editorconfig文件的搜索将停止。
root = true[*]
charset = utf-8 // 字符集
indent_style = space // 设置为tab或space
indent_size = 2 // 缩进级别的列数# insert_final_newline = true // 以换行符结尾
# trim_trailing_whitespace = true // 删除文件中换行符之前的所有空白字符# [*.ts]
# quote_type = single // ts文件中为单引方式# [*.md]
# max_line_length = off // 关掉最大行宽
# trim_trailing_whitespace = false // 不删除文件中换行符之前的所有空白字符