feat: enhance VS Code workspace configuration #8375
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add recommended extensions for optimal development experience - ESLint, Prettier, TypeScript Next, Code Spell Checker, YAML, JSON - Improve editor settings with auto-formatting and code actions - Enable format on save with Prettier as default formatter - Add explicit ESLint fix and import organization on save - Configure search and file exclusions for better performance - Exclude build artifacts, node_modules, and turbo cache - Set TypeScript preferences for relative import paths - Fix cSpell configuration format (enabledFileTypes vs enableFiletypes)
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
dosubot
bot
added
size:M
|
Thank you @christian-bromann! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
VS Code Workspace Configuration Enhancement
This PR adds minimal but effective VS Code workspace configuration to improve the developer experience while maintaining consistency with the existing tooling used in this repository.
I personally would not prefer to have settings dictated by project configurations so I tried to be careful and only include auto-formatting. I believe a lot of contributors will benefit from it as it will just automatically prettify the code without having to run
yarn formatwhich can take some time to complete.That said, I would totally understand if the team doesn't prefer any settings at all.
What's Changed
Recommended Extensions (
.vscode/extensions.json)dbaeumer.vscode-eslint) - For JavaScript/TypeScript lintingesbenp.prettier-vscode) - For consistent code formattingms-vscode.vscode-typescript-next) - Latest TypeScript language featuresstreetsidesoftware.code-spell-checker) - Catch typos in code and commentsredhat.vscode-yaml) - For GitHub workflows and config filesms-vscode.vscode-json) - Enhanced JSON editing for package.json and configsEditor Settings (
.vscode/settings.json)Auto-formatting on save:
"editor.formatOnSave": true- Automatically formats code with Prettier when saving"editor.defaultFormatter": "esbenp.prettier-vscode"- Uses Prettier as the default formatter for all filesPerformance optimizations:
dist/,dist-cjs/,.turbo/) from file watching and searchnode_modulesandyarn.lockfrom search to improve performanceWhy These Changes?
Minimal and Non-Invasive:
These settings only enhance the existing tooling (ESLint, Prettier, TypeScript) that's already configured in the repository. No new tools or breaking changes are introduced.
Prevent CI Failures:
By automatically fixing ESLint issues and formatting code with Prettier on save, developers are less likely to have their CI builds fail due to linting or formatting violations. This saves time in the development cycle and reduces the need for "fix formatting" commits.
Consistent Developer Experience:
All team members will have the same formatting and linting behavior regardless of their individual VS Code setup, leading to more consistent code contributions.
Performance Benefits:
The exclusion patterns prevent VS Code from indexing build artifacts and dependencies, making the editor more responsive in this large monorepo.