ECMAScript code beautifier/formatter.

This tool is still on early development and is missing support for many important features.

We are looking for contributors!!

jsbeautifier.org doesn't have enough options and not all IDEs/Editors have a good JavaScript code formatter. I would like to have a command line tool (and standalone lib) as powerful/flexible as the WebStorm and FDT code formatters.

This tool could also be reused by other node.js libs like escodegen to format the output (so each lib has a single responsibility).

For more reasoning behind it and history of the project see: esformatter & rocambole

This tool uses rocambole (based on Esprima) to recursively parse the tokens and transform it in place.

• granular control about white spaces, indent and line breaks.
• command line interface (cli).
• be non-destructive.
• option to control automatic semicolon insertion (asi).
• support for local/global config file so settings can be shared between team members.
• presets for the most popular style guides (Google, jQuery, Idiomatic.js).
• be the best JavaScript code formatter.

So far esformatter exposes a single format() method which receives a string containing the code that you would like to format and the configuration options that you would like to use and returns a string with the result.

var esformatter = require('esformatter');

// for a list of available options check "lib/preset/default.json"
var options = {
    // inherit from the default preset
    preset : 'default',
    indent : {
        value : '  '
    },
    lineBreak : {
        before : {
            BlockStatement : 1,
            DoWhileStatementOpeningBrace : 1,
            // ...
        }
    },
    whiteSpace : {
        // ...
    }
};

var fs = require('fs');
var codeStr = fs.readFileSync('path/to/js/file.js', 'utf-8');

// return a string with the formatted code
var formattedCode = esformatter.format(codeStr, options);

You can also use the simple CLI to process stdin and stdout or reading from file:

stdin

# format "test.js" and output result to stdout
cat test.js | esformatter
# format "test.js" using options in "options.json" and output result to stdout
cat test.js | esformatter --config options.json
# process "test.js" and writes to "test.out.js"
esformatter < test.js > test.out.js

file

# format "test.js" and output result to stdout
esformatter test.js
# format "test.js" using options in "options.json" and output result to stdout
esformatter --config options.json test.js
# process "test.js" and writes to "test.out.js"
esformatter test.js > test.out.js

# Usage information
esformatter --help
esformatter -h

# Version number
esformatter --version
esformatter -v

CLI will be highly improved after we complete the basic features of the library. We plan to add support for local/global settings and some flags to toggle the behavior.

See CONTRIBUTING.md

• jsbeautifier

Released under the MIT license