📣 Help Wanted - Looking for Maintainer: https://github.com/Glavin001/atom-beautify/issues/2572 | 💄 Universal beautification package for Atom editor (⚠️ Currently migrating to https://github.com/Unibeautify/ and have very limited bandwidth for Atom-Beautify Issues. Thank you for your patience and understanding ❤️ )
Go to file
Glavin Wiechert a10b363884 Prepare 0.22.5 release 2015-03-20 14:06:58 -03:00
examples See #216 and #122. Add another Titanium Style Sheet (disabled) test 2015-03-16 02:27:49 -03:00
keymaps Fixes #177. Update keybinding to beautify:beautify-editor 2015-01-06 11:40:02 -04:00
lib Fixes #245, fixes #180. Add Preserve new lines support for LESS/SCSS 2015-03-20 14:06:02 -03:00
menus Fixes #240. Change Debug command name to make `beautify editor` first 2015-03-20 13:33:17 -03:00
spec Added support Marko templates. 2015-02-21 12:27:39 -08:00
styles Fix incorrectly named directory for Stylesheets. 2015-02-02 12:42:33 -04:00
.editorconfig add .editorconfig 2014-03-05 08:00:00 +01:00
.gitignore refactored package, added keymaps and menus 2014-03-04 08:07:45 +01:00
.jsbeautifyrc Allowing either flat or nested .jsbeautifyrc schemas 2014-05-18 12:47:56 -07:00
.jshintrc Closes #47. Switch Analytics from Google Analytics to Segment.io 2014-08-03 16:12:07 -04:00
.travis.yml Added support Marko templates. 2015-02-21 12:27:39 -08:00
CHANGELOG.md Add commit link to v0.21.4 CHANGELOG 2015-03-08 12:52:19 -03:00
LICENSE.md refactored package, added keymaps and menus 2014-03-04 08:07:45 +01:00
README.md Add donation information 2015-03-15 22:46:31 -03:00
build-package.sh Update Travis CI build script. 2015-02-08 22:10:46 -04:00
package.json Prepare 0.22.5 release 2015-03-20 14:06:58 -03:00

README.md

atom-beautify

Build Status Gitter chat Issue Stats Issue Stats

Beautify HTML (including Handlebars), CSS (including Sass and LESS), JavaScript, and much more in Atom.

Atom Package: https://atom.io/packages/atom-beautify

apm install atom-beautify

Or Settings/Preferences ➔ Packages ➔ Search for atom-beautify

Donations donate

Looking at the list of issues on Atom Beautify, at the time of writing this, there are 51 open and 155 closed. I see and strongly feel that Atom Beautify needs a more love than I currently have allocated time to give it, after work, school, and family.

I am now accepting donations to support the development of Atom Beautify. Being the sole maintainer of Atom Beautify, I thank you very much for any support and for using Atom Beautify.

These donations will help me continue with my contributions to the community while providing me with some much needed financial support for living expenses and my education.

You can donate at https://gratipay.com/Glavin001/

Thank you. Glavin Wiechert

Language Support

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':
  'ctrl-alt-b': 'beautify:beautify-editor'

Package Options

  • beautifyOnSave (Default false) You can also choose to beautify on every file save.

  • beautifyEntireFileOnSave (Default true) Beautification will normally only beautify your selected text. However, when beautification occurs on save then it will be forced to beautify the entire file's contents, not just selected text.

  • disabledLanguages (Default empty array) An array of Grammar names to disable beautification for. Note: If using the Atom's Package Settings then an array is represented as comma-separated string.

  • muteUnsupportedLanguageErrors (Default false) Mute only unsupported language errors.

  • muteAllErrors (Default false) Do not show the Atom Beautify Error Messages panel for any of the errors occurring while beautifying.

  • analytics (Default true) There is Segment.io, which forwards the data to 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. 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
    AtomPreferences ➔ Search for atom-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/

Option table is available at the js-beautify repo.

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.

Markdown

To use with Markdown we require pandoc and you set the Markdown Pandoc path in the package settings.

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.

License

MIT © Donald Pipowitch