coffeelint-newline-after-function

Validate a newline policy after function definitiions

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
coffeelint-newline-after-function
0.1.28 years ago8 years agoMinified + gzip package size for coffeelint-newline-after-function in KB

Readme

Coffeelint - Newline after Function
Validate a newline policy after every function definition

Description

This CoffeeLint plugin verifies whether or not your function definitions are followed by a newline. You can customise the number of newlines.

Installation

[sudo] npm install -g coffeelint-newline-after-function
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_after_function": {
    "module": "coffeelint-newline-after-function"
    "value": 1,
    "level": "error",
}

Example

This code will lint without errors:
class TestClass

  foo : ->

      @bar()

  bar : =>

      console.log("foo bar")

But this will fail:
class TestClass

  foo : ->
    console.log("Oh no! I have linting errors.")

Configuration

The only configuration option specific to this plugin is the value property. Change this to the number of newlines that you like to be inforced.
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.

License

MIT © scalable minds