Update steps for running Prettier on save in WebStorm (#7978)

* Updated WebStorm configuration

* Minor edits in WebStorm docs

* Removed trailing spaces

* #4320: add paths for the global installation to the WebStorm docs

* Update steps for running Prettier on save in WebStorm

* Update the link for WebStorm on the main page

* fix markdown linting errors, `prettier` → Prettier

Co-authored-by: Ekaterina.Prigara <ekaterina.prigara@MUNIT-289.fritz.box>
Co-authored-by: Georgii Dolzhykov <thorn.mailbox@gmail.com>
This commit is contained in:
authored and GitHub committed 2020-04-10 13:25:25 +03:00
1 parent 785a4f02e8
commit 6dcd73bcd0
2 files changed
+14 -12

No files matched your search

+13 -11
View File
@@ -3,19 +3,23 @@ id: webstorm
title: WebStorm Setup
---
## WebStorm 2018.1 and above
## Using Prettier in WebStorm
Use the `Reformat with Prettier` action (`Alt-Shift-Cmd-P` on macOS or `Alt-Shift-Ctrl-P` on Windows and Linux) to format the selected code, a file, or a whole directory.
Don't forget to install `prettier` first.
To run Prettier on save in WebStorm 2020.1 or above, open _Preferences | Languages & Frameworks | JavaScript | Prettier_ and enable the option `Run on save for files`.
By default, only JavaScript and TypeScript files will be formatted automatically. You can further configure what files will be updated using the [glob pattern](https://github.com/isaacs/node-glob#glob-primer).
Don't forget to install Prettier first.
To use Prettier in IntelliJ IDEA, PhpStorm, PyCharm, and other JetBrains IDEs, please install this [plugin](https://plugins.jetbrains.com/plugin/10456-prettier).
For older IDE versions, please follow the instructions below.
To run Prettier on save in older IDE versions, you can set up a file watcher following the instructions below.
## Running Prettier on save using File Watcher
To automatically format your files using `prettier` on save, you can use a [File Watcher](https://plugins.jetbrains.com/plugin/7177-file-watchers).
To automatically format your files using Prettier on save in WebStorm 2019.\* or earlier, you can use a [File Watcher](https://plugins.jetbrains.com/plugin/7177-file-watchers).
Go to _Preferences | Tools | File Watchers_ and click **+** to add a new watcher.
@@ -24,26 +28,24 @@ In Webstorm 2018.2, select Prettier from the list, review the configuration, add
In older IDE versions, select Custom and do the following configuration:
- **Name**: _Prettier_ or any other name
- **File Type**: _JavaScript_ (or _Any_ if you want to run `prettier` on all files)
- **File Type**: _JavaScript_ (or _Any_ if you want to run Prettier on all files)
- **Scope**: _Project Files_
- **Program**: full path to `.bin/prettier` or `.bin\prettier.cmd` in the project's `node_module` folder. Or, if Prettier is installed globally, select `prettier` on macOS and Linux or `C:\Users\user_name\AppData\Roaming\npm\prettier.cmd` on Windows (or whatever `npm prefix -g` returns).
- **Arguments**: `--write [other options] $FilePathRelativeToProjectRoot$`
- **Output paths to refresh**: `$FilePathRelativeToProjectRoot$`
- **Working directory**: `$ProjectFileDir$`
- **Environment variables**: add `COMPILE_PARTIAL=true` if you want to run `prettier` on partials (like `_component.scss`)
- **Environment variables**: add `COMPILE_PARTIAL=true` if you want to run Prettier on partials (like `_component.scss`)
- **Auto-save edited files to trigger the watcher**: Uncheck to reformat on Save only.
![Example](/docs/assets/webstorm/file-watcher-prettier.png)
## WebStorm 2017.3 or earlier
### Using Prettier with ESLint
## Using Prettier with ESLint
If you are using ESLint with [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier), use the `Fix ESLint Problems` action to reformat the current file – find it using _Find Action_ (`Cmd/Ctrl-Shift-A`) or [add a keyboard shortcut](https://www.jetbrains.com/help/webstorm/configuring-keyboard-shortcuts.html) to it in _Preferences | Keymap_ and then use it.
Make sure that the ESLint integration is enabled in _Preferences | Languages & Frameworks | JavaScript | Code Quality Tools | ESLint_.
### Using Prettier as External Tool
## Using Prettier as External Tool
Go to _Preferences | Tools | External Tools_ and click **+** to add a new tool. Let’s name it **Prettier**.
@@ -57,6 +59,6 @@ Go to _Preferences | Tools | External Tools_ and click **+** to add a new tool.
Press `Cmd/Ctrl-Shift-A` (_Find Action_), search for _Prettier_, and then hit `Enter`.
It will run `prettier` for the current file.
It will run Prettier for the current file.
You can [add a keyboard shortcut](https://www.jetbrains.com/help/webstorm/configuring-keyboard-shortcuts.html) to run this External tool configuration in _Preferences | Keymap_.
+1 -1
View File
@@ -34,4 +34,4 @@
- image: /images/editors/editor_webstorm.svg
name: WebStorm
content: |
[Built-in support](https://plugins.jetbrains.com/plugin/10456-prettier)
[Built-in support](https://prettier.io/docs/en/webstorm.html)