grunt-coffeelintr

A Grunt Plugin for Coffeelint

CoffeeLint is a style checker that helps keep CoffeeScript code clean and consistent.

Getting Started

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

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-coffeelintr --save-dev

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

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().

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 file and tweak it as needed, and specify that file as shown above.