esformatter-ignore/README.md

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

# [esformatter](https://github.com/millermedeiros/esformatter)-jsx
> an esformatter plugin to make esformatter ignore certain lines and blocks of code

[![NPM Version](http://img.shields.io/npm/v/esformatter-ignore.svg?style=flat)](https://npmjs.org/package/esformatter-ignore)
[![Build Status](http://img.shields.io/travis/royriojas/esformatter-ignore.svg?style=flat)](https://travis-ci.org/royriojas/esformatter-ignore)

## Overview

**esformatter-ignore** is a plugin for [esformatter](https://github.com/millermedeiros/esformatter) meant to allow
certain lines and blocks of code to be ignored by esformatter

**Example**

```javascript
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

```javascript
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

```sh
$ npm install esformatter-ignore --save-dev
```

## Config

Newest esformatter versions autoload plugins from your `node_modules` [See this](https://github.com/millermedeiros/esformatter#plugins)

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

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

Or you can manually register your plugin:

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

## node usage

```js
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](https://github.com/millermedeiros/esformatter) for more options and further usage info.

## License

[MIT](License)