esformatter-ignore

esformatter-jsx

an esformatter plugin to make esformatter ignore certain lines and blocks of code

Overview

esformatter-ignore is a plugin for esformatter meant to allow certain lines and blocks of code to be ignored by esformatter

Example

var someVar = 'foo';
if (someVar) {
  /*esfmt-ignore-start*/
// you want for some reason this block to remain untoched by the formatter
// most use cases are for certain cases where the formatter produces some buggy
// output like these cases:
// - https://github.com/millermedeiros/esformatter/issues/359
// - https://github.com/millermedeiros/esformatter/issues/358
// - https://github.com/millermedeiros/esformatter/issues/347
cache.setKey( 'persistifyArgs', {
cache: browserifyOpts.cache,
packageCache: browserifyOpts.packageCache
} );
    /*esfmt-ignore-end*/
}

If you want to ignore only a single line you can also do it by doing

if (someKey) {
  // ignoring next line cause esformatter@7.0.3
  // mistakenly move the semicolon to the next line
  delete objectCache[someKey]; // esfmt-ignore-line
}

Installation

$ npm install esformatter-ignore --save-dev

Config

Newest esformatter versions autoload plugins from your node_modules See this

Add to your esformatter config file:

In order for this to work, this plugin should be the first one! (I Know too picky, but who isn't).

{
  "plugins": [
    "esformatter-ignore"
  ]
}

Or you can manually register your plugin:

// register plugin
esformatter.register(require('esformatter-ignore'));

node usage

var fs = require('fs');
var esformatter = require('esformatter');
//register plugin manually
esformatter.register(require('esformatter-ignore'));

var str = fs.readFileSync('./someKewlFile.js').toString();
var output = esformatter.format(str);
//-> output will now contain the formatted code with the blocks marked to be ignored remain intact

See esformatter for more options and further usage info.

License

MIT

Changelog

v0.1.3

• Bug Fixes
  • make sure ignore line works as expected. Fixes #1 - 9f07dff, royriojas, 08/10/2015 13:31:02