VSCode.md

VS Code

Recommendations and tips for using VS Code.

Extensions

The following extensions may be useful in all projects:

• Code Spell Checker
• CODEOWNERS
• EditorConfig for VS Code
• GitHub Pull Requests and Issues
• GitHub Copilot
• GitLens
• IntelliCode
• IntelliCode API Usage Examples
• Prettier

HTML/XML

• Auto Rename Tag
• Live Server

CSS

• Color Highlight

JavaScript/TypeScript

• Deno
• ESLint
• Jest
• Jest Runner
• Template String Converter
• Version Lens

Markdown

• GitHub Markdown Preview

Scala

• Scala (Metals)

Svelte

• Svelte

YAML

• YAML

Settings

The following settings may be useful to you:

{
    "editor.bracketPairColorization.enabled": true,
    "editor.codeActionsOnSave": {
        "source.fixAll.eslint": true
    },
    "editor.formatOnSave": true,
    "editor.formatOnType": true,
    "search.exclude": {
        "**/frontend/static/hash": true,
        "**/frontend/static/target": true,
        "**/frontend/static/transpiled": true,
        "**/node_modules": true,
        // etc
    }
}

Do not commit .vscode

The .vscode project directory can contain project-specific configurations but also things which override user preferences, and not everyone will find this useful.

Instead, ignore the directory by default and add back things you explicity want to share, e.g.:

# .gitignore
.vscode/*
!.vscode/*.code-snippets

.vscode/settings.json

Do not commit this, ever! This overrides user settings. Instead, commit a .vscode/settings.json.default file with your project's recommended settings. Individual developers can then pick and choose the bits that will help them the most:

# .gitignore
.vscode/*
!.vscode/settings.json.default