@4cm4k1/grunt-standard

grunt-standard

Grunt Plugin for JavaScript Standard Style Linting and Formatting

Based on @pdehaan/grunt-standard

Dependencies up-to-date!

Install

The following shell commands will install grunt-standard to your project's package.json in devDependencies.

npm

npm install @4cm4k1/grunt-standard --save-dev

Yarn

yarn add @4cm4k1/grunt-standard --dev

Assumptions

• You have the latest version of grunt in your project's package.json's devDependencies.
• You have added the npm task to your project's Gruntfile.js.
• You are running the latest version of node.

grunt.loadNpmTasks('grunt-standard')

Configure

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

Default

In this example, the default options are used to lint the specified *.js files in the root, lib/, and tasks/ directories:

grunt.initConfig({
  standard: {
    app: {
      src: [
        '{,lib/,tasks/}*.js'
      ]
    }
  }
})

Custom

options.format

• Type: Boolean
• Default: false
• Action: Auto-format source files using standard-format.

options.lint

• Type: Boolean
• Default: true
• Action: Lint source files using JavaScript Standard Style.

In this example, the format option is set to true so the source files will be auto-formatted (and written back to disk) before being linted:

grunt.initConfig({
  standard: {
    options: {
      format: true
    },
    app: {
      src: [
        '{,lib/,tasks/}*.js'
      ]
    }
  }
})

Contribute