Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Directory.Packages.props
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@
<PackageVersion Include="Serilog.Settings.Configuration" Version="10.0.0" />
<PackageVersion Include="Slugify.Core" Version="5.1.1" />
<PackageVersion Include="Swashbuckle.AspNetCore.SwaggerUI" Version="10.1.7" />
<PackageVersion Include="Westwind.Utilities" Version="5.2.8.1" />
<PackageVersion Include="Westwind.Utilities" Version="5.3.0" />
<PackageVersion Include="WireMock.Net" Version="2.2.0" />
<PackageVersion Include="YamlDotNet" Version="17.0.0" />
<PackageVersion Include="YamlDotNet" Version="17.0.1" />
<PackageVersion Include="Microsoft.CodeAnalysis" Version="5.3.0" />
<PackageVersion Include="CsvHelper" Version="33.1.0" />
<PackageVersion Include="Jint" Version="4.7.1" />
<PackageVersion Include="Jint" Version="4.8.0" />
<PackageVersion Include="IronPython" Version="3.4.2" />
</ItemGroup>
<ItemGroup Condition="'$(ProjectName.ToLower().Contains(`test`))' == 'true'">
Expand Down
4 changes: 4 additions & 0 deletions DxWorks.ScriptBee.Plugin.Api/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Changed

- update Westwind.Utilities to 5.3.0

## [2.0.0]

### Changed
Expand Down
4 changes: 4 additions & 0 deletions Integrations/VS-Code/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Added

- `scriptbee.enableLiveUpdates` to enable live updates for project script events of creation, update, and deletion.

## [1.0.0]

### Added
Expand Down
24 changes: 16 additions & 8 deletions Integrations/VS-Code/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ For full documentation, visit [dxworks.org/scriptbee](https://dxworks.org/script
- **Compare with Remote**: Open a native VS Code diff view to see exactly what changed on the server.
- **Project Folder Management**: Easily open your project's script folder in VS Code.
- **Generate Classes**: Trigger model class generation from a running ScriptBee instance.
- **Live Updates**: Automatically sync changes from the server in real-time.

### Script Synchronization

Expand All @@ -35,21 +36,27 @@ For full documentation, visit [dxworks.org/scriptbee](https://dxworks.org/script
Sync metadata (`.sb.meta` files) is stored directly alongside your scripts within the project folder. This ensures that:

- Metadata is natively tied to your files, making synchronization reliable even in complex multi-root workspaces.
- **Hidden from VS Code**: These files are automatically added to VS Code's `files.exclude` setting, keeping your sidebar clean.
- **Important**: You should add `**/*.sb.meta` to your `.gitignore` file. These files are meant for local synchronization only and should not be committed to version control.
- The metadata maps local files to their remote counterparts on the ScriptBee server, allowing for efficient syncing and change detection.
- **Hidden from VS Code**: These files are automatically added to VS Code's `files.exclude` setting, keeping your
sidebar clean.
- **Important**: You should add `**/*.sb.meta` to your `.gitignore` file. These files are meant for local
synchronization only and should not be committed to version control.
- The metadata maps local files to their remote counterparts on the ScriptBee server, allowing for efficient syncing and
change detection.

### Comparison and Diffs

**Compare with Remote**: Right-click any script in the explorer or editor and select `ScriptBee: Compare with Remote`. This opens a native VS Code diff view, allowing you to see exactly what changed on the server before you decide to pull or push.
**Compare with Remote**: Right-click any script in the explorer or editor and select `ScriptBee: Compare with Remote`.
This opens a native VS Code diff view, allowing you to see exactly what changed on the server before you decide to pull
or push.

## Configuration

This extension can be configured via VS Code settings:

| Setting | Description | Default |
| ------------------------- | ----------------------------------------------------------------------- | -------------- |
| `scriptbee.workspaceRoot` | The root folder where ScriptBee projects and generated code are stored. | `~/.scriptbee` |
| Setting | Description | Default |
| ----------------------------- | ---------------------------------------------------------------------------------------------- | -------------- |
| `scriptbee.workspaceRoot` | The root folder where ScriptBee projects and generated code are stored. | `~/.scriptbee` |
| `scriptbee.enableLiveUpdates` | Enable real-time updates for script lifecycle events (creation, update, deletion) via SignalR. | `true` |

## Getting Started

Expand Down Expand Up @@ -81,7 +88,8 @@ This extension can be configured via VS Code settings:

## Requirements

You need a running instance of the ScriptBee Backend API. See the [installation guide](https://dxworks.org/scriptbee/installation/installation) for setup instructions.
You need a running instance of the ScriptBee Backend API. See
the [installation guide](https://dxworks.org/scriptbee/installation/installation) for setup instructions.

## Known Issues

Expand Down
165 changes: 164 additions & 1 deletion Integrations/VS-Code/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions Integrations/VS-Code/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@
"type": "string",
"default": "~/.scriptbee",
"description": "The root folder where ScriptBee projects and generated code are stored."
},
"scriptbee.enableLiveUpdates": {
"type": "boolean",
"default": true,
"description": "Enable real-time updates for script lifecycle events (creation, update, deletion)."
}
}
},
Expand Down Expand Up @@ -235,6 +240,7 @@
"prettier:fix": "prettier --write ."
},
"dependencies": {
"@microsoft/signalr": "^10.0.0",
"axios": "^1.15.0"
},
"devDependencies": {
Expand Down
7 changes: 7 additions & 0 deletions Integrations/VS-Code/src/api/axiosInstance.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
import axios from 'axios';
import { ClientIdService } from '../services/clientIdService';

const axiosInstance = axios.create();

axiosInstance.interceptors.request.use((config) => {
config.headers = config.headers || {};
config.headers['X-Client-Id'] = ClientIdService.clientId;
return config;
});

export default axiosInstance;
Loading
Loading