Skip to content

EbiPenMan/InScope-Indicator-VSCode-Extension

Repository files navigation

InScope Indicator VSCode Extension

This extension reads a scope.txt file at the root of your workspace and decorates files and folders listed (or children of listed folders) with a badge in the Explorer.


Features

  • Automatic Decoration: Scans paths in scope.txt and adds a ✓ badge (InScope) next to matching items.
  • Live Updates: Watches scope.txt for changes and refreshes badges on-the-fly—no reload needed.
  • Path Normalization: Supports both Windows (\) and POSIX (/) separators in scope.txt.

Installation (Local Development)

  1. Clone or copy this extension into a folder.
  2. Install dependencies & compile:
    npm install
    npm run compile
  3. Package into a .vsix (requires vsce):
    npm install -g vsce
    vsce package
  4. Install the VSIX:
    code --install-extension inscope-indicator-0.0.1.vsix
  5. Reload or launch VSCode (F5) and open a workspace with a scope.txt at its root.

Usage

  1. Create a scope.txt file at the root of your workspace.
  2. Add relative paths (one per line) to files or folders you want marked:
    src/app.ts
    assets/images
    config/**/*.json
  3. Save the file—badges will appear/refresh automatically.

scope.txt Path Patterns

  • Exact files: src/index.js
  • Folders: src/components
  • Nested children: Any file/folder under listed folder will inherit the badge.

Note: Glob patterns (e.g. **/*.ts) are not supported yet.


Customization

  • Badge character: Currently a ✓. Change it in src/extension.ts under provideFileDecoration.
  • Tooltip: Modify the tooltip property to your preferred text.
  • SVG Icons: For full custom icons, consider implementing a custom Tree View instead of using FileDecorationProvider.

Troubleshooting

  • If badges don’t refresh on save:
    • Ensure scope.txt is in the workspace root.
    • Check console output in the Extension Development Host for errors.

Contributing

  1. Fork the repo
  2. Create a branch (git checkout -b feature/YourFeature)
  3. Commit your changes (git commit -m 'Add YourFeature')
  4. Push to the branch (git push origin feature/YourFeature)
  5. Open a Pull Request

License

MIT ©


Enjoy decorating your project!

About

This extension reads a `scope.txt` file at the root of your workspace and decorates files and folders listed (or children of listed folders) with a badge in the Explorer.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors