📣 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 ❤️ )

atom beautifier beautify coffeescript formatter prettifier prettify

Go to file

Glavin Wiechert 66933d9a69 Closes #29 . Improved the package.json Including: - Keywords - Contributors - Bugs URL		2014-06-14 20:20:32 -03:00
examples	Fixes #9 . Nested options in .jsbeautifyrc are properly handled.	2014-06-14 19:57:55 -03:00
keymaps	refactored package, added keymaps and menus	2014-03-04 08:07:45 +01:00
lib	Fixes #9 . Nested options in .jsbeautifyrc are properly handled.	2014-06-14 19:57:55 -03:00
menus	refactored package, added keymaps and menus	2014-03-04 08:07:45 +01:00
spec	refactored package, added keymaps and menus	2014-03-04 08:07:45 +01: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	first release of atom-beautify, add support for 'indent_size' and 'indent_char' for HTML/CSS/JS	2014-03-03 08:51:16 +01:00
CHANGELOG.md	Updated CHANGELOG, version bump to 0.2.6	2014-05-15 11:37:20 +02:00
LICENSE.md	refactored package, added keymaps and menus	2014-03-04 08:07:45 +01:00
README.md	Closes #29 . Improved the package.json	2014-06-14 20:20:32 -03:00
package.json	Closes #29 . Improved the package.json	2014-06-14 20:20:32 -03:00

README.md

atom-beautify

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

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

Language Support

JavaScript and JSON
HTML, including
- Handlebars
- XML
CSS, including
- Sass
- LESS
SQL, special thanks to pretty-data

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.

Package Options

You can also choose to beautify on every file save.

Configuration

Edit your .jsbeautifyrc file in any of the following locations:

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
  }
}

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.