README.md

March 18, 2026 · View on GitHub

Image

FavFile

A Visual Studio Code extension that lets you favorite files and folders and open them quickly from the Explorer sidebar.

https://github.com/user-attachments/assets/b1f3dd78-41c6-4a47-85e9-54a1713f56a2

Features

  • FavFile view in Explorer — A section in the Explorer sidebar (with Outline and Timeline) with two collapsible groups: Workspace and Global
  • Add to Workspace or Global — From the Command Palette or by right‑clicking a file or folder in the Explorer
  • Remove favorites — From the FavFile tree context menu or Command Palette
  • Click to open any favorited file or folder
  • Reveal in Explorer — From the tree context menu on a favorite
  • Missing resource handling — Resources that no longer exist are marked with a warning icon and can still be removed
  • Sort order — Manual (insertion order) or alphabetical
  • Multi-root workspace support using stable URI identity
  • No duplicates — Adding the same resource to the same section again is a no-op

Commands

CommandDescription
FavFile: Add to WorkspaceAdd the active resource (file/folder) to workspace favorites
FavFile: Add to GlobalAdd the active resource (file/folder) to global favorites
FavFile: Remove from FavoritesRemove a resource from favorites
FavFile: Reveal Active File in FavoritesSelect the active file in the FavFile tree
FavFile: RefreshManually refresh the list

Configuration

SettingTypeDefaultDescription
favoriteFiles.showRelativePathbooleantrueShow workspace-relative path next to each favorite.
favoriteFiles.sortOrder"manual" | "name""manual"Sort order. manual preserves insertion order; name sorts alphabetically.

Development

Prerequisites

  • Node.js 18+
  • VS Code 1.75+

Setup

git clone https://github.com/NooryA/FavFile
cd FavFile
npm install

Compile

npm run compile

Watch (auto-rebuild on change)

npm run watch

Run in Extension Development Host

  1. Open the FavFile folder in VS Code
  2. Press F5 (or Run > Start Debugging)
  3. In the new window, open the Explorer (file icon in the sidebar)
  4. Scroll to the FavFile section at the bottom (Workspace and Global groups)

Run Tests

npm test

Runs integration tests in a VS Code instance via @vscode/test-electron.

Lint

npm run lint

Packaging & Publishing

Package as VSIX

npm run package