CoffeeLint - Newline At End Of File

Validate a newline policy at the end of each file

Description

This CoffeeLint plugin verifies whether or not your files end with a newline. You can customise its behaviour to either enforce newlines at the end of each file or to prohibit them.

Installation

[sudo] npm install -g coffeelint-newline-at-eof

Note: Right now a Coffeelint plugin cannot be installed as a project dependency and must be installed globally. Perhaps this will be improved in a future version of Coffeelint. If you would like to track progress on this enhancement head over here.

Usage

Insert the below configuration into coffeelint.json that you use for linting your scripts:

"newline_at_eof": {
    "module": "coffeelint-newline-at-eof",
    "level": "error",
    "behaviour": "require"
}

Configuration

The only configuration option specific to this plugin is the behaviour property.

Available values are:

• require - Newlines are required to be present at the end of file
• forbid - Newlines are forbidden to be present at the end of file

By default, Coffeelint will report errors if this rule is not satisfied. You may want to relax this by setting the level to warn in your configuration.

Credits

Thanks to Matt Perpick, the creator of Coffeelint and to all contributors to the project for their excellent work.

License

This software is licensed under the BSD-3-Clause License. See the LICENSE file for more information.