ec4rs

An editorconfig core library in safe Rust

APACHE-2.0 License

Downloads
63.5K
Stars
17
Committers
1

ec4rs: EditorConfig For Rust

An EditorConfig core in safe Rust.

This library enables you to integrate EditorConfig support into any tools which may benefit from it, such as code editors, formatters, and style linters. It includes mechanisms for type-safe parsing of properties, so that your tool doesn't have to do it itself. It also exposes significant portions of its logic, allowing you to use only the parts you need.

Name idea shamelessly stolen from ec4j. This library has minimal dependencies (only std at this time).

For example usage, see the docs.

Testing

The main repository for this library includes the EditorConfig core tests as a Git submodule. This library should pass all of these tests. To run the test suite, run the following commands in a POSIX-like shell:

cargo build --package ec4rs_tools
git submodule update --init --recursive
cd tests
cmake -DEDITORCONFIG_CMD="$PWD/../target/debug/ec4rs-parse" .
ctest .

License

ec4rs is licensed under the Apache License 2.0 with no NOTICE text.

Contributors submitting code changes must agree to the terms of the Developer Certificate of Origin (DCO) to have their contributions accepted for inclusion. A copy of the DCO may be found in DCO.txt. Contributors should sign-off on their commits (see git commit -s) to indicate explicit agreement.