`vp create` generated repository excludes `.vscode/settings.json` from git version control

[ZiuChen]

Describe the bug

Description

When initializing a new project using vp create, the generated .vscode/settings.json file is not tracked by Git (or is being ignored). This prevents the team from sharing consistent IDE configurations (like the oxc formatter) across the project, which is critical for consistent code formatting.

Expected Behavior

The .vscode/settings.json file should be committed to the repository so that all contributors share the same editor settings.

Actual Behavior

The .vscode/settings.json file is ignored (or not added) in the initial commit, causing inconsistency in formatter settings among team members.

Additional Context

I believe this might be an issue with the .gitignore configuration in the project template or a missing step in the generation process. Ensuring this file is tracked will greatly improve the DX for teams.

Reproduction

Steps to reproduce

1. Run vp create (please specify the template you used).
2. Check if .vscode/settings.json exists in the repository.
3. Check git status or .gitignore to see if the file is ignored.
4. Verify that the file is not being tracked by Git.

System Info

VITE+ - The Unified Toolchain for the Web

Environment:
  Version       24.15.0
  Source        engines.node
  Source Path   /Users/ziu/Programs/livephotomaker/package.json
  Project Root  /Users/ziu/Programs/livephotomaker

Tool Paths:
  node  /Users/ziu/.vite-plus/js_runtime/node/24.15.0/bin/node
  npm   /Users/ziu/.vite-plus/js_runtime/node/24.15.0/bin/npm
  npx   /Users/ziu/.vite-plus/js_runtime/node/24.15.0/bin/npx

Used Package Manager

pnpm

Logs

-

Validations

• Read the Contributing Guidelines.
• Check that there isn't already an issue for the same bug.
• Confirm this is a Vite+ issue and not an upstream issue (Vite, Vitest, tsdown, Rolldown, or Oxc).
• The provided reproduction is a minimal reproducible example.

[Adrian-Baran-GY]

I think there is a tension here and it is not a bug, but rather a matter of preference. There are some project specific settings which one would want to share across the team, but there are other settings which a developer might want to customize for their own preferences. I like for example the possibility to set different workbench.colorTheme for different projects. If the settings.json is committed to the repository, then I couldn't do that.

BTW @fengmk2 shouldn't this ticket be created for Vite repository (create-vite package)? Isn't it where the templates are defined?

[fengmk2]

@Adrian-Baran-GY Currently, vp create creates and modifies the .vscode/settings.json file, which should not be added to .gitignore by default.

[Adrian-Baran-GY]

I understand that this is not the current approach. I just wanted to share my thoughts on this topic.

Instead of forcing users to have the same settings a gentler approach would be to share a sample settings file with the recommended settings. Similarly to how we share recommended extensions in the extensions.json file, we can share recommended settings in a settings.sample.json file and have following lines in the .gitignore file:

.vscode/*
!.vscode/extensions.json
!.vscode/settings.sample.json

This approach is described here for example: Sharing Recommended VSCode Settings in Your Project Repository.

This way a developer can start with the recommended settings and then customize them (eg. set editor theme per project) as needed without worrying about conflicts with other team members. It also allows for flexibility while still providing guidance on the best practices for the project.

[jong-kyung]

This way a developer can start with the recommended settings and then customize them (eg. set editor theme per project) as needed without worrying about conflicts with other team members. It also allows for flexibility while still providing guidance on the best practices for the project.

@Adrian-Baran-GY Thanks for sharing your thoughts — that’s a fair point.

However, since vp create already lets users choose whether to generate editor configuration, I think that if a user selects VS Code during vp create, the generated .vscode/settings.json should be usable as intended and not be ignored by Git.