How to use it
- Enable 'format on save' to have prettier format your code upon saving
- Run the command
Prettier: Formatto format your file manually
- Windows/Linux: ctrl + alt + f
- Mac: control + option + f
- By default, formatting will use your prettier configuration. Otherwise it falls back to the prettier settings you chose in this plugin.
apm install prettier-atom
Or go to Settings → Install and search for
Make sure to restart Atom after the package is installed.
Note: not every
prettier-atom setting is explained below. You can explore them all in the plugin settings page.
How to Format
There are two modes you can use:
- Automatically format on save (requires enabling in Packages → Prettier → Toggle Format on Save)
- Invoke manually using the keyboard shortcut (if no selection, whole file is formatted): CTRL + ALT + F
What Version of Prettier Gets used?
By default, we use the prettier instance in your project's 'node_modules' directory. If one isn't found, then we fall back to using the version that comes bundled with the prettier-atom package.
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.
Support is built into prettier. It derives prettier settings from your
.editorconfig file and formats accordingly.
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!
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.
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
Thanks goes to these people (emoji key):
💬 💻 📖 🔌 👀 |
💻 📖 💬 💡 👀 ⚠️ |
Kent C. Dodds
💻 📖 🚇 |
Arnar Þór Sveinsson
💻 | | :---: | :---: | :---: | :---: | :---: | :---: | :---: | |
💬 💻 🔌 |
💻 📖 | |
Stephen John Sorensen
💻 ⚠️ |
💻 ⚠️ |
💻 | |
💻 🐛 |
🐛 💻 |
💻 ⚠️ | |
This project follows the all-contributors specification. Contributions of any kind are welcome!