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

Do not force VS Code settings #37498

Merged
merged 14 commits into from
Jun 14, 2024
Merged

Do not force VS Code settings #37498

merged 14 commits into from
Jun 14, 2024

Conversation

tbradsha
Copy link
Contributor

@tbradsha tbradsha commented May 22, 2024

We currently prevent users from configuring their VS Code workspace when working in the Jetpack monorepo. This provides a bad user experience.

This PR proposes moving the "sanctioned" settings to settings.dist.json, available for the user to copy as desired.

It also introduces a tools/install-vscode-settings.sh script that will copy the settings template file in place if one doesn't yet exist.

Finally, it introduces a .vscode/task.json file that will run said script when opening the folder in VS Code (so long as scripts are enabled in VS Code). One can manually trigger this in VS Code with the "Run Tasks" command.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

@tbradsha tbradsha requested a review from a team May 22, 2024 21:00
@tbradsha tbradsha self-assigned this May 22, 2024
Copy link
Contributor

github-actions bot commented May 22, 2024

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label May 22, 2024
@tbradsha
Copy link
Contributor Author

Pending discussion here: p1HpG7-sQE-p2

@tbradsha tbradsha added the DO NOT MERGE don't merge it! label May 30, 2024
@tbradsha tbradsha force-pushed the fix/do_not_force_vscode_settings branch from cff58fa to 720a957 Compare June 3, 2024 18:04
@tbradsha tbradsha added [Status] Needs Team Review and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! DO NOT MERGE don't merge it! labels Jun 3, 2024
tools/install-vscode-settings.sh Outdated Show resolved Hide resolved
.vscode/settings.dist.json Show resolved Hide resolved
@tbradsha tbradsha requested a review from manzoorwanijk June 12, 2024 20:48
@tbradsha
Copy link
Contributor Author

Looks like #37505 pushed more changes to .vscode/settings.json...

@tbradsha tbradsha force-pushed the fix/do_not_force_vscode_settings branch from 9be4951 to c02fbb2 Compare June 12, 2024 20:53
@tbradsha
Copy link
Contributor Author

Rebased.

manzoorwanijk
manzoorwanijk previously approved these changes Jun 14, 2024
Copy link
Member

@manzoorwanijk manzoorwanijk left a comment

Choose a reason for hiding this comment

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

Thank you for working on this.

@tbradsha tbradsha merged commit bd01379 into trunk Jun 14, 2024
53 checks passed
@tbradsha tbradsha deleted the fix/do_not_force_vscode_settings branch June 14, 2024 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants