brave-mouse
Validate your code against your EditorConfig.
Command line interface
Install brave-mouse using:
$ npm install brave-mouse -g
Validate files like this:
$ brave-mouse .travis.yml README.md package.json
brave-mouse automatically uses the appropiate .editorconfig
.
Exit codes
brave-mouse will exit abruptly (i.e. subsequent files won’t be processed) with an exit code of 1
if it encounters an error such as being unable to read a file.
brave-mouse will exit with an exit code of 2
if all files could be processed but not all files are valid according to your .editorconfig
.
If all files could be processed successfully and are valid, brave-mouse exits with an exit code of 0
.
Programmatic usage
Install brave-mouse using:
$ npm install brave-mouse
Use it like this:
var braveMouse = ; braveMouse;
Supported EditorConfig properties
See EditorConfig’s wiki for a complete list of properties.
brave-mouse currently supports validating the following properties:
indent_style
indent_size
end_of_line
(onlylf
andcrlf
are supported)trim_trailing_whitespace
insert_final_newline
max_line_length
tab_width
can’t be validated as it only applies to editors.
Running tests
First, install all dependencies:
$ npm install -g grunt-cli$ npm install
Then run the tests:
$ grunt test
Release History
See CHANGELOG.md.
License
brave-mouse is licensed under the BSD 2-clause license, subject to additional terms. See LICENSE for the full license text.