prettier/prettier-atom

Name: prettier-atom

Owner: Prettier

Description: An atom package for the prettier formatter.

Created: 2017-01-10 04:47:01.0

Updated: 2018-01-18 12:54:31.0

Pushed: 2018-01-17 22:40:57.0

Homepage: null

Size: 1621

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Prettier for Atom

Atom package to format your JavaScript, Typescript, CSS, Sass, and JSON using Prettier. Comes with powerful optional ESLint integration.

Demo

Installation

install prettier-atom

Or go to Settings ? Install and search for prettier-atom.

Make sure to restart Atom after the package is installed.

Usage

There are two modes you can use:

• Invoke manually using the keyboard shortcut (if no selection, whole file is formatted): CTRL + ALT + F
• Automatically format on save (requires enabling in Packages ? Prettier ? Toggle Format on Save)

If you use ESLint, check the “ESLint Integration” checkbox and *poof*, everything should work (we use Kent Dodds's prettier-eslint plugin under the hood). We will recursively search up the file tree for your package.json and ESLint settings, and use them when formatting.

More detailed descriptions of each option can be found in the Atom settings for this plugin.

Please open a pull request or file an issue if you notice bugs or something doesn't work as it should!

Troubleshooting

If Prettier (or prettier-eslint, if ESLint integration is enabled) is not formatting something properly, please open an issue on the relevant GitHub repository. This package is only integrating those projects to be used in Atom.

Inspiration

This repository was created by James Long to go along with his Prettier project. Kent C. Dodds extended Prettier to add eslint --fix integration as prettier-eslint and forked the original prettier-atom plugin to create the prettier-eslint-atom plugin. Because it became clear that the plugins were very similar and thus maintenance made easier by combining the two, Rob Wise merged prettier-eslint-atom back into prettier-atom.

Maintainers

Rob Wise

Contributors

Thanks goes to these people (emoji key):

|
_{James Long}
? ? ? ? ? |
_{Rob Wise}
? ? ? ? ? ?? |
_{Kent C. Dodds}
? ? ? |
_{Luca Barone}
|
_{Arnar Þór Sveinsson}
? |
_{Adam Miskiewicz}
? |
_{Ori Livni}
? | | :—: | :—: | :—: | :—: | :—: | :—: | :—: | |
_{Leon Chen}
? |
_{Christopher Chedeau}
? ? ? |
_{Christoph Geschwind}
? |
_{Andrew Hutchings}
? |
_{David Schnurr}
? |
_{Ryan Cole}
? |
_{Dara Hak}
? ? | |
_{Stephen John Sorensen}
? |
_{Lukas Geiger}
? ?? |
_{Viktor Charypar}
? ?? |
_{Mats Högberg}
? |
_Roman
? |
_vaibhav
? |
_{Karl Horky}
? | |
_{Dan Abramov}
? |
_{Murphy Randle}
? ? |
_{Matthieu Lemoine}
? |
_{Ron Green}
? |
_{Harold Treen}
? ? |
_{Nikita Mashukov}
? |
_{Sam Horton}
? ?? | |
_olsonpm
? |

This project follows the all-contributors specification. Contributions of any kind are welcome!

LICENSE

MIT