VS Config Extension

Configuration

CSV Directory Setup

The extension requires a valid CSV directory path to function properly. You can configure this in two ways:

1. Initial Setup: When first installing the extension, you'll be prompted to enter your CSV directory path.

2. Manual Configuration: You can update your CSV directory at any time by:

   • Opening the Command Palette (Ctrl+Shift+P or Cmd+Shift+P)
   • Typing "VS Config: Configure CSV Directory"
   • Entering your new CSV directory path

The CSV directory must:

• Exist on your filesystem
• Contain a valid package.json file

If an invalid path is provided, you'll be prompted to enter a new one.

Usage

The extension activates automatically on any .json or .json5 file.

Go to definition

This aims to help navigate heavily templated reports by providing support for the "Go to definition" feature. This can be activated by clicking on the definition and pressing F12 or by CTRL + clicking (right clicking on Windows) on the definition and selecting "Go to definition" in the context menu.

The extension also supports "peak" which opens a small window to the definition instead of directly opening the file. This can be accessed by either clicking on the definition and pressing OPTIONS + F12 or by CTRL + clicking (right clicking on Windows) and selecting the "peak" option from the context menu.

Development

Setup

1. Clone the repository
2. Run npm install to install dependencies
3. Open the project in VS Code (recommended) as it provides the best development experience for VS Code extensions
4. Press F5 to start debugging - this will open a new VS Code window with the extension loaded

Testing Changes

1. Make your changes to the code
2. Press F5 to launch a new VS Code window with your changes
3. Test your changes in the new window
4. If you need to make more changes, close the debug window, make your changes, and press F5 again

Note: While Cursor can run the extension, it currently cannot install VSIX files directly. Use VS Code for development and testing.

Publishing Updates

1. Update version numbers:

   • Increment the version in package.json
   • Update package-lock.json by running npm install

2. Build and publish:

   npm run prepublishOnly  # Creates extension.vsix
   

3. Upload to Azure DevOps:

   • Go to your organization's Azure DevOps marketplace
   • Navigate to Manage Extensions
   • Click "..." next to your extension
   • Select "Update"
   • Upload the new .vsix file
   • Submit for review

Note: Always increment the version number when publishing updates. Azure DevOps will reject updates with the same version number.

Note: The extension no longer uses a client-server architecture, making the debugging process much simpler.