Skip to content

VSCode

Last update: 19 Jan 2025

.gitignore configuration

The files generated by VSCode should be excluded (ignored) from the repo except the file that contains the recommended extensions for the project. This file is named extensions.json.

.gitignore fragment:

.vscode/*
!.vscode/extensions.json

The first line excludes all VSCode files, the second line re-enables the file with the recommended extensions.

The recommended extensions for the project can be saved in the project extensions.json file. All members of the team working on the project will be suggested by VSCode to install that extensions.

The content of the file is the following:

{
    "recommendations": [
        "extension1-id",
        "extension2-id",
        ....
    ]
}

Please note that the extensions are identified by their ID which can be found in the extension page as Identifier.

Suggested plugins

The below list is my personal list of suggested plugins:

ID Name Purpose Scope
editorconfig.editorconfig Editorconfig support File encoding and formatting All projects
sonarsource.sonarlint-vscode Sonarlint/qube Source quality checks All projects
davidanson.vscode-markdownlint Markdown supporto Markdown files editing and linking All projects
ltex-plus.vscode-ltex-plus Language tool Spelling and grammar checks All projects
mechatroner.rainbow-csv CSV support Syntax and checks for CSV files All projects
esbenp.prettier-vscode Prettier support Prettier formatter Front-end projects
dbaeumer.vscode-eslint ESLint support JavaScript checker Front-end projects
stylelint.vscode-stylelint CSS support CSS checker Front-end projects
bruno-api-client.bruno Bruno support The alternative to Postman All projects
vscjava.vscode-java-pack Java/JVM support Microsoft extensions bundle for Java Java/JVM projects
vmware.vscode-boot-dev-pack Spring Boot support Vmware extensions bundle for Spring Framework and Spring Boot development Java/JVM projects using Spring
vscjava.vscode-lombok Lombok support Support for Lombok Java projects
nicolasvuillamy.vscode-groovy-lint Groovy support Linter and formatter Groovy/Grails projects

Possible extensions file contents:

{
    "recommendations": [
        "editorconfig.editorconfig",
        "esbenp.prettier-vscode",
        "dbaeumer.vscode-eslint",
        "stylelint.vscode-stylelint",
        "sonarsource.sonarlint-vscode"
        "bruno-api-client.bruno"
        "mechatroner.rainbow-csv"
        "davidanson.vscode-markdownlint",
        "ltex-plus.vscode-ltex-plus"
        "nicolasvuillamy.vscode-groovy-lint",
        "vscjava.vscode-java-pack",
        "vmware.vscode-boot-dev-pack",
        "vscjava.vscode-lombok",
        "nicolasvuillamy.vscode-groovy-lint"
    ]
}