coffeelint-limit-newlines's Introduction

CoffeeLint - Limit number of newlines

Description

This CoffeeLint plugin checks to make sure there aren't to many blank newlines in your coffeescript file.

Installation

npm install coffeelint-limit-newlines

Usage

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

"limit_newlines": {
    "module": "coffeelint-limit-newlines",
    "level": "error",
    "value": 5 //number of newlines allowed
}

Configuration

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

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.

coffeelint-limit-newlines's People

Contributors

Watchers

coffeelint-limit-newlines's Issues

Do not treat comments as blank lines

I set limit of blank lines to 5, as in example. The following code fails linting:

class SearchService
    ###
    * Queries backend for people matching the given criteria.
    *
    * @param {Object}
    *            body criteria object (may contain name, surname,
    *            pesel params)
    *
    ###
  findPersonQuery: (body, successCallback, errorCallback) ->
    @Restangular.all('search/person').getList(body).then(successCallback, errorCallback)

Invalid violation when there is empty line in block comment

Hi again!

The following code:

class MyClass  
  ###
  Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas eget lacinia velit. 
  Morbi elit lacus, ornare sit amet rhoncus eu, pharetra ut ipsum. Fusce consequat maximus diam,
  non sodales nibh mollis non.

  Example:
  <span class="...">lorem</span> ipsum

  See provided tests for more details.
  ###
  myFunction: ->