PyCharm 2018.2 Help

Prettier

PyCharm integrates with the Prettier code formatter. You can reformat selected code fragments as well as entire files or directories using the Reformat with Prettier action. PyCharm adds this action as soon as you install Prettier as a dependency in your project or globally on your machine, Prettier is available in .js, .ts, .css, .less, .scss, .vue, and .json files.

Moreover, the key code style rules from the Prettier's configuration are applied to the PyCharm Code Style settings. As a result, generated code (e.g. after refactoring or quick-fix) and the code that is already processed with Prettier are formatted consistently.

Before you start

  1. Download and install Node.js.

  2. Install and enable the Prettier repository plugin on the Plugins page as described in Managing Plugins.

To install Prettier

  1. Open the embedded Terminal (View | Tool Windows | Terminal or Alt+F12).

  2. At the command prompt, type npm install --save-dev --save-exact prettier or npm install --global prettier. Learn more about installation modes from the Prettier Official website.

To configure Prettier in PyCharm

  1. In the Settings/Preferences dialog (Ctrl+Alt+S), click JavaScript under Languages and Frameworks, and then click Prettier.

  2. On the Prettier page, that opens, specify the path to the prettier package and choose the Node.js interpreter to use. This can be a local Node.js interpreter or a Node.js on Windows Subsystem for Linux.

To reformat code with Prettier

  • Select the code fragment to reformat in the editor or select a file or a folder in the Project tool window and press N/A or choose Reformat with Prettier on the context menu of the selection.

  • Alternatively, press Ctrl+Shift+A and click Reformat with Prettier in the Find Action pop-up list:

    ws_reformat_with_prettier_js.png

Last modified: 12 October 2018

See Also

Procedures: