389

In my Nuxt application where ESlint and Prettier are installed and enabled, I switched to Visual Studio Code.

When I open a .vue file and press CMD+ Shift + P and choose Format Document, my file does not get formatted at all.

My .prettierrc settings:

{
  "tabWidth": 2,
  "semi": false,
  "singleQuote": true
}

I have so many source code lines, so I cannot format them manually. What am I doing wrong?

Paul Whelan
  • 16,334
  • 12
  • 49
  • 81
Billal Begueradj
  • 17,880
  • 38
  • 105
  • 123
  • 5
    Seems that prettier by default has [prettier.disableLanguages](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode#user-content-prettier.disablelanguages-(default%3A-%5B%22vue%22%5D)) set to `["vue"]` – barbsan Oct 01 '18 at 08:25
  • I'd add to `.prettierrc` line `"disableLanguages": []`. Docs says that this change requires restart – barbsan Oct 01 '18 at 08:34
  • 2
    There's also [issue](https://github.com/prettier/prettier-vscode/issues/590) for v1.27.2 with note that the same config worked for v.1.23 – barbsan Oct 01 '18 at 09:41
  • Indeed, I have VSCode 1.27.2 – Billal Begueradj Oct 01 '18 at 09:43
  • 26
    Upvoted b/c just pressing `CMD`+ `Shift` + `P` then **Format Document**, then choosing Prettier as my default formatter helped me :D – Blundering Philosopher Oct 25 '19 at 09:59
  • If nothing works for you, be sure to check out my answer: https://stackoverflow.com/a/64273353/4298115 – lbragile Dec 17 '20 at 20:02
  • 2
    For me, it was not working even after making all the configuration setting changes. Then, I realized I was trying to format a code fragment `var x = "test";` written in HTML file when I should have written it in a `*.JS` file. When I wrote the JS code into a JS file it got formatted to `var x = 'test'`. – RBT Apr 08 '21 at 04:34
  • Try to **disable prettier** –> **reload vscode** -> **enable prettier** – Eugene P. Sep 19 '21 at 09:28

37 Answers37

853

How I've sorted it after having super huge frustrations with Prettier stopping working in VSCode.

  1. Select VS Code -> View -> Command Palette, and type: Format Document With
  2. Then Configure Default Formatter... and then choose Prettier - Code formatter.

This sorted the problem for me magically.

Depending on your case this might help you...

RobC
  • 20,007
  • 20
  • 62
  • 73
Miha
  • 9,313
  • 2
  • 12
  • 15
  • 6
    I did configure Prettier as std formatter in settings but it just would not work. This worked. Made my day! – Flummiboy Apr 28 '20 at 13:26
  • Same here, but I had to de-select my default formatter and then perform the action you mention again for this to work. – lmerino Oct 16 '20 at 15:51
  • 46
    Not sure where to find `Configure Default Formatter` but I used File->Settings->Text Editor->Default Formatter – wlf Oct 17 '20 at 12:49
  • 2
    When I select the default formatter as Prettier, it formats that file but after that it does not work on save. I have my save option checked but still. I had to select the default formatter again and again. Any Solution – Himanshu Tariyal Nov 28 '20 at 14:38
  • 2
    @HimanshuTariyal This should work for you, but feel free to check out my solution: https://stackoverflow.com/a/64273353/4298115 – lbragile Dec 17 '20 at 20:00
  • Is this some kind of issue in vscode? It worked for me as well – Arun Feb 21 '21 at 20:50
  • What about making prettier AND eslint make changes to the code? – goldylucks May 06 '21 at 18:20
  • @jrypkahauer this is basically [my answer](https://stackoverflow.com/a/68880413/8816585). ☺️ – kissu Sep 08 '21 at 20:54
  • My VSCode is suddenly adding a blank line at the end of file when I save. I have disabled all options to add a new line. I even uninstalled the `Prettier` extension. But it still keeps adding a new blank line at the end of file when I press `ctrl + s`. Does anyone know why? – CatarinaRuna Sep 20 '21 at 07:15
  • This works, however , only after a recent change in that document. if I write something , don't format yet and switch to another file and edit , then it will not format either of the files . in such case there is an option to create a nice keybind to force it. type Format Document (Forced) in command palette and configure keybindings , then press on the pen to edit a new key binding . – boaz levinson Jan 26 '22 at 08:07
416

If doing what @Simin Maleki mentioned does not solve it for you, there is a chance that your default formatter is not set:

File > Preferences > Settings > Search for "default formatter" 

Make sure your Editor: Default Formatter field is not null but rather esbenp.prettier-vscode and that all the languages below are ticked. This fixed my issue.

STEP BY STEP WALKTHROUGH

Steps to enable default formatter

Also make sure that your format on save is enabled:

Format on save check

lbragile
  • 5,985
  • 3
  • 20
  • 50
105

Sometimes, prettier stops working when there are syntactic errors in the code. You can view the errors by clicking on the x button on the bottom right corner beside Prettier

enter image description here

FacePalm
  • 9,286
  • 5
  • 44
  • 48
  • 5
    Sometimes Prettier won't show at the bottom, but another extension (eg. ESLint) will, and if you click on it there's a drop-down to pick other tools ... including Prettier. Pick it to see Prettier's log (and after that Prettier should show in the tray). – machineghost Dec 25 '19 at 23:19
  • 1
    Thank you so much! This took me two hours to try and figure out to no avail until I saw your answer. Something so simple. – Stephen Tafler Jan 20 '21 at 05:58
  • 1
    You saved my life. I forgot to put a dot before my config file so it was using VS Code configuration by default. – Mertcan Seğmen Feb 23 '21 at 14:20
  • 1
    I do not see `prettier` at the bottom right. I have `"editor.defaultFormatter": "esbenp.prettier-vscode",` and installed the ext. Want powershell format. – Timo Jun 06 '21 at 15:46
103

Prettier could also format your files on save.

However, installing and enabling does not result in working.

You have to check "format on Save" in VSCode: Setting >> User >> Text Editor >> Formatting

enter image description here

Norbert Bartko
  • 2,066
  • 1
  • 14
  • 29
Simin Maleki
  • 1,221
  • 1
  • 6
  • 11
46

You only have to configure your Default Formatter and check the checkbox in Format On Save in the settings, after installing prettier to make it work. Don't mess with other configuration files.

1 - Select Default Formatter

  1. Open Files -> Preferences -> Settings (or Ctrl + , in Windows).
  2. Search for Editor: Default Formatter
  3. Select your default formatter as Prettier - Code Formatter;

See the image below;

Default Formatter Capture

2 - Save On Format

  1. Open Files -> Preferences -> Settings (or Ctrl + , in Windows).
  2. Search for Editor: Format on Save
  3. Click the check box under Format On Save;

See the image below;

Format On Save Capture

Levent Divilioglu
  • 10,558
  • 5
  • 56
  • 104
44

disable and enable prettier extension solves my problem

Ymin Hu
  • 519
  • 4
  • 7
  • 1
    If all the other configs are right, this will do the trick. – OctaviaLo Jul 05 '21 at 05:40
  • 2
    Can't believe this was it... Was trying to fix this for almost an HOUR. Had vs extensions installed, npm packages installed, settings.json setup, eslintrc was good to go, tried toggling settings, going in settings panel, everything... I'm just amazed this was it, since I tried "turning it off and on again" in every other regard and the settings seemed to be applied instantly... – Justin Jul 26 '21 at 09:16
  • It looks like my issue was caused by upgrading my version of node. Doing this fixed the problem. – Brad W Aug 04 '21 at 19:24
  • 1
    Using `Developer: Reload Window` from the command palette worked for me too. – Doom5 Sep 05 '21 at 07:47
  • This worked for me when I'm configuring formatting for Solidity files, and I spent 2 weeks trying to make it work again only to find up a simple "have you tried turning it off and on" would have worked. :/ – burningalc Mar 31 '22 at 07:16
33

I am not using Vue, but had the same problem.

I already had the settings

  • Editor: default formatter to prettier
  • Editor: Format on Save to true
  • I already had .eslintrc.js and .prettierrc files But nothing worked.

The solution to my problem was that I had all set properly, except I needed to:

  • Command + Shift + p
  • type format document with
  • select Configure Default Formatter...
  • select Prettier as default.

I don't know why the Editor: Format on Save set to true was not enough. I needed to select default formatter using the above steps so it worked.

enter image description here

Juan Castano
  • 689
  • 6
  • 10
  • If you do have an ESlint config already, you should probably use Prettier via ESlint. Here is [my answer](https://stackoverflow.com/a/68880413/8816585) on how to achieve such thing. – kissu Sep 10 '21 at 06:23
29

can you try to add this section to your VS Code settings.json file?

"[javascript]": {
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.formatOnSave": true,
},
iPzard
  • 1,961
  • 2
  • 13
  • 23
Alongkorn
  • 3,376
  • 1
  • 23
  • 40
24

I faced this problem and these three steps solved my problem: Prettier Doesn't format code

Arsham Arya
  • 647
  • 11
  • 18
15

you can still have issues in spite of all these settings. In this case, as pointed out in an earlier answer, then it would be a good point to check the prettier notification at bottom status bar in VSCode.

enter image description here

When clicking on that status, the output panel should report the issue in the HTML file. For me, the issue was I had a div inside a p tag which I assume prettier/VSCode conventions are against. When I removed it (and combined with all the settings above, namely default formatter and format on save) I got prettier working.

.prettierrc is not required unless you want to override VSCode settings

supi
  • 1,982
  • 17
  • 15
14

This is not a problem with Prettier itself, but prettier-vscode, the VSCode extension. According to its documentation, Vue formatting is disabled by default:

prettier.disableLanguages (default: ["vue"])

A list of languages IDs to disable this extension on. Restart required. Note: Disabling a language enabled in a parent folder will prevent formatting instead of letting any other formatter to run

In this case, to enable you should set "prettier.disableLanguages": []. And since this is an extension configuration, you should do it in VSCode settings file, not .prettierrc.

Lucas
  • 3,890
  • 1
  • 19
  • 30
14

On Windows:

We can open the below file using:

Start > Run 

File Path:

%AppData%\Code\User\settings.json

Change From:

"[javascript]": {
    "editor.defaultFormatter": "vscode.typescript-language-features"
},

To:

"[javascript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
},

Note:

Manohar Reddy Poreddy
  • 21,015
  • 9
  • 137
  • 125
11

For me the problem was with HTML files where formatting stopped working one day. I had Format On Save configured, which worked in all files except HTML.

I then realized that I experimentally set Format On Save Mode to modification instead of file and forgot about it. This had an effect of not formatting anything in HTML files, surprisingly not even my changes. Setting it back to file solved the issue.

enter image description here

Skocdopole
  • 15,070
  • 2
  • 23
  • 40
8

1 .Use the other extension prettier was not working for me i just use the other VSCODE extension named PrettierNow i think this will help, done for me.Checkout the extension here

2 .From Latest Updates of prettier you need to add .prettierrc file in your root of the projects if you want to stick with prettier. An example of .prettierrc is this-

{
  "tabWidth": 4,
  "singleQuote": true,
  "semi": false
}
Devesh
  • 801
  • 11
  • 9
6

Enabling "format on Save" in VSCode: Setting >> User >> Text Editor >> Formatting worked for me!

Print

Zenox
  • 61
  • 1
  • 3
6

If Prettier formats all other files except HTML files automatically on save:

Press Cmd + P or Ctrl + P to open the command palette and type the following text in it:

> open settings

Click on Preferences: Open Settings (JSON) from the suggestion dropdown. Inside the settings.json file, Check if "[html]" key exists. If the key exists and its value indicates using another formatting extension installed in Visual Studio Code, you should reset it back to use Prettier.

"[html]": {
    "esbenp.prettier-vscode"
}

For an instance, sometimes, the value of "[html]" key could be "remimarsal.prettier-now" when you would have Prettier Now extension installed.

If you don't have any other formatting extension installed other than Prettier, you can also remove the "[html]" key altogether from settings.json file.

Srishti
  • 897
  • 10
  • 25
6

This is what worked for me (my default formatter was already set to Prettier)

  1. Change default formatter to default
  2. Restart vscode
  3. Change default formatter back to Prettier.
Kendra
  • 101
  • 1
  • 2
  • To [restart vscode](https://stackoverflow.com/a/42002990/9868383) Open the command palette `(Ctrl + Shift + P)` and execute the command: `Reload Window`, thanks! – D4ITON Sep 09 '21 at 14:58
5

Go to Manage(located on left-bottom corner) -> Settings -> Users tab -> Text-Editor -> Formatting -> check the format on save

if not working then close and again open your vscode editor

Pankaj Sharma
  • 51
  • 1
  • 2
4

For me - it was to do with ESlint which also works with Prettier. Eslint wasn't working (a local installation vs global installation conflict) which broke Prettier.

Wide Awake
  • 963
  • 9
  • 14
  • How to resolved this. I am having an issue where Eslint is asking for a new line when press enter and save it gets back to the same position and error starts appearing again. – ammad khan Oct 01 '20 at 10:18
  • If you do have an ESlint config already, you should probably use Prettier via ESlint. Here is [my answer](https://stackoverflow.com/a/68880413/8816585) on how to achieve such thing. – kissu Sep 10 '21 at 06:24
4

Recently I got the same problem, that Prettier does not format code automatically on saving. Checking Prettier, I saw an error: Invalid "arrowParens" value. Expected "always" or "avoid", but received true.

The error message was seen when I clicked this: enter image description here

It turned out that I have Prettier Now installed also. This has a boolean value in my config file. After uninstalling Prettier Now, everything works fine.

jaop
  • 178
  • 8
3

Some times with auto plugins update Required files used by Prettier might go missing .

Check this path if files are present here or folder is empty

C:\Users\YOURUSERNAME\.vscode\extensions\esbenp.prettier-vscode-2.2.2\out

If missing uninstall and reinstall prettier

kartick shaw
  • 705
  • 11
  • 5
  • > "If missing uninstall and reinstall prettier" is what did it for me. I had all the settings right, and running prettier from an NPM script even worked right, but formatting on save didn't until I uninstalled and reinstalled. – redOctober13 May 19 '22 at 20:20
3

If none of the other answers work, check that a conflicting prettier config .prettierrc does not exist in your working directory or check for .prettierignore to be sure the files/folders are not being ignored.

piouson
  • 1,580
  • 1
  • 15
  • 24
3

Check if there is a .vscode/settings.json file in your project directory (workspace). In my case someone had checked in this file:

{
  "editor.formatOnSave": false
}

Solution: Delete the file (delete it from source control too) and add .vscode/ to .gitignore (if you're using git).

TrueWill
  • 24,482
  • 7
  • 94
  • 140
3

In some cases where prettier is provided as a dependency, you might need to install it before prettier vscode recognizes it using one of the following commands, depending on the package manager you are using
npm i or yarn

Hayyaun
  • 129
  • 9
3

In my case it turned out I had configured prettier to use a configuration file that didn't exist (see screnshot below). That was hard to find since there wasn't any error message but prettier just didn't work. Maybe this helps somebody, too.

Screenshot

Semjon Mössinger
  • 1,666
  • 2
  • 21
  • 31
2

I Rolling back prettier to 1.7.3 and fixed it

2

In my case I had to do the following:

  1. Install prettier from the command line(npm install --save-dev --save-exact prettier prettier-plugin-custom)
  2. Reload VSCode

and voilà, everything started working.

TIP: To make sure the installation is good I checked for the version:

npx prettier --version
Randall Flagg
  • 4,606
  • 8
  • 32
  • 44
  • This worked for me. I had `prettier` installed globally already, but it didn't work. If I had to guess, it might have been a WSL issue. – August Janse Apr 08 '21 at 10:25
2

Check for requirePragma in .prettierrc, it says you need to add a top level comment for that file to be formatted

remove that rule and it should work

gandharv garg
  • 841
  • 7
  • 15
2

How to format your code through VScode's ESlint plugin

Alright, rather than giving a guide on how to use VScode's Prettier extension, I'd rather explain how to rely on ESlint and have both worlds: checking that your code is correct (ESlint), then formatting it (Prettier).

What are the advantages of this?

  • not forcing your entire team to use VScode with the Prettier extension, maybe some prefer Vim, IntelliJ's Webstorm, Emacs etc... A tool-agnostic solution is IMO always better.
  • I think that linting your code is more important that formatting it, but if you have both extensions working at the same time, you may have conflicts between the formatting and the linting.
  • your hardware will struggle less, if you have less extensions running (mainly because it can stop the conflicts)
  • using an ESlint + Prettier combo will strip the need to have a specific personal configuration aside of the codebase (untracked). You'll also benefit from having Vue/Nuxt specific ESlint rules and a simpler/more universal configuration.
  • an ESlint configuration can be configured to be run before a commit, in a CI/CD or anywhere really.

How to achieve this kind of setup?

Let's start first by installing the ESlint extension and only it, DO NOT install the Prettier one.

enter image description here

Not installed Vetur yet?

I do heavily recommend it for Vue2 apps (what Nuxt is running as of today), you can find it below. It will allow to quickly and simply ESlint (+ Prettier) any .vue files.


When it's done, access the Command Palette with either ctrl + shift + p (Windows/Linux) or cmd + shift + p (Mac) and type Preferences: Open Default Settings (JSON)

enter image description here

There, you should have something like this

{
  "workbench.colorTheme": "Solarized Dark", // example of some of your own configuration

  "editor.codeActionsOnSave": {
    "source.fixAll": true,
  },
  "eslint.options": {
    "extensions": [
      ".html",
      ".js",
      ".vue",
      ".jsx",
    ]
  },
  "eslint.validate": [
    "javascript",
    "javascriptreact",
    "typescript",
    "typescriptreact",
    "html",
    "vue",
  ],
}

How to try that your configuration is now working?

To see if my solution is working, please download this Github repo, get the latest stable Node version (eg: 14) and run yarn to have it working. Otherwise, simply open VScode.
This repo can also be used to double-check that yours is properly configured by inspecting my files there!

Then, you could access any .js or .vue file and see the problems there (Command Palette: Problems: Focus on Problems View). nuxt.config.js and /pages/index.vue are good examples, here is the index.vue file.

enter image description here

You can see that we do have several things that can be fixed by Prettier but that we do also have an eslint(vue/require-v-for-key) error. The solution is available as a comment just below btw.

PS: if you want to have inline ESlint warnings/errors as in the screenshot, you can install Error Lens, it's a super amazing extension if you want to get rid of errors.

Save this file and you should saw that every auto-fixable things are done for you. Usually it's mainly Prettier issues but it can also sometimes be ESlint too. Since we do have the ESlint rules from Nuxt, you'll get some nice good practices out of the box too!

Tada, it's working! If it's not, read the section at the end of my answer.

If you want to create a brand new project

You can run npx create-nuxt-app my-super-awesome-project and select few things there, the most important being Linting tools: Eslint + Prettier of course (hit space to opt-in for one of them).

enter image description here

Warning: as of today, there is an additional step to do to have ESlint + Prettier working properly as shown in this Github issue. The fix should be released pretty soon, then the configuration below will not be needed anymore!

To fix this, run yarn add -D eslint-plugin-prettier and double check that your .eslintrc.js file is a follows

module.exports = {
  root: true,
  env: {
    browser: true,
    node: true
  },
  parserOptions: {
    parser: '@babel/eslint-parser',
    requireConfigFile: false
  },
  extends: [
    '@nuxtjs',
    'plugin:prettier/recommended', // this line was updated
    'prettier'
  ],
  plugins: [
  ],
  // add your custom rules here
  rules: {}
}

Then, you can have it working totally fine as above. Save the file and it should run ESlint then Prettier one after the other!


If you still have some issues

  • try to use the Command Palette again and ESLINT: restart ESLint Server or even Developer: Reload Window
  • feel free to leave a comment or contact me if you need some help
kissu
  • 24,311
  • 11
  • 36
  • 67
2

From the menu navigate through: view -> Command Palette Form the command palette search for Format Document and then select Prettier as your format engine.

I had prettier already working on another project, but for the new one I had do it through this way to enable it again for the new project.

Yaser AZ
  • 81
  • 3
2

in my case it was being hijacked by typescript formatter.

it was driving me crazy because it kept re-formatting my spaces!

to fix i did cmd+. (settings) type -> "default formatter"

and unchecked typescript

enter image description here

Sonic Soul
  • 22,303
  • 34
  • 123
  • 193
1

Don't forget to enable "editor.defaultFormatter" in the settings of the VSCode. In my case it was null and hence even the "editor.formatOnSave" was also not seeming to solve the issue.

Sakthi
  • 21
  • 1
1

I tried to enable "Format On Save" and set the "Auto Save Delay" to 0. It worked, so I guess you could try this too.

Edit: You can see them through these steps.

  1. Manage(The gear Icon bottom left)
  1. Settings(Inside the manage dropdown list)
  1. Search for Format On Save and enable it(check the box)
  1. Scroll down and look for Auto Save Delay and set it to 0
Ash Clarke
  • 4,701
  • 36
  • 47
Gark
  • 35
  • 9
1

There are a few syntaxes that prettier is not able to parse. ?? is one of them. After removing the symbol my prettier worked like a charm. You should take a look at the output of the Prettier extension in vscode. That should point out the line and the syntax which is causing problems for prettier to format properly.

Devorein
  • 709
  • 1
  • 10
  • 19
1

If you have set all things which you can do in Setting and Prettier is not working. Try to install it through this command line. npm install --save-dev prettier

Huu Phong Nguyen
  • 1,042
  • 10
  • 14
  • Despite `npx prettier --version` working, I wasn't getting any auto-formatting until I ran the `install` command in this answer. (I used `yarn`, but the result is the same.) – Tyler Forsythe Sep 17 '21 at 19:38
1

here my prettier config working on vue.js files, typescript files and json files.

arrowParens: 'always'
bracketSpacing: true
endOfLine: 'crlf'
htmlWhitespaceSensitivity: 'css'
insertPragma: false
jsxBracketSameLine: false
jsxSingleQuote: true
overrides:
- files: '*.json'
  options:
    semi: true
    parser: 'json'
parser: 'babel'
printWidth: 120
proseWrap: 'preserve'
quoteProps: 'truepreserve'
requirePragma: false
semi: false
singleQuote: true
tabWidth: 8
trailingComma: 'es5'
useTabs: true
vueIndentScriptAndStyle: 

Do not forget to update your vscode settings

{
"extensions.ignoreRecommendations": false,
"editor.suggestSelection": "first",
"vsintellicode.modify.editor.suggestSelection": "automaticallyOverrodeDefaultValue",
"[json]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[javascript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[vue]": {
    "editor.defaultFormatter": "octref.vetur"
},
"[typescript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[html]": {
    "editor.defaultFormatter": "vscode.html-language-features"
},
"vetur.format.options.useTabs": true}

that's all folk's !

marcdahan
  • 2,360
  • 24
  • 24
  • `"[typescriptreact]": { "editor.defaultFormatter": "esbenp.prettier-vscode" },` Worked perfectly for me! Otherwise everything else was set fine but still prettier was not working on save. – Kia Kaha Apr 19 '22 at 12:34
1

For my case i was using a windows machine and it turned out the file system had been corrupted thus prettier raised an error because it could not be able to open the config file due to file system corruption.

TO resolve it I run chkdsk /f h: on the terminal where h is the file partition.

This resolved the file corruption and prettier is now working fine.

azw
  • 21
  • 1