Previously, the VSCode settings for the workspace specified the
`clang-format.executable` setting to configure auto-formatting to use
`clang-format`. Yet, this setting has no effect without the extension
that provides that configuration option namely [xaver.clang-format][1]).
For people that didn't have the extension installed, VSCode would use
the default formatters, resulting in vastly different file fomatting.
This commit adds a set of [rcommended workspace extensions][2], to help
people get the right extensions when checking out the repository.
The recommended extensions are:
- [gkalpak.aio-docs-utils][3]:
Utilities to aid in authoring/viewing Angular documentation source
code. Currently, mainly aid in working with
`{@example}`/`<code-example>` tags.
- [ms-vscode.vscode-typescript-tslint-plugin][4]:
Add auto-linting for TS files using `tslint` while editing.
- [xaver.clang-format][1]:
Add auto-formatting for JS/TS files using `clang-format`.
[1]: https://marketplace.visualstudio.com/items?itemName=xaver.clang-format
[2]: http://go.microsoft.com/fwlink/?LinkId=827846
[3]: https://marketplace.visualstudio.com/items?itemName=gkalpak.aio-docs-utils
[4]: https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-typescript-tslint-plugin
PR Close#28784
Previously, auto-formatting on save was enabled for all file types,
which meant also using default VSCode formatting settings for files
where this was not desirable - for example HTML files (such as
angular.io and docs examples templates) and JSON files (such as Firebase
configurations).
This was problematic for the following reasons:
- Unlike with JS/TS files, the formatting of other file types is not
checked/enforced on CI.
- Formatting is subject to default VSCode settings and everyone's local
VSCode settings overrides.
- Especially for docs examples files, changing the layout might require
updating the wording in corresponding guides (e.g. when referring to
line-numbers).
If we decide that we do want to lint those other file types as well
(which sounds like a good idea), we should do it in a way that ensures
consistent formatting and check the formatting on CI.
PR Close#28784
George Kalpakas
Pete Bacon Darwin
Miško Hevery
Alex Eagle