2016-07-02 16:28:01 -06:00
# :lipstick: [{{package.name}}](https://github.com/Glavin001/atom-beautify)
2017-11-03 20:20:36 -06:00
[](https://atom.io/packages/atom-beautify)
2017-04-15 11:31:55 -06:00
[](https://github.com/Glavin001/atom-beautify/stargazers)
2018-03-30 10:06:33 -06:00
[](https://github.com/Glavin001/atom-beautify/issues)
[](https://greenkeeper.io/)
2018-05-30 17:32:35 -06:00
[](https://unibeautify-slack.glitch.me/)
2018-03-30 10:06:33 -06:00
[](https://twitter.com/unibeautify)
2017-04-15 11:31:55 -06:00
[](https://gitter.im/Glavin001/atom-beautify)
[](https://www.bountysource.com/teams/atom-beautify)
[](https://www.paypal.com/cgi-bin/webscr?cmd=_donations& business=X2RK5DKN6YXPJ& lc=CA& item_name=Atom%2dBeautify& item_number=atom%2dbeautify& currency_code=CAD& bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted)
2016-07-02 16:28:01 -06:00
2018-09-27 19:54:57 -06:00
<!--
2018-01-28 14:52:31 -07:00
**Sign up for Unibeautify CI: [https://goo.gl/jmM4QN ](https://goo.gl/jmM4QN )**
2018-09-27 19:54:57 -06:00
-->
2019-04-03 22:02:02 -06:00
:point_right: Sign up for [**CodePass**, *the Quickest Way To Solve Your Coding Errors* ](https://codepass.ca/ )! :boom:
2018-09-27 19:54:57 -06:00
[:tada: **Install Unibeautify CI for GitHub** :tada: ](https://github.com/apps/unibeautify-ci )
2018-01-17 19:50:48 -07:00
**Help improve Atom-Beautify by completing the quick questionnaire: [https://goo.gl/iEHBNr ](https://goo.gl/iEHBNr )**
2017-12-25 03:06:31 -07:00
2016-09-25 16:45:21 -06:00
| Mac OS < img src = "https://cloud.githubusercontent.com/assets/1885333/17059766/2530c9d8-4ffd-11e6-9529-3fa47dbff616.png" width = "50px" > and < img src = "https://cloud.githubusercontent.com/assets/1885333/17059750/11c4474e-4ffd-11e6-89e1-2486ca5b3234.png" width = "100px" > | < img src = "https://cloud.githubusercontent.com/assets/1885333/17059763/206a7d4a-4ffd-11e6-859e-7856902fb300.png" width = "100px" > |
2016-09-25 16:48:16 -06:00
| --- | --- |
2017-10-07 09:45:13 -06:00
| [Travis CI: ](https://travis-ci.org/Glavin001/atom-beautify) | [AppVeyor: ](https://ci.appveyor.com/project/Glavin001/atom-beautify/branch/master) |
2016-07-02 16:28:01 -06:00
[](https://waffle.io/Glavin001/atom-beautify/metrics)
> {{package.description}}
| Before | After |
| --- | ---- |
| Original HTML | Beautified HTML |
2016-07-04 20:42:22 -06:00
|  |  |
2016-07-02 16:28:01 -06:00
## Table of Contents
- [Installation ](#installation )
2017-04-09 23:53:34 -06:00
- [Beautifiers ](#beautifiers )
2016-07-02 16:28:01 -06:00
- [Language Support ](#language-support )
- [Usage ](#usage )
2017-05-06 14:26:34 -06:00
- [Command Palette ](#command-palette )
- [Beautify a Specific Language ](#beautify-a-specific-language )
2016-07-02 16:28:01 -06:00
- [Selection of Code ](#selection-of-code )
- [Beautify On Save ](#beautify-on-save )
- [Keyboard Shortcut ](#keyboard-shortcut )
- [Custom Keyboard Shortcuts ](#custom-keyboard-shortcuts )
- [Configuration ](#configuration )
- [Simple ](#simple )
- [Nested ](#nested-recommended )
- [Troubleshooting ](#troubleshooting )
- [Contributing ](#contributing )
## Installation
Atom Package: https://atom.io/packages/atom-beautify
```bash
apm install atom-beautify
```
2017-10-29 16:41:20 -06:00
Or Settings/Preferences ➔ Install ➔ Search for `atom-beautify`
2016-07-02 16:28:01 -06:00
2018-09-27 19:54:57 -06:00
[:tada: **Install Unibeautify CI for GitHub** :tada: ](https://github.com/apps/unibeautify-ci )
2016-08-25 22:32:59 -06:00
### Important Notice: Analytics
2017-04-20 08:01:18 -06:00
[Atom-Beautify respects the `core.telemetryConsent` configuration option from Atom editor. ](https://github.com/Glavin001/atom-beautify/issues/1179 )
If you do not wish to have usage data sent to Google Analytics then please set `core.telemetryConsent` to `no` or `undecided` option before using Atom-Beautify.
2016-10-08 03:25:44 -06:00
See [`Anonymous Analytics` section of docs ](docs/options.md#anonymous-analytics ) for details.
2016-08-25 22:32:59 -06:00
Thank you.
2017-04-20 08:01:18 -06:00
| On Atom Load | Change Setting Later |
| --- | --- |
|  |  |
2016-09-25 22:12:16 -06:00
### Next Version: [Unibeautify](https://github.com/Unibeautify/unibeautify)
Atom-Beautify is going to be completely rewritten with [Unibeautify ](https://github.com/Unibeautify/unibeautify ) at its core!
2016-10-08 03:25:44 -06:00
See [`unibeautify` branch ](../../tree/unibeautify ) for work in progress and [Issue #1174 ](https://github.com/Glavin001/atom-beautify/issues/1174 ).
2016-09-25 22:12:16 -06:00
2018-09-27 19:54:57 -06:00
[:tada: **Install Unibeautify CI for GitHub** :tada: ](https://github.com/apps/unibeautify-ci )
2017-12-25 01:55:19 -07:00
### Poll: Improving installation of third-party beautifiers
Many users are experiencing issues when installing third party beautifiers (e.g. Uncrustify, PHP-CS-Fixer, and many more).
A possible solution is a "cloud" service which provides remote access to these beautifiers. Atom-Beautify would then communicate with these services, allowing for zero-installation beautification.
Please let us know what you think!
[](https://m131jyck4m.execute-api.us-west-2.amazonaws.com/prod/poll/01BY57P9ACSDQASVT7KYZKZESK/Yes%2C%20cloud%20solution%20would%20be%20great!/vote)
[](https://m131jyck4m.execute-api.us-west-2.amazonaws.com/prod/poll/01BY57P9ACSDQASVT7KYZKZESK/No%2C%20I%20enjoy%20manually%20installing%20beautifiers/vote)
[](https://m131jyck4m.execute-api.us-west-2.amazonaws.com/prod/poll/01BY57P9ACSDQASVT7KYZKZESK/No%2C%20I%20am%20happy%20using%20Docker/vote)
[](https://m131jyck4m.execute-api.us-west-2.amazonaws.com/prod/poll/01BY57P9ACSDQASVT7KYZKZESK/No%2C%20I%20do%20not%20want%20to%20send%20me%20code%20over%20the%20Internet/vote)
2017-04-09 23:53:34 -06:00
## Beautifiers
Some of the supported beautifiers are developed for Node.js and are automatically installed when Atom-Beautify is installed. However, other beautifiers are command-line interface (CLI) applications and require you to manually install them.
{{beautifiers-info beautifiers}}
2016-09-25 22:12:16 -06:00
2016-07-02 16:28:01 -06:00
## Language Support
2016-10-08 03:25:44 -06:00
See [all supported options in the documentation at `docs/options.md` ](docs/options.md ).
2016-07-02 16:28:01 -06:00
{{language-beautifiers-support languageOptions}}
## Usage
2017-05-06 14:26:34 -06:00
### Command Palette
2016-07-02 16:28:01 -06:00
Open the [Command Palette ](https://github.com/atom/command-palette ), type `Beautify` , and run `Beautify Editor` .
2017-05-06 14:26:34 -06:00
#### Beautify a Specific Language
You can use the [Command Palette ](https://github.com/atom/command-palette ) to beautify the editor for a specific language.
The commands are in the form `Atom Beautify: Beautify Language {NAME}` (i.e. `atom-beautify:beautify-language-{NAME}` for keyboard shortcuts).
For example, you may want to beautify `JavaScript` code within a `HTML` file.
2016-07-02 16:28:01 -06:00
### Selection of Code
It will only beautify selected text if a selection is found -- if not, the whole file will be beautified.
| Selection of Code | Beautify Selection of Code | Beautify Entire File |
| --- | --- | --- |
| Select code in Atom editor | Only that selection is beautified | Without a selection all code is beautified |
|  |  |  |
### Beautify On Save
`Beautify On Save` can be enabled for each language individually.
For example, for language `HTML` go into Atom-Beautify's package settings (`Atom` ➔ `Preferences` ➔ Search for `atom-beautify` ), find `HTML` , and toggle the `Beautify On Save` option.
### Keyboard Shortcut
You can also type < kbd > Ctrl</ kbd > -< kbd > Alt</ kbd > -< kbd > B</ kbd > as a shortcut or click `Packages > Beautify` in the menu.
#### Custom Keyboard Shortcuts
See [Keymaps In-Depth ](https://atom.io/docs/latest/behind-atom-keymaps-in-depth ) for more details.
For example:
```coffeescript
'.editor':
'ctrl-alt-b': 'atom-beautify:beautify-editor'
```
## Configuration
Edit your `.jsbeautifyrc` file in any of the following locations:
2016-10-08 03:25:44 -06:00
- Atom Package Settings
2016-07-02 16:28:01 -06:00
`Atom` ➔ `Preferences` ➔ Search for `atom-beautify`
- Same directory as current file
2016-10-08 03:25:44 -06:00
- Project root
2016-07-02 16:28:01 -06:00
`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](https://github.com/sindresorhus/strip-json-comments).*
2016-10-08 03:25:44 -06:00
See examples of both ways inside [`examples/` ](examples )
2016-07-02 16:28:01 -06:00
2016-10-08 03:25:44 -06:00
See [all supported options in the documentation at `docs/options.md` ](docs/options.md ).
2016-07-02 16:28:01 -06:00
### Simple
2016-10-08 03:25:44 -06:00
See [examples/simple-jsbeautifyrc/.jsbeautifyrc ](examples/simple-jsbeautifyrc/.jsbeautifyrc ).
2016-07-02 16:28:01 -06:00
```json
{
"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 (Recommended)
2016-10-08 03:25:44 -06:00
See [examples/nested-jsbeautifyrc/.jsbeautifyrc ](examples/nested-jsbeautifyrc/.jsbeautifyrc ).
2016-07-02 16:28:01 -06:00
```json
{
"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
}
}
```
## Troubleshooting
2016-10-08 03:25:44 -06:00
See [`docs/troubleshooting.md` ](docs/troubleshooting.md ).
2016-07-02 16:28:01 -06:00
## Contributing
2017-11-03 20:20:36 -06:00
See [`CONTRIBUTING.md` ](CONTRIBUTING.md ).
2016-10-08 03:25:44 -06:00
[See all contributors on GitHub ](../../graphs/contributors ).
2016-07-02 16:28:01 -06:00
2016-10-08 03:25:44 -06:00
Please update the [CHANGELOG.md ](CHANGELOG.md ),
add yourself as a contributor to the [package.json ](package.json ),
2016-07-02 16:28:01 -06:00
and submit a [Pull Request on GitHub ](https://help.github.com/articles/using-pull-requests/ ).
## License
2016-10-08 03:25:44 -06:00
[MIT ](LICENSE.md ) © [Glavin Wiechert ](https://github.com/Glavin001 )
