c15r / editorconfig-tools

Experimental: Tools for verifying/fixing code style based on EditorConfig file (not completed yet)

EditorConfig Tools

Goals of this project

• Create tool to infer format for .editorconfig file from current code
• Create tool to validate current code from existing .editorconfig files
• Create tool to fix style errors in code from existing .editorconfig files

Examples

Here is an example of the command-line API we want to support:

$ cat .editorconfig
[*]
indent_style = space
indent_size = 4

$ check_editorconfig test/lf_*.txt
tests/lf_invalid_crlf.txt: Incorrect line ending found: crlf
tests/lf_invalid_crlf.txt: No final newline found
tests/lf_invalid_cr.txt: Incorrect line ending found: cr

$ check_editorconfig --generate *
[*]
indent_style = space
indent_size = 4
end_of_line = lf
charset = utf-8
insert_final_newline = true
trim_trailing_whitespace = true

[Makefile]
indent_style = tab
indent_size = tab

$ check_editorconfig --fix *
Makefile: Converted tabs to spaces

$ check_editorconfig *

Project Status

This project is not yet completed. Feel free to play with the existing code, but don't expect it to work well (or at all) yet.

Running Tests

Tox is used to run tests with supported Python interpreters and measure code coverage. To install tox:

pip install tox

To run tests using tox:

tox

Related Projects

• eclint