feat: telemetry

Author: typed-sigterm

.github/workflows/release.yml

@@ -9,6 +9,8 @@ jobs:
     runs-on: ubuntu-latest
     permissions:
       contents: write
+    env:
+      RUNNER_MIXPANEL_TOKEN: ${{ vars.RUNNER_MIXPANEL_TOKEN }}
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
       - uses: pnpm/action-setup@a7487c7e89a18df4991f7f222e4898a00d66ddda # v4.1.0
@@ -28,17 +30,17 @@ jobs:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           release-url: ${{ github.event.release.url }}
 
-      - name: Publish to Open VSX Registry
+      - name: Publish to Visual Studio Marketplace
         uses: HaaLeo/publish-vscode-extension@ca5561daa085dee804bf9f37fe0165785a9b14db # v2
-        id: publishToOpenVSX
         with:
           extensionFile: extension.vsix
-          pat: ${{ secrets.OPEN_VSX_TOKEN }}
-          registryUrl: https://open-vsx.org
+          pat: ${{ secrets.VSCE_PAT }}
+          registryUrl: https://marketplace.visualstudio.com
 
-      - name: Publish to Visual Studio Marketplace
+      - name: Publish to Open VSX Registry
         uses: HaaLeo/publish-vscode-extension@ca5561daa085dee804bf9f37fe0165785a9b14db # v2
+        id: publishToOpenVSX
         with:
           extensionFile: extension.vsix
-          pat: ${{ secrets.VSCE_PAT }}
-          registryUrl: https://marketplace.visualstudio.com
+          pat: ${{ secrets.OPEN_VSX_TOKEN }}
+          registryUrl: https://open-vsx.org

.gitignore

@@ -27,3 +27,4 @@ dist-ssr
 
 *.tsbuildinfo
 extension.vsix
+.env

README.md

@@ -48,6 +48,12 @@ For a quick start guide:
 
 All configuration descriptions can be accessed via the VS Code settings UI (<kbd>Ctrl</kbd> + <kbd>,</kbd>) by searching for `@ext:typed-sigterm.oi-runner-2`.
 
+## Telemetry
+
+OI Runner++ collects some telemetry data to help improve the extension (e.g., understanding which VS Code versions need to be supported). You can search for `mixpanel.track` in the source code repository to see what information is collected.
+
+Telemetry data does not include personal or sensitive information and is used for statistical purposes only. You can disable telemetry by setting VS Code's `telemetry.feedback.enabled` to `false` and restarting VS Code.
+
 ## Credits
 
 This project is deeply inspired by [OI Runner](https://github.com/CmdBlockZQG/oi-runner). Thanks to [@CmdBlockZQG](https://github.com/CmdBlockZQG) and other contributors of OI Runner.

README.zh-CN.md

@@ -48,6 +48,12 @@
 
 所有配置说明都可通过 VS Code 设置界面 (<kbd>Ctrl</kbd> + <kbd>,</kbd>) 访问，搜索 `@ext:typed-sigterm.oi-runner-2` 即可找到。
 
+## 遥测
+
+OI Runner++ 会收集一些遥测数据以帮助改进插件（比如了解需要兼容到哪个 VS Code 版本），你可以在源代码仓库中搜索 `mixpanel.track` 收集的信息。
+
+遥测收集的信息不包含个人和敏感信息，仅用于统计目的。你可以在设置 VS Code `telemetry.feedback.enabled` 为 `false` 并重启 VS Code 来禁用遥测。
+
 ## 鸣谢
 
 OI Runner++ 深受 [OI Runner](https://github.com/CmdBlockZQG/oi-runner) 启发，感谢 [@CmdBlockZQG](https://github.com/CmdBlockZQG) 及其他贡献者。

extension/config.ts

@@ -1,9 +1,23 @@
+import type { ConfigLevel } from '../shared/events';
 import path from 'node:path';
 import * as vscode from 'vscode';
 import { z } from 'zod/v4';
 import { contributes } from '../package.json';
 import { cachedFn } from './utils';
 
+export function isConfigured(): ConfigLevel {
+  const info = vscode.workspace.getConfiguration().inspect('oi-runner-2');
+  if (!info)
+    return false;
+  if (info.workspaceFolderValue)
+    return 'workspace-folder';
+  if (info.workspaceValue)
+    return 'workspace';
+  if (info.globalValue)
+    return 'global';
+  return false;
+}
+
 const ConfigManifest = contributes.configuration[0].properties;
 
 const CommandSchema = z.tuple([z.string(), z.array(z.string())]);

extension/webview.ts

@@ -1,7 +1,8 @@
 import type { EventMessage } from '../shared/events';
 import * as vscode from 'vscode';
+import { version } from '../package.json';
 import { EventMarker } from '../shared/events';
-import { getAutoSave, getConfiguredDefaultTask, getConfiguredTasks, getDefaultTask } from './config';
+import { getAutoSave, getConfiguredDefaultTask, getConfiguredTasks, getDefaultTask, isConfigured } from './config';
 import { Runner } from './runner';
 import { logger } from './utils';
 
@@ -129,6 +130,14 @@ class PanelProvider implements vscode.WebviewViewProvider, vscode.Disposable {
             compilable: !!v.compile,
           })),
           extensions: Object.keys(getConfiguredDefaultTask()),
+
+          id: vscode.env.machineId,
+          telemetry: vscode.env.isTelemetryEnabled && {
+            'Version': version,
+            'VSCode Version': vscode.version,
+            'Language': vscode.env.language,
+            'Configured': isConfigured(),
+          },
         });
         this._handleActiveEditorChange(vscode.window.activeTextEditor);
         break;

package.json

@@ -237,6 +237,8 @@
     "@iconify-prerendered/vue-line-md": "^0.28.1746598136",
     "@tomjs/vite-plugin-vscode": "^4.2.1",
     "@typed-sigterm/eslint-config": "^1.4.1",
+    "@types/js-md5": "^0.7.2",
+    "@types/mixpanel-browser": "^2.60.0",
     "@types/node": "^22.15.29",
     "@types/ps-tree": "^1.1.6",
     "@types/vscode": "^1.94.0",
@@ -248,6 +250,8 @@
     "consola": "^3.4.2",
     "eslint": "^9.28.0",
     "husky": "^9.1.7",
+    "js-md5": "^0.8.3",
+    "mixpanel-browser": "^2.65.0",
     "monaco-editor": "^0.52.2",
     "nanoid": "^5.1.5",
     "ps-tree": "^1.2.0",