AppCode 2020.2 Help

Prettier

Prettier is a tool to format .js, .ts, .css, .less, .scss, .vue, and .json code. With AppCode, you can format selected code fragments as well as entire files or directories using the Reformat with Prettier action. AppCode adds this action as soon as you install Prettier as a dependency in your project or globally on your computer.

You can configure Prettier to reformat specific files every time such file is changed and the changes are saved automatically or manually.

Also, Prettier can be set as default formatter for specific files. It will run against such files every time you reformat your code with ⌃⌥L.

See Reformat code with Prettier for details.

Before you start

  1. Make sure you have Node.js on your computer.

  2. Install and enable the Prettier plugin on the Settings/Preferences | Plugins page as described in Installing plugins from JetBrains repository.

Install and configure Prettier in AppCode

  1. In the embedded Terminal (⌥F12) , type one of the following commands:

    • npm install --save-dev --save-exact prettier

    • npm install --global prettier

    Learn more about installation modes from the Prettier official website.

  2. In the Preferences dialog ⌃⌥S, go to Languages and Frameworks | JavaScript | Prettier.

  3. Choose the Node.js interpreter to use. If you choose the Project alias, AppCode will automatically use the project default interpreter from the Node interpreter field on the Node.js and NPM page .

    In most cases, AppCode detects the project default interpreter and fills in the field itself. You can also choose another configured local interpreter or click the Browse button and configure a new one.

  4. From the Prettier package list, select the prettier installation to use.

  5. To run Prettier automatically against specific files, open the Preferences dialog ⌃⌥S, go to Languages and Frameworks | JavaScript | Prettier, and use the On code reformatting and On save checkboxes to specify the actions that will trigger Prettier.

    For details, see Run Prettier automatically on save and Set Prettier as default formatter.

Reformat code with Prettier

  1. In the editor, select the code fragment to reformat. To reformat a file or a folder, select it in the Project tool window.

  2. Then select Reformat with Prettier from the context menu.

You can configure Prettier to reformat specific files every time such file is changed and the changes are saved automatically or manually.

Also, Prettier can be set as default formatter for specific files. It will run against such files every time you reformat your code with ⌃⌥L.

This behaviour can be enabled in the current project as well as for all new projects.

Run Prettier automatically on save

  1. Open the Preferences dialog ⌃⌥S, go to Languages and Frameworks | JavaScript | Prettier, and select the On save checkbox.

  2. In the Run for files field, specify the pattern that defines the set of files to be reformatted every time such file is saved. You can accept the default pattern or type a custom one.

    With the default pattern, {**/*,*}.{js,ts,jsx,tsx}, Prettier will wake up and process any updated and saved JavaScript, TypeScript, JSX, or TSX file. To reformat files of other types or files stored in specific folders, use glob patterns to update the default pattern.

    • For example, to automatically reformat Style Sheet files as well, add css,sass,scss to the default pattern as follows:

      {**/*,*}.{js,ts,jsx,tsx,css,scss,sass}
    • To reformat files from a specific folder, replace {**/*,*} with <path to the folder>*.

      Suppose, you have a project with the following structure:

      Prettier: custom patterns. Example project structure

      To apply Prettier automatically only to the files in the src folder, update the pattern as follows:

      src/*.{js,ts,jsx,tsx}

      As a result, the file dog.ts will be reformatted on save while animal.ts will remain unchanged.

Set Prettier as default formatter

  1. Open the Preferences dialog ⌃⌥S, go to Languages and Frameworks | JavaScript | Prettier, and select the On code reformat checkbox.

  2. In the Run for files field, specify the pattern that defines the set of files to be always reformatted with Prettier. Accept the default pattern or customize it as described in Run Prettier automatically on save.

Configure Prettier to run on save or on reformat in new projects

  1. From the main menu, select File | New Projects Settings | Preferences for New Projects. In the dialog that opens, go to Languages and Frameworks | JavaScript | Prettier.

  2. Use the On code reformatting and On save checkboxes to specify the actions that will trigger Prettier.

  3. If necessary, update the default pattern in the Run for files field as described in Run Prettier automatically on save.

Apply Prettier code style rules

AppCode can apply the key code style rules from the Prettier's configuration to the AppCode Code Style settings so that generated code (for example, after refactoring or quick-fix) and the code that is already processed with Prettier are formatted consistently.

  • In the project where Prettier is enabled, open package.json and click Yes in the pane at the top of the tab.

    Pane above package.json: apply Prettier code style
  • To re-apply the Prettier code style (after you've clicked No in the pane or modified the code style), press ⌃⇧A and select Apply Prettier Code Style Rules from the Find Action list.

Learn more about configuring Prettier code style rules from the Prettier official website.

Last modified: 23 June 2020