Skip to content

Commit aae14cc

Browse files
committed
vscode: Stop setting format-on-save; document it instead
This is really more natural as a per-user setting than a per-project / per-workspace setting.
1 parent 7e7c6a6 commit aae14cc

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

.vscode/settings.json

-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,5 @@
1111
"[javascript]": {
1212
// Format JS code with prettier-eslint.
1313
"editor.defaultFormatter": "esbenp.prettier-vscode",
14-
15-
"editor.formatOnSave": true,
1614
},
1715
}

docs/howto/editor.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,13 @@ Take a look through some of VS Code's docs. In particular:
6262
for your platform, and print it out. It's a one-page PDF which is
6363
extremely helpful to refer to.
6464

65-
* Open any JS file in our codebase, and try messing up some formatting by
66-
adding random whitespace -- then hit Ctrl+S (or Cmd+S) to save. You
67-
should see the formatting get magically fixed! Our workspace settings
68-
enable this feature, and configure it to use our standard formatting
69-
rules.
65+
* Consider enabling the setting "Editor: Format On Save". (Go to the
66+
settings UI, and type "format on save" into the search box to find
67+
the setting. Then check the box for the setting.)
68+
69+
After doing so, open any JS file in our codebase, and try messing up
70+
some formatting by adding random whitespace -- then hit Ctrl+S (or
71+
Cmd+S) to save. You should see the formatting get magically fixed!
7072

7173

7274
### Troubleshooting

0 commit comments

Comments
 (0)