Skip to content
This repository has been archived by the owner on Apr 17, 2023. It is now read-only.

prettier/prettier-atom

Repository files navigation

Prettier for Atom Watch on GitHubStar on GitHubTweet

Version Downloads Build Status Code Coverage MIT License All Contributors PRs Welcome

Atom package to format your code using Prettier.

prettier demo

Problems with Latest Release (v0.55.0)?

We have recently switched to deferring most options to Prettier via a .prettierrc (or similar) file instead of specifying your options via the Atom package. This is to accommodate Prettier "plugins" which introduce all sorts of new functionality but can't work with the old paradigm.

However, this requires Prettier v1.13.4 or greater. If you are not ready to migrate, you can revert prettier-atom like this:

apm install prettier-atom@0.54.0

Installation

apm install prettier-atom

Or go to Settings โ†’ Install and search for prettier-atom.

Make sure to restart Atom after the package is installed.

How to use

There are two ways to format your code:

  • Automatically format on save (requires enabling in Packages โ†’ Prettier โ†’ Toggle Format on Save)
  • Run the command Prettier: Format to invoke Prettier manually
    • Windows/Linux: ctrl + alt + f
    • Mac: control + option + f

Prettier will search up the file tree looking for a prettier config to use. If none is found, Prettier will use its default settings.

Prettier will also respect your .prettierignore file.

What version of Prettier gets used?

By default, we use the prettier instance in your project's node_modules directory. We highly recommend adding Prettier to your dependencies so that your team, CI tooling, and any scripts using Prettier all format code exactly the same way.

If Prettier can't be found in your project's node modules, then we fall back to using the version that comes bundled with the prettier-atom package (version changes are documented in the CHANGELOG).

Configuring default rules

Some users may not wish to create a new Prettier config for every project. Because Prettier searches recursively up the filepath, you can place a global prettier config at ~/.prettierrc to be used as a fallback.

Using ESLint

prettier-eslint demo

There are three ways to use ESLint with Prettier and prettier-atom:

1. Use ESLint to run Prettier

You can opt not to use prettier-atom and instead configure ESLint to run prettier. (see details)

2. Turn off ESLint's Formatting Rules

You can disable ESLint rules for things that Prettier itself fixes. This allows both tools to run alongside each other without conflicting with one another. (see details)

3. Use prettier-eslint

The prettier-eslint package (shipped with prettier-atom) will recursively search up the file tree for your ESLint settings and infer the corresponding Prettier settings to use when formatting. After formatting, prettier-eslint will invoke ESLint to fix remaining issues. Check the "ESLint Integration" checkbox to enable.

Note: If you are using the linter-eslint package alongside prettier-atom, please ensure you have unchecked its "Fix on save" checkbox. Leaving it enabled will cause a race condition between prettier-atom and linter-eslint. After it has finished formatting your code, prettier-atom will automatically invoke the linter package's lint command for you.

Using Stylelint

The prettier-stylelint package (shipped with prettier-atom) derives prettier settings from your stylelint configuration to use when formatting. After formatting, prettier-stylelint will invoke Stylelint to fix remaining issues. Check the "Stylelint Integration" checkbox to enable.

Note: prettier-atom automatically detects when you are in an Atom scope that stylelint supports and switches to using it instead of normal Prettier when formatting that file.

Troubleshooting formatting problems

If Prettier is not formatting something properly, please open an issue on the Prettier repository, not this repository.

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

๐Ÿ’ป

David Singleton

๐Ÿ“–

Chris Drackett

๐Ÿ’ป ๐ŸŽจ

Lewis Liu

๐Ÿ’ป โš ๏ธ

Chance Dickson

๐Ÿ’ป

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

LICENSE

MIT