esformatter plugin: enforces braces around statements
npm install esformatter-braces> esformatter plugin for enforcing braces around statements
Esformatter-braces is a plugin for esformatter meant for brace enforcement around statements. Recommended by Douglas Crockford in his coding style guide.
Turn this:
``js`
if (theSkyIsBlue)
stareAtItForAWhile();
into:
`js`
if (theSkyIsBlue) {
stareAtItForAWhile();
}
For more information see:
- Jetbrain's Idea and specifically the Force brace always section.
- The jsHint option - curly
Currently the following node statements are handled:
If conditionals, While, Do While, For loops
For any other formatting (such as braces placement, spacing and line wrapping) use esformatter or other plugins.
- Add similar options to IDEA's: Do not force and Multiline
- Possibly do the reverse: remove braces if possible (single line statements)
`sh`
$ npm install esformatter-braces --save-dev
Newest esformatter versions autoload plugins from your node_modules See this
Add to your esformatter config file:
`json`
{
"plugins": [
"esformatter-braces"
]
}
Or you can manually register your plugin:
`js`
// register plugin
esformatter.register(require('esformatter-braces'));
`js
var fs = require('fs');
var esformatter = require('esformatter');
//register plugin manually
esformatter.register(require('esformatter-braces'));
var str = fs.readFileSync('someKewlFile.js').toString();
var output = esformatter.format(str);
//-> output will now contain the formatted string
``
See esformatter for more options and further usage.
MIT @Gilad Peleg