review.tizen.org Git - platform/framework/web/crosswalk-tizen.git/blob

   1 # esformatter-quotes
   2
   3 [esformatter](https://github.com/millermedeiros/esformatter) plugin for
   4 single/double quotes normalization.
   5
   6
   7 ## Usage
   8
   9 install it:
  10
  11 ```sh
  12 npm install esformatter-quotes
  13 ```
  14
  15 and add to your esformatter config file:
  16
  17 ```json
  18 {
  19   "plugins": [
  20     "esformatter-quotes"
  21   ],
  22   "quotes": {
  23     "type": "single",
  24     "avoidEscape": false
  25   }
  26 }
  27 ```
  28
  29
  30 ## Options
  31
  32   - **type:String**
  33     - if code should use "single" or "double" quotes.
  34   - **avoidEscape:Boolean**
  35     - `true` if you want to avoid escaping quotes when possible.
  36
  37 ```js
  38 // register plugin
  39 esformatter.register(require('esformatter-quotes'));
  40 // pass options as second argument
  41 var output = esformatter.format(str, {
  42   "quotes": {
  43     "type": "single",
  44     "avoidEscape": false
  45   }
  46 });
  47 ```
  48
  49 ## Examples
  50
  51 Given this input program:
  52
  53 ```js
  54 var singleQuote = 'single';
  55 var doubleQuote = "double";
  56 var avoidSingle = 'single "quote"';
  57 var avoidDouble = "double 'quote'";
  58 var lorem = "ipsum \"dolor\" sit 'amet'";
  59 var maecennas = 'ipsum \'dolor\' sit "amet"';
  60 ```
  61
  62 Will you get the following output based on the config options:
  63
  64
  65 ### {type: 'single'}
  66
  67 ```js
  68 var singleQuote = 'single';
  69 var doubleQuote = 'double';
  70 var avoidSingle = 'single "quote"';
  71 var avoidDouble = 'double \'quote\'';
  72 var lorem = 'ipsum "dolor" sit \'amet\'';
  73 var maecennas = 'ipsum \'dolor\' sit "amet"';
  74 ```
  75
  76 ### {type: 'single', avoidEscape: true}
  77
  78 ```js
  79 var singleQuote = 'single';
  80 var doubleQuote = 'double';
  81 var avoidSingle = 'single "quote"';
  82 var avoidDouble = "double 'quote'";
  83 var lorem = 'ipsum "dolor" sit \'amet\'';
  84 var maecennas = 'ipsum \'dolor\' sit "amet"';
  85 ```
  86
  87 ### {type: 'double'}
  88
  89 ```js
  90 var singleQuote = "single";
  91 var doubleQuote = "double";
  92 var avoidSingle = "single \"quote\"";
  93 var avoidDouble = "double 'quote'";
  94 var lorem = "ipsum \"dolor\" sit 'amet'";
  95 var maecennas = "ipsum 'dolor' sit \"amet\"";
  96 ```
  97
  98 ### {type: 'double', avoidEscape: true}
  99
 100 ```js
 101 var singleQuote = "single";
 102 var doubleQuote = "double";
 103 var avoidSingle = 'single "quote"';
 104 var avoidDouble = "double 'quote'";
 105 var lorem = "ipsum \"dolor\" sit 'amet'";
 106 var maecennas = "ipsum 'dolor' sit \"amet\"";
 107 ```
 108
 109
 110 ## License
 111
 112 Released under the [MIT License](http://opensource.org/licenses/MIT).
 113