Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: make VSCode settings opt-in #29504

Closed
wants to merge 1 commit into from

Conversation

filipesilva
Copy link
Contributor

@filipesilva filipesilva commented Mar 25, 2019

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • angular.io application / infrastructure changes
  • Other... Please describe:

What is the current behavior?

The current vscode settings are mandatory for all users. Some of these settings can break or significantly alter current editor usage.

What is the new behavior?

Settings are opt-in and include instructions on how they should be used and altered.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

.gitignore Outdated
@@ -12,7 +12,7 @@ pubspec.lock
.c9
.idea/
.settings/
.vscode/launch.json
.vscode
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually I think the .vscode/extensions.json file is a good one to keep in the repo. So we should not ignore that one.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes now that you bring up I totally agree. extensions.json is meant to signal extensions the repository team considers useful and is already an opt-in procedure. Will change.


If you already have your custom workspace settings you should instead manually merge the content of the existing files.

This isn't an automatic process so you will need to repat it when settings are updated.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

repat => repeat

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Copy link
Member

@petebacondarwin petebacondarwin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally I think this PR should be restricted to the .vscode/settings.json rather than the whole folder. I like to have my own launch.json, which would get overridden by the current process; and also I think that the extensions.json is a valid file to keep in the repo.

@filipesilva filipesilva force-pushed the vscode-optin branch 2 times, most recently from 6d63383 to ecb52f0 Compare March 25, 2019 11:39
Copy link
Member

@gkalpak gkalpak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once this is merged, it should to be announced on Slack as it affects the whole team (in a small way).


This folder contains opt-in [Workspace Settings](https://code.visualstudio.com/docs/getstarted/settings) and [Extension Recommendations](https://code.visualstudio.com/docs/editor/extension-gallery#_workspace-recommended-extensions) that the Angular team recommends using when working on this repository.

## Usage
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be worth adding a mention about where/how to find the recommended extensions for the workspace (e.g. Ctrl/Cmd+Shift+P and type Show recommended extensions).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added.

@mhevery mhevery added the area: build & ci Related the build and CI infrastructure of the project label Mar 25, 2019
@ngbot ngbot bot added this to the needsTriage milestone Mar 25, 2019
@gkalpak
Copy link
Member

gkalpak commented Mar 28, 2019

(Rebased on master to get CI green.)

@@ -8,6 +11,7 @@
// Please install https://marketplace.visualstudio.com/items?itemName=xaver.clang-format to take advantage of `clang-format` in VSCode.
// (See https://clang.llvm.org/docs/ClangFormat.html for more info `clang-format`.)
"clang-format.executable": "${workspaceRoot}/node_modules/.bin/clang-format",
// Exclude third party modules and build artifacts from the editor watchers/searches.
"files.watcherExclude": {
"**/.git/objects/**": true,
"**/.git/subtree-cache/**": true,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add this setting to:

  "typescript.tsdk": "node_modules/typescript/lib",

This tells VS code to use the workspace TS compiler rather than VS Code's built-in one.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer that to be done in a separate PR. It's not something I can test well right now and a bit out of scope anyway.

@filipesilva filipesilva added target: patch This PR is targeted for the next patch release action: merge The PR is ready for merge by the caretaker labels Mar 29, 2019
@filipesilva filipesilva removed the request for review from matsko March 29, 2019 10:18
@filipesilva filipesilva removed the request for review from IgorMinar March 29, 2019 10:18
@jasonaden jasonaden closed this in eb0e29b Mar 29, 2019
jasonaden pushed a commit that referenced this pull request Mar 29, 2019
@gkalpak
Copy link
Member

gkalpak commented Mar 29, 2019

🎉

@filipesilva filipesilva deleted the vscode-optin branch March 29, 2019 17:40
wKoza pushed a commit to wKoza/angular that referenced this pull request Apr 17, 2019
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 14, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker area: build & ci Related the build and CI infrastructure of the project cla: yes target: patch This PR is targeted for the next patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants