https://github.com/brunch/coffeelint-brunch

Adds Coffeelint linting support to Brunch.
https://github.com/brunch/coffeelint-brunch

brunch brunch-linter brunch-plugin coffeelint coffeescript

Last synced: 23 days ago
JSON representation

Adds Coffeelint linting support to Brunch.

• Host: GitHub
• URL: https://github.com/brunch/coffeelint-brunch
• Owner: brunch
• License: mit
• Archived: true
• Created: 2012-08-20T18:27:20.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2017-02-27T07:09:52.000Z (over 7 years ago)
• Last Synced: 2024-05-20T19:42:07.602Z (about 1 month ago)
• Topics: brunch, brunch-linter, brunch-plugin, coffeelint, coffeescript
• Language: JavaScript
• Homepage:
• Size: 34.2 KB
• Stars: 18
• Watchers: 7
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE-MIT

Lists

• awesome-design - Coffeelint

README

        
## coffeelint-brunch

Adds [coffeelint](http://www.coffeelint.org) support to

[brunch](http://brunch.io).

## Usage ⚑

Install the plugin via npm with `npm install --save-dev coffeelint-brunch`.

Or, do manual install:

* Add `"coffeelint-brunch": "x.y.z"` to `package.json` of your brunch app.

  Pick a plugin version that corresponds to your minor (y) brunch version.

* If you want to use git version of plugin, add

`"coffeelint-brunch": "git+ssh://[email protected]:ilkosta/coffeelint-brunch.git"`.

By default, only files in your `config.paths.app` are linted.

You can customize coffeelint config by changing brunch config using the native [coffeelint options](http://www.coffeelint.org/#options):

```coffeescript

config =

  plugins:

    coffeelint:

      pattern: /^app\/.*\.coffee$/

      options:

        no_trailing_semicolons:

          level: "ignore"

```

You can also use the standard `coffeelint.json` file instead of adding exceptions in the brunch config:

```coffeescript

config =

  plugins:

    coffeelint:

      useCoffeelintJson: yes

```

In the second case, any rules in `plugins.coffeelint.options` are ignored and instead coffeelint is supplied with the contents of the `coffeelint.json` file found in the root directory as the configuration object.

Every sub-option (`pattern`, `options`, `useCoffeelintJson`, `globals`) is optional.

## License ⚑

Copyright (c) 2012 "ilkosta" Costantino Giuliodori.

Licensed under the [MIT license](coffeelint-brunch/blob/master/LICENSE-MIT).