Editorconfig：如何自动修复项目中的所有文件[关闭]

Posted 2023-02-22

【中文标题】Editorconfig：如何自动修复项目中的所有文件[关闭]

【英文标题】：Editorconfig: How to autofix all files in a project [closed]

【发布时间】：2017-01-13 13:24:26

【问题描述】：

鉴于我有一个 .editorconfig 文件，该文件规定了一致的缩进、行尾、尾随空格等。

# http://editorconfig.org
root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

作为一名开发人员，我想使用能够理解 .editorconfig 文件的命令行工具一致地修复所有文件。我想避免繁琐的任务，例如手动打开和更改文件。

我想如果有一个命令，例如：

editorconfix.sh --autofix .

有哪些工具可用于此目的？你用什么脚本？

【问题讨论】：

prettier 项目中有一个未解决的问题要尊重 .editorconfig:github.com/jlongster/prettier/issues/42

【参考方案1】：

此外，如果您使用 Gradle、Maven 或 Ant，还有一些工具：

分级：https://plugins.gradle.org/plugin/org.ec4j.editorconfig

检查文件

./gradlew editorconfigCheck

尝试自动修复它们

./gradlew editorconfigFormat

Maven：https://mvnrepository.com/artifact/org.ec4j.maven/editorconfig-maven-plugin - https://github.com/ec4j/editorconfig-maven-plugin

蚂蚁：https://github.com/ec4j/editorconfig-ant-tasks

【参考方案2】：

有eclint（还有一个叫editorconfig-tools的分叉）。运行

eclint check 'src/**/*'

检查src目录中的所有文件，或者

eclint fix 'src/**/*'

修复它们。但请注意，该工具在缩进时会产生一些惊喜！该工具的作者says in a GitHub comment 表示他自己已停止使用该工具，转而支持特定语言的 linter：

对我来说，EditorConfig 就是——你相信吗——配置你的编辑器，仅此而已。我认为它不应该负责 linting 或修复，因为有特定于语言的工具可以实现这些目标（例如，用于 javascript 的 ESLint）。您可以可靠地 lint 或修复缩进的唯一方法是了解相关语言，并且 EditorConfig 与语言无关。

【讨论】：

没有非npm解决方案吗？

@AlexZhukovskiy 是的，用 Gradle、Maven 和 Ant 插件/任务检查我的答案；)