grunt-esformatter

Format JavaScript files using esformatter.

Getting Started

This plugin requires Grunt ~0.4.0

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-esformatter --save-dev

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

grunt.loadNpmTasks('grunt-esformatter');

Esformatter task

Run this task with the grunt esformatter command.

Task targets, files and options may be specified according to the grunt Configuring tasks guide.

Files are formatted with esformatter.

Configuration

When running esformatter task in grunt, it will look for the closest .esformatter file and use that as a setting. Valuse from this file will override default values for options. You also have the option to put your esformatter settings inside the package.json file under the esformatter property.

Options

Values from this object will override the .esfromatter file values.

config

Type: String Default: undefined

Path of the config file. Values from options object, will override the config file values.

preset

Type: String Default: undefined

Pick one of the presets that esformatter bundles. If you don't specify the option, the default preset is used.

skipHashbang

Type: Boolean Default: false

If you're formatting a script that contains a first line starting with "#!": for example when you're writing scripts that are executable by themselves, set this option to make the task remove this line before formatting it, then put it back after formatting. Here's an example of such a script:

###!/usr/bin/env node

scriptCodeHere();

By default, if you format a file with esformatter that includes this line, the parser (esprima) will throw an exception, pointing out that first line as an "illegal token". Which makes sense in the context of browser scripts, where the parser would throw the same error.

indent, lineBreak, whiteSpace

Type: Object Default: undefined

These are the top-level configuration properties for esformatter. You can specify any of the nested properties to overwrite settings from the chosen preset.

Once there is documentation available for these, a link will be added. Until then you have to look at the esformatter source code.

Usage Examples

Format all the files in the 'src folder' with the default preset

esformatter: {
  src: 'src/**/*.js'
}

Format two specific files with the 'jquery' preset

esformatter: {
  options: {
    preset: 'jquery'
  },
  src: ['src/parser.js', 'src/formatter.js']
}

Format two sets of files with custom settings

esformatter: {
  four_space_indent: {
    options: {
      indent: {
        value: '    '
      }
    },
    src: 'file1.js'
  },
  jquery_two_space_indent: {
    options: {
      preset: 'jquery'
      indent: {
        value: '  '
      }
    },
    src: 'vendor/*.js'
  }
}

License

Copyright Emech En. Licensed under the MIT license.