7ce01efc8a | ||
---|---|---|
examples | ||
keymaps | ||
lib | ||
menus | ||
spec | ||
.editorconfig | ||
.gitignore | ||
.jsbeautifyrc | ||
.jshintrc | ||
.travis.yml | ||
CHANGELOG.md | ||
LICENSE.md | ||
README.md | ||
package.json |
README.md
atom-beautify
Beautify HTML (including Handlebars), CSS (including Sass and LESS), JavaScript, and much more in Atom.
Atom Package: https://atom.io/packages/atom-beautify
Language Support
- JavaScript and JSON
- HTML, including
- Handlebars
- XML
- CSS, including
- SQL, special thanks to pretty-data
- PHP
- Requires PHP_Beautifier to be already installed.
- Python
- Ruby
- Requires RBeautify
- CoffeeScript
Road Map
Usage
Open the Command Palette, and type Beautify
.
It will only beautify selected text, if a selection is found - if not, the whole file will be beautified.
Shortcut
You can also type ctrl-alt-b
as a shortcut or click Packages > Beautify
in the menu.
Custom Keyboard Shortcuts
See Keymaps In-Depth for more details.
For example:
'.editor': # Available from Editor only
'ctrl-alt-b': 'beautify'
Package Options
-
beautifyOnSave
You can also choose to beautify on every file save. -
googleAnalytics
There is Google Analytics to track what languages are being used the most and other stats. Everything is anonymized and no personal information, such as source code, is sent to Google. See https://github.com/Glavin001/atom-beautify/issues/47 for more details.
Configuration
Edit your .jsbeautifyrc
file in any of the following locations:
- Atom Package Settings
Atom
➔Preferences
➔ Search foratom-beautify
- Same directory as current file
- Project root
atom-beautify
will recursively look up from the current file's directory to find.jsbeautifyrc
. - Your User's Home directory
Note: Comments are supported in .jsbeautifyrc
thanks to strip-json-comments.
See examples of both way inside examples/
Simple
See examples/simple-jsbeautifyrc/.jsbeautifyrc.
{
"indent_size": 2,
"indent_char": " ",
"other": " ",
"indent_level": 0,
"indent_with_tabs": false,
"preserve_newlines": true,
"max_preserve_newlines": 2,
"jslint_happy": true,
"indent_handlebars": true
}
Nested
See examples/nested-jsbeautifyrc/.jsbeautifyrc.
{
"html": {
"brace_style": "collapse",
"indent_char": " ",
"indent_scripts": "normal",
"indent_size": 6,
"max_preserve_newlines": 1,
"preserve_newlines": true,
"unformatted": ["a", "sub", "sup", "b", "i", "u"],
"wrap_line_length": 0
},
"css": {
"indent_char": " ",
"indent_size": 4
},
"js": {
"indent_size": 2,
"indent_char": " ",
"indent_level": 0,
"indent_with_tabs": false,
"preserve_newlines": true,
"max_preserve_newlines": 2,
"jslint_happy": true
},
"sql": {
"indent_size": 4,
"indent_char": " ",
"indent_level": 0,
"indent_with_tabs": false
}
}
Advanced Language Setup
PHP
To use with PHP we require PHP_Beautifier
and that you set the Php beautifier path
in the package settings.
Retrieve the path on Mac & Linux
Run which php_beautifier
in your Terminal.
Python
To use with Python we require autopep8
and that you set the Python autopep8 path
in the package settings.
Retrieve the path on Mac & Linux
Run which autopep8
in your Terminal.
Contributing
See all contributors on GitHub.
Please update the CHANGELOG.md, add yourself as a contributor to the package.json, and submit a Pull Request on GitHub.