Skip to content

Commit acc2a70

Browse files
ayazhafizKeen Yee Liau
authored andcommitted
fixup! docs: add documentation about new clang-format formatter
1 parent 2a41226 commit acc2a70

File tree

3 files changed

+5
-4
lines changed

3 files changed

+5
-4
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,6 @@ integration/out
99
dist/
1010
**/.idea/
1111
**/tsconfig.tsbuildinfo
12+
.vscode/settings.json
1213
.vimrc
1314
.nvimrc

.vscode/settings.json renamed to .vscode/recommended-settings.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"tslint.enable": true,
44
"typescript.tsc.autoDetect": "off",
55
"typescript.preferences.quoteStyle": "single",
6-
"//format-on-save-comment": "Format ts files on save with `clang-format.executable`. If `clang-format.executable` is not being used, these two settings should be removed otherwise it will break existing formatting. You can instead run `yarn format` to manually format your code.",
6+
"//format-on-save-comment": "Format ts files on save with `clang-format.executable`. If `clang-format.executable` is not being used, this setting should be removed. You can instead run `yarn format` to manually format your code.",
77
"[typescript]": {
88
"editor.formatOnSave": true
99
},

DEVELOPER.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ files on each save.
1111
1. Install the
1212
[`Clang-Format` extension](https://marketplace.visualstudio.com/items?itemName=xaver.clang-format)
1313
for VS Code.
14-
15-
VS Code will automatically pick up relevant settings from this repository's
16-
[`.vscode/settings.json`](./.vscode/settings.json).
14+
2. Copy [`.vscode/recommended-settings.json`](./.vscode/recommended-settings.json) to a new
15+
`.vscode/settings.json` file. VS Code will automatically pick up relevant formatting options for
16+
the workspace from this file.
1717

1818
### WebStorm / IntelliJ
1919

0 commit comments

Comments
 (0)