esformatter-quotes/README.md

esformatter plugin: enforces coding style that string literals are delimited with single or double quotes.

# esformatter-quotes

[esformatter](https://github.com/millermedeiros/esformatter) plugin for
single/double quotes normalization.


## Usage

install it:

```sh
npm install esformatter-quotes
```

and add to your esformatter config file:

```json
{
  "plugins": [
    "esformatter-quotes"
  ],
  "quotes": {
    "type": "single",
    "avoidEscape": false
  }
}
```


## Options

  - **type:String**
    - if code should use "single" or "double" quotes.
  - **avoidEscape:Boolean**
    - `true` if you want to avoid escaping quotes when possible.

```js
// register plugin
esformatter.register(require('esformatter-quotes'));
// pass options as second argument
var output = esformatter.format(str, {
  "quotes": {
    "type": "single",
    "avoidEscape": false
  }
});
```

## Examples

Given this input program:

```js
var singleQuote = 'single';
var doubleQuote = "double";
var avoidSingle = 'single "quote"';
var avoidDouble = "double 'quote'";
var lorem = "ipsum \"dolor\" sit 'amet'";
var maecennas = 'ipsum \'dolor\' sit "amet"';
```

Will you get the following output based on the config options:


### {type: 'single'}

```js
var singleQuote = 'single';
var doubleQuote = 'double';
var avoidSingle = 'single "quote"';
var avoidDouble = 'double \'quote\'';
var lorem = 'ipsum "dolor" sit \'amet\'';
var maecennas = 'ipsum \'dolor\' sit "amet"';
```

### {type: 'single', avoidEscape: true}

```js
var singleQuote = 'single';
var doubleQuote = 'double';
var avoidSingle = 'single "quote"';
var avoidDouble = "double 'quote'";
var lorem = 'ipsum "dolor" sit \'amet\'';
var maecennas = 'ipsum \'dolor\' sit "amet"';
```

### {type: 'double'}

```js
var singleQuote = "single";
var doubleQuote = "double";
var avoidSingle = "single \"quote\"";
var avoidDouble = "double 'quote'";
var lorem = "ipsum \"dolor\" sit 'amet'";
var maecennas = "ipsum 'dolor' sit \"amet\"";
```

### {type: 'double', avoidEscape: true}

```js
var singleQuote = "single";
var doubleQuote = "double";
var avoidSingle = 'single "quote"';
var avoidDouble = "double 'quote'";
var lorem = "ipsum \"dolor\" sit 'amet'";
var maecennas = "ipsum 'dolor' sit \"amet\"";
```


## License

Released under the [MIT License](http://opensource.org/licenses/MIT).