This tool is still missing support for many important features. Please report
any bugs you find, the code is only as good as the test cases. Feature requests
are very welcome.
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) at least as powerful/flexible as the
and
code formatters so that it can be plugged
into any editor and reused by other tools like
.
support most popular style guides through plugins (Google, jQuery,
Idiomatic.js).
be the best JavaScript code formatter!
API
var esformatter = require('esformatter');var fs = require('fs');var codeStr = fs.readFileSync('path/to/js/file.js').toString();// for a list of available options check "lib/preset/default.js"var options = { indent : { value : ' ' }, lineBreak : { before : { // at least one line break before BlockStatement BlockStatement : '>=1', // only one line break before DoWhileStatementOpeningBrace DoWhileStatementOpeningBrace : 1, // ... } }, whiteSpace : { // ... }};// return a string with the formatted codevar formattedCode = esformatter.format(codeStr, options);
See the doc/api.md file for a list of all the public methods
and detailed documentation about each one.
See doc/config.md for more info about the configuration
options.
CLI
You can also use the simple command line interface to process the stdin or
read from a file.
npm install [-g] esformatter
Usage:
Pass the --help flag to see the available options or see
doc/cli.txt.
esformatter --help
Examples:
# Format# ======# format "test.js" and output result to stdoutesformatter test.js# you can also pipe other shell commands (read file from stdin)cat test.js | esformatter# format "test.js" using options in "options.json" and output result to stdoutesformatter --config options.json test.js# process "test.js" and writes to "test.out.js"esformatter test.js > test.out.js# you can override the default settings, see lib/preset/default.js for# a list of available optionsesformatter test.js --indent.value="\t" --lineBreak.before.IfStatementOpeningBrace=0# format "test.js" and output result to "test.js"esformatter -i test.js# format and overwrite all the ".js" files inside the "lib/" folderesformatter -i 'lib/*.js'# format and overwrite all the ".js" files inside "lib/" and it's subfoldersesformatter -i 'lib/**/*.js'# **important:** surround the glob with single quotes to avoid expansion; [glob# syntax reference](https://github.com/isaacs/node-glob/#glob-primer)# Diff# ======# check if "test.js" matches style and output diff to stdoutesformatter --diff test.js# check if "test.js" matches style and output unified diff to stdoutesformatter --diff-unified test.js# check if "test.js" matches "options.json" style and output diff to stdoutesformatter --diff --config options.json test.js# check all files inside "lib/" and it's subfoldersesformatter --diff 'lib/**/*.js'
Local version
If a locally installed esformatter is found, the CLI uses that instead of the
global executable (this means you can have multiple projects depending on
different versions of esformatter).
protip: add esformatter and all the plugins that you need on your project
to the package.json devDependencies
that way you can use locally installed plugins and also make sure everyone on
your team is using the same version/settings.
Presets are reusable config files that can require other presets/plugins and
override configs.
{ // presets are used as "base settings" "extends": [ "preset:foobar", // load "esformatter-preset-foobar" from "./node_modules" "./lorem_ipsum.json" // load relative config file ], // you can still override any setting from the preset if needed "indent": { "value": " " }}
Since we don't expect everyone to write plugins that only works with
esformatter we decided to encourage the usage of standalone CLI tools.
{ // pipe is a simple way to "pipe" multiple binaries input/output "pipe": { // scripts listed as "before" will be executed before esformatter // and will forward output to next command in the queue "before": [ "strip-debug", "./bin/my-custom-script.sh --foo true -zx" ], // scripts listed as "after" will be executed after esformatter "after": [ "baz --keepLineBreaks" ] }}
Plugins
Plugins are automatically loaded from node_modules if you pass the module id
in the config file: