Skip to content

build: make VSCode settings opt-in - #29504

Closed
filipesilva wants to merge 1 commit into
angular:masterfrom
filipesilva:vscode-optin
Closed

build: make VSCode settings opt-in#29504
filipesilva wants to merge 1 commit into
angular:masterfrom
filipesilva:vscode-optin

Conversation

@filipesilva

@filipesilva filipesilva commented Mar 25, 2019 •
edited
Loading

Copy link
Copy Markdown
Contributor

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

@filipesilva
filipesilva requested a review from IgorMinar as a code owner March 25, 2019 10:53
@filipesilva
filipesilva requested a review from a team March 25, 2019 10:53
petebacondarwin
petebacondarwin reviewed Mar 25, 2019
View reviewed changes
Comment thread .gitignore Outdated

@petebacondarwin petebacondarwin Mar 25, 2019

Copy link
Copy Markdown
Contributor

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.

@filipesilva filipesilva Mar 25, 2019

Copy link
Copy Markdown
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.

petebacondarwin
petebacondarwin reviewed Mar 25, 2019
View reviewed changes
Comment thread .vscode-configuration/README.md Outdated

@petebacondarwin petebacondarwin Mar 25, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

repat => repeat

@filipesilva filipesilva Mar 25, 2019

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done

petebacondarwin
petebacondarwin suggested changes Mar 25, 2019
View reviewed changes

@petebacondarwin petebacondarwin left a comment

Copy link
Copy Markdown
Contributor

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.

gkalpak
gkalpak approved these changes Mar 25, 2019
View reviewed changes

@gkalpak gkalpak left a comment

Copy link
Copy Markdown
Member

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).

Comment thread .vscode/README.md Outdated

@gkalpak gkalpak Mar 25, 2019

Copy link
Copy Markdown
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).

@filipesilva filipesilva Mar 28, 2019

Copy link
Copy Markdown
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
gkalpak requested a review from petebacondarwin March 28, 2019 10:11
@gkalpak

gkalpak commented Mar 28, 2019

Copy link
Copy Markdown
Member

(Rebased on master to get CI green.)

petebacondarwin
petebacondarwin reviewed Mar 29, 2019
View reviewed changes
Comment thread .vscode/recommended-settings.json
// Exclude third party modules and build artifacts from the editor watchers/searches.
"files.watcherExclude": {
"**/.git/objects/**": true,
"**/.git/subtree-cache/**": true,

@petebacondarwin petebacondarwin Mar 29, 2019

Copy link
Copy Markdown
Contributor

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.

@filipesilva filipesilva Mar 29, 2019

Copy link
Copy Markdown
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
@jasonaden jasonaden closed this in eb0e29b Mar 29, 2019
jasonaden pushed a commit that referenced this pull request Mar 29, 2019
@filipesilva @jasonaden
build: make VSCode settings opt-in (#29504)
72900ec 
PR Close #29504
@gkalpak

gkalpak commented Mar 29, 2019

Copy link
Copy Markdown
Member

馃帀

@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
@filipesilva @wKoza
build: make VSCode settings opt-in (angular#29504)
17899cb 
PR Close angular#29504
@angular-automatic-lock-bot

angular-automatic-lock-bot Bot commented Sep 14, 2019

Copy link
Copy Markdown

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.

Reviewers

@pkozlowski-opensource pkozlowski-opensource pkozlowski-opensource approved these changes
+4 more reviewers
@petebacondarwin petebacondarwin petebacondarwin approved these changes
@alexeagle alexeagle alexeagle approved these changes
@mhevery mhevery mhevery approved these changes
@gkalpak gkalpak gkalpak approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

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

Milestone

needsTriage

Development

Successfully merging this pull request may close these issues.

7 participants

@filipesilva @gkalpak @petebacondarwin @alexeagle @mhevery @pkozlowski-opensource @googlebot