https://github.com/sibiraj-s/grunt-coffeelintr

A Grunt Plugin for Coffeelint
https://github.com/sibiraj-s/grunt-coffeelintr

coffeelint grunt grunt-coffeelintr grunt-plugins

Last synced: 2 months ago
JSON representation

A Grunt Plugin for Coffeelint

• Host: GitHub
• URL: https://github.com/sibiraj-s/grunt-coffeelintr
• Owner: sibiraj-s
• License: mit
• Created: 2018-07-24T11:23:27.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-06-22T07:45:43.000Z (6 months ago)
• Last Synced: 2024-10-19T19:55:06.615Z (3 months ago)
• Topics: coffeelint, grunt, grunt-coffeelintr, grunt-plugins
• Language: JavaScript
• Homepage: https://npm.im/grunt-coffeelintr
• Size: 2.24 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# grunt-coffeelintr

> A Grunt Plugin for Coffeelint



  



[CoffeeLint](https://coffeelint.github.io/) is a style checker that helps keep CoffeeScript code clean and consistent.

[![NPM Version](https://img.shields.io/npm/v/grunt-coffeelintr.svg)](https://www.npmjs.com/package/grunt-coffeelintr)

[![License](https://img.shields.io/npm/l/grunt-coffeelintr.svg)](https://github.com/sibiraj-s/grunt-coffeelintr/blob/master/LICENSE)

[![Tests](https://github.com/sibiraj-s/grunt-coffeelintr/workflows/Tests/badge.svg)](https://github.com/sibiraj-s/grunt-coffeelintr/actions)

![Sample](assets/report.png)

## Getting Started

This plugin requires Grunt `>= 1.0.0` and Node.js `>= 10`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell

npm install grunt-coffeelintr --save-dev

```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js

grunt.loadNpmTasks('grunt-coffeelintr');

```

## The "coffeelintr" task

### Overview

In your project's Gruntfile, add a section named `coffeelintr` to the data object passed into `grunt.initConfig()`.

```js

grunt.initConfig({

  coffeelintr: {

    options: {

      congigFile: 'coffeelint.json',

      force: false

    },

    your_target: {

      files: {

        src: ['**/*.coffee']

      }

    }

  }

});

```

To override any of CoffeeLint's default options, generate a [configuration](https://coffeelint.github.io/#usage) file and tweak it as needed, and specify that file as shown above.