Configuration.md

Configuration

Back to Readme

More information about certain configuration options that don't fit into the table on the readme.

Compact Folders

Tree view respects the explorer setting "Compact Folders". This will combine empty folders in the tree into one folder:

Without Compact	With Compact

This is an explorer setting and not part of this extension's settings.

Condense Folders

Condense will render workspaces in their parent folder if there is only one workspace in a folder:

Without Condense	With Condense

Root Folders

v2.0.0 allows multiple root folders. These are specified in an array of objects like this:

Linux / Mac

{
  "workspaceSidebar.rootFolders": [
    { "path": "/home/user/apps", "excludeHiddenFolders": false}
    { "path": "~/projects", "depth": 2} // "~" will be replaced with "/home/user"
    { "path": "/home/user/dev"}
  ]
}

Windows

{
  "workspaceSidebar.rootFolders": [
    { "path": "C:\\Users\\User\\Apps", "excludeHiddenFolders": false}
    { "path": "C:\\Users\\User\\Projects", "depth": 2}
    { "path": "Z:\\VM Dev\\vsc"}
  ]
}

Root Folder

• path string (required)

  • The absolute path to a folder
  • There is no variable substitution, but "~/" can be used on Mac/Linux instead of "/home/user/"

• depth int

  • The depth of subfolders to search. This overrides workspaceSidebar.depth
  • The integers can range from 0-25

• excludeHiddenFolders bool

  • Should hidden folders be skipped when searching for Workspaces? This overrides workspaceSidebar.excludeHiddenFolders
  • Searching hidden folders can slow down the search.

Paths

In addition to normal folders, some other kinds of folders work too:

• Windows:
  • Junctions/SymLinks can be used
  • Shortcuts don't work
  • Hard Links not tested
• Mac:
  • SymLinks can be used
  • Aliases don't work
  • Hard Links not tested
• Linux
  • SymLinks can be used
  • Hard Links not tested

Show File Icons Config

File icons are displayed based on substring matches against the file path to Workspaces.

Keys are languages or file types and each kay can match a number of strings.

  "workspaceSidebar.showFileIconsConfig": {
    "language": ["keyword", "keyword"],
    "filetype": ["keyword"],
  }

Some examples might look like:

  "workspaceSidebar.showFileIconsConfig": {
    "react": ["redux"],
    "ts": ["vsc", "electron"],
  }

And these would match as follows:

  // Displays react icon as "redux" matches
  /home/users/Dev/react/redux/counter/counter.code-workspace

  // Displays ts icon as "vsc" matches
  /home/users/Dev/vsc/extension.code-workspace

  // Displays ts icon as "electron" matches due to deeper folders being checked first.
  /home/users/Dev/react/redux/electron/nextjs-app/na.code-workspace

  // Displays react icon as "redux" in name matches
  /home/users/Dev/vsc/redux.code-workspace

More information about file icons