EditorConfig: How to autofix all files in a project

Question

Given I have an .editorconfig file that dictates consistent indent, line endings, trailing whitespace, etc.

# 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

As a developer, I want to fix all files consistently with a command-line tool that understands .editorconfig files. I want to avoid tedious tasks, for instance, manually open and change files.

I imagine if there was a command like for example:

editorconfix.sh --autofix .

Which tools exist for this purpose? What scripts do you use?

There is an open issue in the `prettier` project to respect .editorconfig: https://github.com/jlongster/prettier/issues/42 — IanVS, Jan 15 '17 at 02:21

score 44 · Accepted Answer · answered Jan 14 '17 at 22:42

44

There is eclint (and a fork called editorconfig-tools). Run

eclint check 'src/**/*'

to check all files in the src directory, or

eclint fix 'src/**/*'

to fix them. But please note that the tool can produce some surprises when it comes to indentation! The author of the tool says in a GitHub comment that he has stopped using the tool himself in favour of language-specific linters:

To me, EditorConfig is all about – would you believe it – configuring your editor and nothing more. I don't think it should be responsible for linting or fixing, as there are language-specific tools to accomplish those goals (e.g., ESLint for JavaScript). The only way you can reliably lint or fix indentation is to be aware of the language in question and EditorConfig is language agnostic.

answered Jan 14 '17 at 22:42

danmichaelo

1,706
1
25
30

5

There is no non-npm solution? – Alex Zhukovskiy May 21 '18 at 06:44
1

@AlexZhukovskiy yes there is, check my answer with Gradle, Maven and Ant plugins/tasks ;) – froblesmartin May 07 '20 at 08:29
1

eclint is not AST-aware, leading to its author dropping it. It now has security issues in at least one of its dependencies. – Perkins May 08 '22 at 19:18

score 3 · Answer 2 · edited Jan 11 '23 at 01:50

3

Also, if you use Gradle, Maven or Ant there are tools:

Gradle: https://plugins.gradle.org/plugin/org.ec4j.editorconfig

To check files:
```
./gradlew editorconfigCheck
```
To try to fix them automatically:
```
./gradlew editorconfigFormat
```
Maven: EditorConfig Maven Plugin. editorconfig-maven-plugin
Ant: editorconfig-ant-tasks

edited Jan 11 '23 at 01:50

Peter Mortensen

30,738
21
105
131

answered May 07 '20 at 08:28

froblesmartin

1,527
18
25

EditorConfig: How to autofix all files in a project

2 Answers2