summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFilipa Lacerda <filipa@gitlab.com>2018-12-14 16:50:00 +0000
committerFilipa Lacerda <filipa@gitlab.com>2018-12-14 16:50:00 +0000
commit9714dfdfd0437a87e172e56810331ca19f420d2b (patch)
tree86ef9db8dd099d655c592faaf2dddd514ae9bf62
parent0a69dbd23da6f625adfc09d7c98fdd1cafe39f4e (diff)
parentc3d71eb3c4c295970a15885333a3ef8ed6bc83ca (diff)
downloadgitlab-ce-9714dfdfd0437a87e172e56810331ca19f420d2b.tar.gz
Merge branch 'doc-prettier-vscode-settings' into 'master'
Update prettier.md with VSCode Settings section See merge request gitlab-org/gitlab-ce!23810
-rw-r--r--doc/development/new_fe_guide/style/prettier.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/development/new_fe_guide/style/prettier.md b/doc/development/new_fe_guide/style/prettier.md
index baaea67d38b..4495f38f262 100644
--- a/doc/development/new_fe_guide/style/prettier.md
+++ b/doc/development/new_fe_guide/style/prettier.md
@@ -57,3 +57,38 @@ node ./scripts/frontend/prettier.js save-all ./vendor/
```
This will go over all files in a specific folder and save it.
+
+## VSCode Settings
+
+### Format on Save
+
+To automatically format your files with Prettier, add the following properties to your User or Workspace Settings:
+
+```javascript
+{
+ "[javascript]": {
+ "editor.formatOnSave": true
+ },
+ "[vue]": {
+ "editor.formatOnSave": true
+ },
+}
+```
+
+### Conflicts with Vetur Extension
+
+There are some [runtime issues](https://github.com/vuejs/vetur/issues/950) with [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) and [the Vetur extension](https://marketplace.visualstudio.com/items?itemName=octref.vetur) for VSCode. To fix this, try adding the following properties to your User or Workspace Settings:
+
+```javascript
+{
+ "prettier.disableLanguages": [],
+ "vetur.format.defaultFormatter.html": "none",
+ "vetur.format.defaultFormatter.js": "none",
+ "vetur.format.defaultFormatter.css": "none",
+ "vetur.format.defaultFormatter.less": "none",
+ "vetur.format.defaultFormatter.postcss": "none",
+ "vetur.format.defaultFormatter.scss": "none",
+ "vetur.format.defaultFormatter.stylus": "none",
+ "vetur.format.defaultFormatter.ts": "none",
+}
+```