iris-linker

InterSystems IRIS 开发辅助工具 · VS Code 扩展
InterSystems IRIS Development Assistant for VS Code

English | 中文

English

Features

1. CSP Resource Link Navigation

• In .csp files, Ctrl+Click on <script src="..."> and <link href="..."> references to jump directly to the target JS/CSS files.

2. Right-click Export to XML

• Right-click any supported file in the editor, file explorer, or tab title.
• Exports the server-side XML content of IRIS documents via the Atelier API (GET /api/atelier/v7/{ns}/action/xml/export/{docName}).
• Works with both isfs:// (remote) and file:// (local workspace) protocols.
• Supports: .cls .mac .int .csp .js .css .html .png .jpg .gif .bmp .ico .webp .eot .otf .ttf .woff .woff2 .pdf

3. Batch Sync to IRIS Server

• Click the ☁️ "Sync All to IRIS Server" button in the SCM (Git) view title bar.
• Detects all modified files in the Git working tree and uploads them to the IRIS server via Atelier API (PUT /api/atelier/v7/{ns}/doc/{docName}).
• Binary files (images, fonts, PDFs) are automatically Base64-encoded before upload.
• Real-time progress bar with success/failure summary.

Configuration

Server Configuration (Local Workspace)

For file:// workspaces, configure your IRIS connection in .vscode/settings.json or .code-workspace:

{
  "objectscript.conn": {
    "server": "myiris",
    "ns": "USER",
    "username": "_SYSTEM",
    "password": "SYS"
  }
}

Requirements

• VS Code ^1.110.0
• InterSystems IRIS server with Atelier API enabled

Installation

# From VSIX
code --install-extension iris-linker-0.0.7.vsix

# Or via VS Code: Extensions → ... → Install from VSIX

Development

# Install dependencies
npm install

# Compile
npm run compile

# Watch Mode
npm run watch

# Run tests
npm run test

Project Structure

iris-linker/
├── src/
│   ├── extension.ts              # Main extension entry point
│   ├── CSPResourceLinkProvider.ts # CSP link navigation provider
│   └── tool/
│       └── tool.ts               # Atelier API, Git, file utilities
├── dist/                         # Compiled output (esbuild)
├── images/
│   └── icon.png                  # Extension icon
├── package.json
├── tsconfig.json
├── esbuild.js                    # Build script
└── README.md

Publishing

# Install vsce
npm install -g @vscode/vsce

# Package
vsce package

# Publish to Marketplace
vsce publish

License

MIT

中文

功能特性

1. CSP 资源链接跳转

• 在 .csp 文件中，Ctrl+点击 <script src="..."> 和 <link href="..."> 引用，直接跳转到目标 JS/CSS 文件。

2. 右键导出到 XML

• 在编辑器、资源管理器或标签页标题右键点击任意支持的文件。
• 通过 Atelier API (GET /api/atelier/v7/{ns}/action/xml/export/{docName}) 导出 IRIS 服务端文档的 XML 内容。
• 同时支持 isfs://（远程连接）和 file://（本地工作区）两种协议。
• 支持文件类型：.cls .mac .int .csp .js .css .html .png .jpg .gif .bmp .ico .webp .eot .otf .ttf .woff .woff2 .pdf

3. 批量同步到 IRIS 服务器

• 在 SCM（Git）视图标题栏点击 ☁️ "Sync All to IRIS Server" 按钮。
• 自动检测 Git 工作树中所有变更文件，通过 Atelier API (PUT /api/atelier/v7/{ns}/doc/{docName}) 一键上传到 IRIS 服务器。
• 二进制文件（图片、字体、PDF）自动 Base64 编码后上传。
• 实时进度条显示，完成后汇总成功/失败数及详情。

配置项

本地工作区服务端配置

在 file:// 协议本地工作区中，需在 .vscode/settings.json 或 .code-workspace 中配置 IRIS 连接信息：

{
  "objectscript.conn": {
    "server": "myiris",
    "ns": "USER",
    "username": "_SYSTEM",
    "password": "SYS"
  }
}

环境要求

• VS Code ^1.110.0
• 启用了 Atelier API 的 InterSystems IRIS 服务端

安装

# 通过 VSIX 安装
code --install-extension iris-linker-0.0.7.vsix

# 或在 VS Code 中: 扩展 → ... → 从 VSIX 安装

开发

# 安装依赖
npm install

# 编译
npm run compile

# 监听模式
npm run watch

# 运行测试
npm run test

项目结构

iris-linker/
├── src/
│   ├── extension.ts              # 扩展入口
│   ├── CSPResourceLinkProvider.ts # CSP 链接跳转
│   └── tool/
│       └── tool.ts               # Atelier API、Git、文件工具
├── dist/                         # esbuild 编译输出
├── images/
│   └── icon.png                  # 插件图标
├── package.json
├── tsconfig.json
├── esbuild.js                    # 构建脚本
└── README.md

发布

# 安装 vsce
npm install -g @vscode/vsce

# 打包
vsce package

# 发布到 Marketplace
vsce publish

开源协议

MIT