# grunt-coffeelint

> Lint your Coffee

Latest version **0.0.16** (published 2016-06-02) · 0 weekly downloads

## Install

```sh
npm install grunt-coffeelint
pnpm add grunt-coffeelint
yarn add grunt-coffeelint
bun add grunt-coffeelint
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.16 |
| Published | 2016-06-02 |
| First published | 2012-08-19 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | * |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 114 |
| Author | Vojta Jína |
| Maintainers | adambiggs, mwittig, vojtajina |
| Keywords | gruntplugin |

## Links

- npm: https://www.npmjs.com/package/grunt-coffeelint
- Repository: https://github.com/vojtajina/grunt-coffeelint
- Issues: https://github.com/vojtajina/grunt-coffeelint/issues
- npm.io page: https://npm.io/package/grunt-coffeelint

## Dependencies (2)

- [coffeelint](https://npm.io/package/coffeelint.md) ^1
- [coffeelint-stylish](https://npm.io/package/coffeelint-stylish.md) ~0.1.0

## Recent versions

- 0.0.16 (latest) — 2016-06-02
- 0.0.15 — 2016-02-04
- 0.0.13 — 2014-07-29
- 0.0.10 — 2014-04-08
- 0.0.8 — 2013-12-09
- 0.0.7 — 2013-07-01
- 0.0.6 — 2013-02-21
- 0.0.5 — 2013-02-20
- 0.0.4 — 2013-02-07
- 0.0.3 — 2012-10-16
- 0.0.2 — 2012-08-19
- 0.0.1 — 2012-08-19

## README

[![build status](https://secure.travis-ci.org/vojtajina/grunt-coffeelint.svg)](http://travis-ci.org/vojtajina/grunt-coffeelint)
# grunt-coffeelint

**Lint your CoffeeScript with [CoffeeLint].**

## Installation

Install npm package, next to your project's `Gruntfile.js` file:

    npm install grunt-coffeelint

Add this line to your project's `Gruntfile.js`:

    grunt.loadNpmTasks('grunt-coffeelint');

## Options

A few additional options are supported:

### force
Type: `Boolean`
Default value: `false`

Set `force` to `true` to report CoffeeLint errors but not fail the task.

## Configuration

`coffeelint` is a multitask, so you can use it similary to `lint`, `watch` etc...

````javascript
grunt.initConfig({
    ...
    coffeelint: {
      app: ['app/*.coffee', 'scripts/*.coffee']
    },
    ...
});
````

### Options per target

````javascript
grunt.initConfig({
    ...
    coffeelint: {
      app: ['app/*.coffee', 'scripts/*.coffee'],
      tests: {
        files: {
          src: ['tests/*.coffee']
        },
        options: {
          'no_trailing_whitespace': {
            'level': 'error'
          }
        }
      }
    },
    ...
});
````

### Global - default options

````javascript
grunt.initConfig({
    ...
    coffeelint: {
      options: {
        'no_trailing_whitespace': {
          'level': 'error'
        }
      }
    },
    ...
});
````

### Loading external config

````javascript
grunt.initConfig({
    ...
    coffeelint: {
      options: {
        configFile: 'coffeelint.json'
      }
    },
    ...
});
````
Task `options` take precedence over `configFile` options.

For available options see [coffeelint homepage].

[CoffeeLint]: http://www.coffeelint.org/
[coffeelint homepage]: http://www.coffeelint.org/

---
_Source: https://npm.io/package/grunt-coffeelint · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._