Track Current File

Version: 0.0.2
Repository: GitHub: File-Tracker-Extension

Overview

The Track Current File extension for VSCode tracks the currently active file in your editor and automatically updates a fileMetadata.json file in your workspace directory. This is particularly useful for tools like CLI applications that need context about the active file (e.g., file name, path, or selected lines).

The fileMetadata.json file is updated dynamically when:

1. You switch between files.
2. You select or highlight lines in a file.
3. You run the Current File Tracker command from the Command Palette.

Fields Tracked

The metadata written to fileMetadata.json includes the following fields:

How It Works

1. Automatic Updates:

   • The fileMetadata.json file is automatically updated whenever you:
     • Open a new file.
     • Switch between files.
     • Highlight or select lines in a file.

2. Command: Current File Tracker:

   • Manually trigger metadata updates using the Command Palette:
     • Open the Command Palette (Cmd+Shift+P or Ctrl+Shift+P).
     • Search for and select Current File Tracker.
   • This is useful if you want to ensure metadata is updated on-demand.

Example fileMetadata.json

Here’s an example of what the fileMetadata.json file might look like:

{
    "fileName": "example.js",
    "filePath": "/Users/example/project/example.js",
    "lines": {
        "start": 5,
        "end": 15
    },
    "timestamp": "2025-01-07T20:00:00Z",
    "language": "javascript",
    "workspace": "/Users/example/project",
    "fileSize": 1456,
    "lastModified": "2025-01-07T19:45:00Z"
}

Usage Instructions

1. Install the extension in VSCode:

   • Install the .vsix file through the Extensions view in VSCode or download it from the Marketplace.

2. Run the command once:

   • Run the Current File Tracker command once from the Command Palette (Cmd+Shift+P or Ctrl+Shift+P)

3. Open any file in your editor:

   • The extension will automatically detect the active file and start updating metadata.

4. Start working:

   • The fileMetadata.json file will be automatically updated whenever you open a file or select text in the editor.

Notes

1. Add fileMetadata.json to .gitignore:
   • To avoid tracking workspace-specific metadata in your version control system, add the following line to your .gitignore file:

     fileMetadata.json
     

License

This extension is open-source and available under the MIT License. See the LICENSE file for details.

Contributing

Contributions are welcome! If you'd like to contribute, please open an issue or submit a pull request on GitHub.