Skip to content

VS Code Workspace Settings Overview

Matthew Thornton edited this page Nov 14, 2022 · 10 revisions

VS Code Workspace Settings Overview

The .vscode folder (link) within this repository contains workspace settings that are designed to assist developers utilizing the VS Code editor to develop for Caseflow. These workspace settings will override user settings, so it's best to only include configurations that will universally benefit all developers in these files.

Below is a breakdown of each of the files contained within the aforementioned folder.

extensions.json

Extensions listed within the recommendations array in this file will appear as recommendations to all VS Code users whenever they have the Caseflow repository open in their editors. Extension recommendations can be found in the Extensions tab in the Recommendations pane. Any extensions already installed are omitted.

Screenshot from 2022-10-27 22-42-07

Users will be asked if they'd like to install the recommended extensions: Screenshot from 2022-10-28 08-55-48

Adding a New Recommendation

  1. Copy the extension's ID:
extension-id
  1. Add it to the recommendations array in extensions.json:
add-recommendation
  1. Commit it to version control, and once it makes it into the master branch everyone will see your recommendation. 🎉

Disabling Recommendation Pop-Up

Tired of seeing the "Do you want to install the recommended extensions for this repository?" pop-up? Follow this guide to disable it.

launch.json

settings.json

{
  "editor.tabSize": 2,                  # Sets tabs to 2 spaces
  "editor.trimAutoWhitespace": true,    # Trims whitespace added by the editor
  "eslint.packageManager": "yarn",      # Sets default package manager to yarn
  "eslint.workingDirectories": [        # Allows ESLint to properly resolve import paths in Caseflow
    "./client"
  ],
  "files.insertFinalNewline": true,     # Ensures the presence of a blank line at the end of each file
  "files.trimTrailingWhitespace": true, # Removes trailing whitespace added by the user upon file save
  "git.autofetch": true,                # Enables git fetch to be performed automatically on a timed interval
}

tasks.json

Clone this wiki locally