jformatter

A JavaScript formatter

!jformatter

Basic usage

The easiest way to use JFormatter is to install it as a Node program.

npm -g install jformatter

After you've done that you should be able to use the jformatter program.

jformatter file.js

Command in Terminal

``
Usage: jformatter [options]

Options:

-h, --help output usage information
-v, --version output the version number
-d, --diff Show difference between source and formatted
`

Configuration

When use jformatter in terminal, it will try to load .jformatterrc.

JFormatter will start looking for this file in the same directory as the file that's being formatted. If not found, it will move one level up the directory tree all the way up to the filesystem root.

Default config, developing, not stable.

{
lineSeparator: '\n', // done
maxLength: 120, // TODO
wrapIfLong: false, // TODO
indent: 4, // done
useTabIndent: false, // done
spaces: {
around: {
unaryOperators: false, // TODO
binaryOperators: true, // done
ternaryOperators: true // done
},
before: {
functionDeclarationParentheses: false, // done function foo() {
functionExpressionParentheses: true, // done var foo = function () {
parentheses: true, // done if (), for (), while (), ...
leftBrace: true, // done function () {, if () {, do {, try { ...
keywords: true // done if {} else {}, do {} while (), try {} catch () {} finally
},
within: {
// function call, function declaration, if, for, while, switch, catch
parentheses: false // done
},
other: {
beforePropertyNameValueSeparator: false, // done {key: value} {key : value} {key:value}
afterPropertyNameValueSeparator: true // done
}
},
bracesPlacement: { // 1. same line 2. next line
functionDeclaration: 1, // TODO
other: 1 // TODO
},
blankLines: {
keepMaxBlankLines: 1, // done
atEndOfFile: true // done
},
other: {
keepArraySingleLine: false // TODO default formatted array multi line
},
fix: {
prefixSpaceToLineComment: false, // done
alterCommonBlockCommentToLineComment: false, // done
singleVariableDeclarator: false, // done
fixInvalidTypeof: false, // done
removeEmptyStatement: false, // done
autoSemicolon: false, // done
singleQuotes: false, // done
eqeqeq: false, // done
invalidConstructor: false, // done
addCurly: false, // done
removeDebugger: false // done
}
}

API

require('jformatter').format(code, [configObj]) : string
require('jformatter').formatFile(filePath, [configObj]) : string
require('jformatter').version() : string
require('jformatter').getDefaultConfig() : configObj

Important Note

please update to >=v1.0.5, see version change log

Changelog

$3

* make all config work
* 调整注释缩进

$3

* auto fix: addCurly, add curly for if/while/for statement
* auto fix: removeDebugger, remove debugger statement

$3

* fix bug: fix error when format empty file
* catch error when esprima parse syntax error files

$3

* fix bug: for windows environment

$3

* fix bug: single quotes auto-fix bugs
* update test case

$3

* fix bug: lost space before instanceof

$3

* fix bug: autoSemicolon add semicolon in for statement

$3

* add 5 auto fix, please see config.fix
* improve command line tool, please see document
* test case update

$3

* new and safe logic of keeping blank line
* config for blank line at end of file
* keep 1 blank line default
* test case update

$3

* keep blank line after file doc
* keep blank line after },

$3

* all new architecture with rocambole
* more config work
* fix a bug in auto-fixer

$3

* npm test: config auto test
* npm test: style auto test
* add four auto-fixer config
* fix bug: Comment at first line cause redundant LineBreak
* version rule

$3

* add version api

$3

* fix bug: lost space after void

$3

* fix bug: lost space after typeof`
* fix bug: lost space after comma expression

$3

* remove config not relate to code style
* change config editable with common config editor
* support npm test

$3

* Fix DoWhileStatement bug

$3

* Initial release