95 lines
2.6 KiB
Markdown
95 lines
2.6 KiB
Markdown
# Installation and Usage Guide
|
|
|
|
## How to Install This Extension
|
|
|
|
### Option 1: Package and Install Locally
|
|
|
|
1. **Package the extension**:
|
|
```bash
|
|
npm install -g vsce
|
|
vsce package
|
|
```
|
|
This creates a `.vsix` file.
|
|
|
|
2. **Install the VSIX file**:
|
|
- Open VS Code
|
|
- Press `Ctrl+Shift+P` (or `Cmd+Shift+P` on Mac)
|
|
- Type "Extensions: Install from VSIX"
|
|
- Select the generated `.vsix` file
|
|
|
|
### Option 2: Development Mode
|
|
|
|
1. **Open this project in VS Code**
|
|
2. **Press F5** to launch a new VS Code window with the extension loaded
|
|
3. **Open your RESX project** in the new window to test the extension
|
|
|
|
## How to Use
|
|
|
|
1. **Open a workspace** containing .resx files
|
|
2. **Edit any .resx file** and save it
|
|
3. **Watch the status bar** for regeneration progress
|
|
4. **Check the Designer.cs file** to see it was updated automatically
|
|
|
|
## Commands Available
|
|
|
|
- **`RESX Designer: Regenerate Designer.cs`** - Manually regenerate a Designer.cs file
|
|
- **`RESX Designer: Show Output`** - View extension logs
|
|
- **`RESX Designer: Reload Configuration`** - Restart the extension with new settings
|
|
|
|
## Configuration
|
|
|
|
Go to VS Code Settings and search for "resx" to configure:
|
|
|
|
- Enable/disable auto-regeneration
|
|
- Show/hide notifications
|
|
- Adjust debounce delay
|
|
- Set custom ResGen.exe paths
|
|
- Configure watch patterns
|
|
|
|
## Publishing to Marketplace
|
|
|
|
To publish this extension to the VS Code Marketplace:
|
|
|
|
1. **Create a publisher account** at https://marketplace.visualstudio.com/
|
|
2. **Update package.json** with your publisher name
|
|
3. **Get a Personal Access Token** from Azure DevOps
|
|
4. **Publish**:
|
|
```bash
|
|
vsce publish
|
|
```
|
|
|
|
## Transferring to Other Machines
|
|
|
|
### Method 1: Share the VSIX File
|
|
1. Package: `vsce package`
|
|
2. Share the `.vsix` file
|
|
3. Install on other machines using "Extensions: Install from VSIX"
|
|
|
|
### Method 2: Copy Extension Files
|
|
1. Copy this entire project folder
|
|
2. On the target machine:
|
|
```bash
|
|
npm install
|
|
npm run compile
|
|
```
|
|
3. Press F5 to test, or package with `vsce package`
|
|
|
|
### Method 3: Publish to Private Registry
|
|
- Publish to a private VS Code extension registry
|
|
- Install on other machines via the registry
|
|
|
|
## Troubleshooting
|
|
|
|
### Extension Not Activating
|
|
- Check that VS Code version is 1.101.0 or higher
|
|
- Look for errors in the Developer Console (Help → Toggle Developer Tools)
|
|
|
|
### ResGen Not Found
|
|
- Install .NET SDK from https://dotnet.microsoft.com/download
|
|
- Or set custom path in extension settings
|
|
|
|
### Files Not Regenerating
|
|
- Check the Output panel (View → Output → RESX Designer Auto-Generator)
|
|
- Verify the .resx file syntax is valid
|
|
- Try the manual regenerate command
|