Workspace Sidebar

An extension for VSCode to switch Workspaces with ease.

You can specify one or more folders to look in for Workspace files and these will be shown in a sidebar, either as a list or as a tree, along with file theme icons to better indentify workspaces.

You can then easily change Workspaces or open another Workspace in a new window.

What's new in v2.1.0?

See a video showcasing the changes

• Root folder handling of changes to config has been improved:
  • Results are shown as they come back, the extension no longer waits until all root folders have been collected.
  • This means root folders show their loading state under their name - the global loading state has been removed.
  • You can now refetch root folders on a per root folder basis
  • The extension now is more selective about refetching and will only do it if some property has changed.
  • Moving a root folder in the config no longer causes a refetch to occur
• There is a new config option to focus the file explorer after opening a workspace in a new window. Closes #173
• Several more explorer settings are now respected in rendering the tree/list that should make the sidebar look and behave more like other views in VSCode:
  • expandMode
  • indent
  • renderIndentGuides
• Updated documentation

See the Changelog for a complete version history.

Features

The extension works by searching the root folders for .code-workspace files, and then displaying them as either a list or a tree.

View Mode

List View

The Workspaces are displayed for each root folder in a list.

Tree View

A representation of the file tree is displayed, these can be collapsed/expanded in a similar way to the File Explorer in VSCode. The file tree can also be cleaned up to reduce visual noise, or displayed as is. In additon folders with only one child can be combined in a similar way to the File Explorer to reduce the number of folders displayed.

Search

A search box is provided to allow you to search for a specific Workspace.

File Theme Icons

File icons are displayed based on a simple substring match against the file path. There is no need to configure file icons for each workspace separately.

More information about the file theme config

Configuration

This is a summary of the available configuration options. View detailed configuration documentaion.

General

Folders

Search

Tree View

Translations

This extension is localised, if you want it in your language please send me a translated "package.nls.json" file which you can find in the root of this extension.

Development

If you are intersted in contributing:

• Fork or clone the repo.

• Install dependencies

• Run tests in a development version of VSCode via the debugger launch panel.

  • Tests can't be run via the node script in package.json as a full instance of VSCode is needed.
  • Output of tests is found in the termial Debug Console tab
  • Run tests on Linux, Mac, and Windows.
  • Typecheck will be run by the launch scripts before running tests

• If using file paths, don't hard code the folder separators, use path.join() instead.

  // This will fail in a test on windows:
  const myPath = '/home/user/dev'
  expect(getPathToDev()).to.equal(myPath)
  
  // Do this instead:
  const myPath = path.join('home', 'user', 'dev')
  expect(getPathToDev()).to.equal(myPath)
  

• If just testing functions that do not use VSCode or just using VSCode types, you can run mocha:compile and then mocha:test to test - but if you use any part of the VSCode API (inc. ENUMs) then you will need to run the tests via the debugger.

• You can package a test version of the extension as a vsix file using the command: vsce package.

  • Test the VSIX on Linux, Mac, and Windows.

• Lint and typechecking commands exist

• Sample colours and CSS variable names

Support

If you use this plugin and want to help support development, please PayPal Me.