intools-cli 1.0.0 → 1.0.2

package/README.md

@@ -10,6 +10,7 @@ InTools 插件开发的命令行工具，帮助你快速创建、调试、构建
 - [插件开发指南](#插件开发指南)
   - [项目结构](#项目结构)
   - [manifest.json 配置](#manifestjson-配置)
+  - [动态功能入口](#动态功能入口)
   - [开发模式](#开发模式)
   - [使用第三方库](#使用第三方库)
   - [插件 API](#插件-api)
@@ -148,6 +149,8 @@ my-plugin/
 │       ├── index.html
 │       ├── main.tsx
 │       ├── App.tsx
+│       ├── hooks/
+│       │   └── useIntools.ts
 │       └── styles.css
 ├── dist/                 # 后端构建输出
 │   └── main.js
@@ -175,6 +178,7 @@ my-plugin/
 
 ```json
 {
+  "id": "my-plugin",
   "name": "my-plugin",
   "version": "1.0.0",
   "displayName": "我的插件",
@@ -202,6 +206,7 @@ my-plugin/
 | `version` | string | ✅ | 语义化版本 (x.y.z) |
 | `displayName` | string | ✅ | 用户看到的名称 |
 | `description` | string | ✅ | 功能描述 |
+| `id` | string | ✅ | 插件唯一 ID（推荐，优先于 name） |
 | `main` | string | ✅ | 后端入口文件路径 |
 | `ui` | string | ❌ | UI 文件路径（有界面时必填） |
 | `icon` | string/object | ❌ | 插件图标 |
@@ -242,6 +247,8 @@ my-plugin/
 | `code` | string | ✅ | 功能代码，传递给插件 |
 | `explain` | string | ✅ | 功能说明，显示给用户 |
 | `cmds` | array | ✅ | 触发命令列表 |
+| `mode` | string | ❌ | `ui` / `silent` / `detached` |
+| `route` | string | ❌ | UI 路由（用于子窗口或页内路由） |
 
 #### 触发命令类型 (cmds)
 
@@ -272,6 +279,26 @@ my-plugin/
 
 ---
 
+### 动态功能入口
+
+后端可以通过 `context.api.features` 动态添加/移除功能入口：
+
+```ts
+export function onLoad(context?: any) {
+  const features = context?.api?.features
+  if (!features) return
+
+  features.setFeature({
+    code: 'dynamic:hello',
+    explain: '动态指令：hello',
+    mode: 'silent',
+    cmds: ['hello', { type: 'keyword', value: 'hi' }]
+  })
+}
+```
+
+---
+
 ### 开发模式
 
 #### 启动开发服务器
@@ -337,6 +364,7 @@ npm run build
 ### 插件 API
 
 插件在沙箱中运行，通过 `context.api` 访问各种 API。
+完整类型请参考模板生成的 `src/types/intools.d.ts`。
 
 #### 剪贴板 API (clipboard)
 
@@ -410,10 +438,10 @@ await http.put(url, body?, headers?)
 await http.delete(url, headers?)
 ```
 
-#### 窗口 API (window)
+#### 窗口 API (window，仅 UI)
 
 ```typescript
-const { window } = context.api
+const { window } = window.intools
 
 // 设置窗口大小
 await window.setSize(600, 400)
@@ -422,6 +450,21 @@ await window.setSize(600, 400)
 await window.hide()
 ```
 
+#### 输入 API (input，仅 UI)
+
+```typescript
+const { input } = window.intools
+
+await input.hideMainWindowPasteText('Hello')
+await input.simulateKeyboardTap('A', 'cmd')
+```
+
+#### 权限 API (permission，仅 UI)
+
+```typescript
+const status = await window.intools?.permission?.getStatus('screen')
+```
+
 #### 文件系统 API (filesystem)
 
 ```typescript
@@ -768,7 +811,7 @@ A: 修改 `manifest.json` 中的 `version` 字段，重新打包后安装即可
 
 ### Q: 插件可以访问系统命令吗？
 
-A: 出于安全考虑，默认不开放 `shell` 权限。如需使用，请在 `manifest.json` 的 `permissions` 中声明，并等待审核。
+A: 前端通过 `window.intools.shell` 调用系统能力；后端运行在沙箱中，仅能使用 `context.api` 暴露的接口。具体能力以 `intools.d.ts` 为准。
 
 ---
 

package/dist/commands/create/assets.js

@@ -0,0 +1,53 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.copyDefaultIcon = copyDefaultIcon;
+const fs = __importStar(require("fs-extra"));
+const path = __importStar(require("path"));
+const chalk_1 = __importDefault(require("chalk"));
+function getAssetsDir() {
+    return path.resolve(__dirname, '../../../assets');
+}
+function copyDefaultIcon(targetDir) {
+    const defaultIconPath = path.join(getAssetsDir(), 'default-icon.png');
+    const targetIconPath = path.join(targetDir, 'icon.png');
+    if (fs.existsSync(defaultIconPath)) {
+        fs.copyFileSync(defaultIconPath, targetIconPath);
+        console.log(chalk_1.default.green('  ✓ icon.png'));
+    }
+}

package/dist/commands/create/basic.js

@@ -0,0 +1,58 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createBasicProject = createBasicProject;
+const fs = __importStar(require("fs-extra"));
+const path = __importStar(require("path"));
+const chalk_1 = __importDefault(require("chalk"));
+const assets_1 = require("./assets");
+const basic_1 = require("./templates/basic");
+async function createBasicProject(targetDir, name) {
+    fs.mkdirSync(targetDir, { recursive: true });
+    fs.mkdirSync(path.join(targetDir, 'src'));
+    (0, assets_1.copyDefaultIcon)(targetDir);
+    const manifest = (0, basic_1.buildBasicManifest)(name);
+    fs.writeJsonSync(path.join(targetDir, 'manifest.json'), manifest, { spaces: 2 });
+    console.log(chalk_1.default.green('  ✓ manifest.json'));
+    const pkg = (0, basic_1.buildBasicPackageJson)(name);
+    fs.writeJsonSync(path.join(targetDir, 'package.json'), pkg, { spaces: 2 });
+    console.log(chalk_1.default.green('  ✓ package.json'));
+    const mainTs = (0, basic_1.buildBasicMain)(name);
+    fs.writeFileSync(path.join(targetDir, 'src/main.ts'), mainTs);
+    console.log(chalk_1.default.green('  ✓ src/main.ts'));
+}

package/dist/commands/create/index.js

@@ -0,0 +1,68 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.create = create;
+const fs = __importStar(require("fs-extra"));
+const path = __importStar(require("path"));
+const chalk_1 = __importDefault(require("chalk"));
+const basic_1 = require("./basic");
+const react_1 = require("./react");
+async function create(name, options) {
+    const targetDir = path.resolve(process.cwd(), name);
+    if (fs.existsSync(targetDir)) {
+        console.log(chalk_1.default.red(`错误: 目录 ${name} 已存在`));
+        process.exit(1);
+    }
+    const template = options.template || 'react';
+    console.log(chalk_1.default.blue(`创建插件项目: ${name}`));
+    console.log(chalk_1.default.gray(`模板: ${template}`));
+    console.log();
+    if (template === 'react') {
+        await (0, react_1.createReactProject)(targetDir, name);
+    }
+    else {
+        await (0, basic_1.createBasicProject)(targetDir, name);
+    }
+    console.log();
+    console.log(chalk_1.default.green('插件创建成功!'));
+    console.log();
+    console.log('下一步:');
+    console.log(chalk_1.default.cyan(`  cd ${name}`));
+    console.log(chalk_1.default.cyan('  npm install'));
+    console.log(chalk_1.default.cyan('  npm run dev'));
+}

package/dist/commands/create/react.js

@@ -0,0 +1,106 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createReactProject = createReactProject;
+const fs = __importStar(require("fs-extra"));
+const path = __importStar(require("path"));
+const chalk_1 = __importDefault(require("chalk"));
+const assets_1 = require("./assets");
+const react_1 = require("./templates/react");
+async function createReactProject(targetDir, name) {
+    fs.mkdirSync(targetDir, { recursive: true });
+    fs.mkdirSync(path.join(targetDir, 'src'));
+    fs.mkdirSync(path.join(targetDir, 'src/ui'));
+    (0, assets_1.copyDefaultIcon)(targetDir);
+    createReactManifest(targetDir, name);
+    createReactPackageJson(targetDir, name);
+    createTsConfig(targetDir);
+    createViteConfig(targetDir);
+    createBackendMain(targetDir, name);
+    createReactUI(targetDir, name);
+    createIntoolsTypes(targetDir);
+}
+function createReactManifest(targetDir, name) {
+    const manifest = (0, react_1.buildReactManifest)(name);
+    fs.writeJsonSync(path.join(targetDir, 'manifest.json'), manifest, { spaces: 2 });
+    console.log(chalk_1.default.green('  ✓ manifest.json'));
+}
+function createReactPackageJson(targetDir, name) {
+    const pkg = (0, react_1.buildReactPackageJson)(name);
+    fs.writeJsonSync(path.join(targetDir, 'package.json'), pkg, { spaces: 2 });
+    console.log(chalk_1.default.green('  ✓ package.json'));
+}
+function createTsConfig(targetDir) {
+    const tsconfig = (0, react_1.buildTsConfig)();
+    fs.writeJsonSync(path.join(targetDir, 'tsconfig.json'), tsconfig, { spaces: 2 });
+    console.log(chalk_1.default.green('  ✓ tsconfig.json'));
+}
+function createViteConfig(targetDir) {
+    const viteConfig = (0, react_1.buildViteConfig)();
+    fs.writeFileSync(path.join(targetDir, 'vite.config.ts'), viteConfig);
+    console.log(chalk_1.default.green('  ✓ vite.config.ts'));
+}
+function createBackendMain(targetDir, name) {
+    const mainTs = (0, react_1.buildBackendMain)(name);
+    fs.writeFileSync(path.join(targetDir, 'src/main.ts'), mainTs);
+    console.log(chalk_1.default.green('  ✓ src/main.ts'));
+}
+function createReactUI(targetDir, name) {
+    fs.mkdirSync(path.join(targetDir, 'src/ui/hooks'), { recursive: true });
+    const indexHtml = (0, react_1.buildIndexHtml)(name);
+    fs.writeFileSync(path.join(targetDir, 'src/ui/index.html'), indexHtml);
+    console.log(chalk_1.default.green('  ✓ src/ui/index.html'));
+    const mainTsx = (0, react_1.buildMainTsx)();
+    fs.writeFileSync(path.join(targetDir, 'src/ui/main.tsx'), mainTsx);
+    console.log(chalk_1.default.green('  ✓ src/ui/main.tsx'));
+    const appTsx = (0, react_1.buildAppTsx)(name);
+    fs.writeFileSync(path.join(targetDir, 'src/ui/App.tsx'), appTsx);
+    console.log(chalk_1.default.green('  ✓ src/ui/App.tsx'));
+    const stylesCss = (0, react_1.buildStylesCss)();
+    fs.writeFileSync(path.join(targetDir, 'src/ui/styles.css'), stylesCss);
+    console.log(chalk_1.default.green('  ✓ src/ui/styles.css'));
+    const useIntools = (0, react_1.buildUseIntools)();
+    fs.writeFileSync(path.join(targetDir, 'src/ui/hooks/useIntools.ts'), useIntools);
+    console.log(chalk_1.default.green('  ✓ src/ui/hooks/useIntools.ts'));
+}
+function createIntoolsTypes(targetDir) {
+    fs.mkdirSync(path.join(targetDir, 'src/types'), { recursive: true });
+    const typesDts = (0, react_1.buildIntoolsTypes)();
+    fs.writeFileSync(path.join(targetDir, 'src/types/intools.d.ts'), typesDts);
+    console.log(chalk_1.default.green('  ✓ src/types/intools.d.ts'));
+}

package/dist/commands/create/templates/basic.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildBasicManifest = buildBasicManifest;
+exports.buildBasicPackageJson = buildBasicPackageJson;
+exports.buildBasicMain = buildBasicMain;
+function buildBasicManifest(name) {
+    return {
+        id: name,
+        name,
+        version: '1.0.0',
+        displayName: name,
+        description: '插件描述',
+        main: 'dist/main.js',
+        icon: 'icon.png',
+        // 独立窗口配置（可选）
+        // window: {
+        //   width: 800,       // 默认宽度
+        //   height: 600,      // 默认高度
+        //   minWidth: 400,    // 最小宽度
+        //   minHeight: 300,   // 最小高度
+        //   maxWidth: 1200,   // 最大宽度
+        //   maxHeight: 900    // 最大高度
+        // },
+        features: [
+            {
+                code: 'main',
+                explain: '主功能',
+                cmds: [{ type: 'keyword', value: name }]
+            }
+        ]
+    };
+}
+function buildBasicPackageJson(name) {
+    return {
+        name,
+        version: '1.0.0',
+        scripts: {
+            build: 'esbuild src/main.ts --bundle --platform=node --outfile=dist/main.js',
+            dev: 'intools dev',
+            pack: 'intools pack'
+        },
+        devDependencies: {
+            esbuild: '^0.20.0',
+            typescript: '^5.0.0'
+        }
+    };
+}
+function buildBasicMain(name) {
+    return `interface PluginContext {
+  api: {
+    clipboard: {
+      readText: () => string
+      writeText: (text: string) => Promise<void>
+      readImage: () => ArrayBuffer | null
+      getFormat: () => string
+    }
+    notification: {
+      show: (message: string, type?: string) => void
+    }
+  }
+  input?: string
+  featureCode?: string
+}
+
+export function onLoad() {
+  console.log('[${name}] 插件已加载')
+}
+
+export function onUnload() {
+  console.log('[${name}] 插件已卸载')
+}
+
+export function onEnable() {
+  console.log('[${name}] 插件已启用')
+}
+
+export function onDisable() {
+  console.log('[${name}] 插件已禁用')
+}
+
+export async function run(context: PluginContext) {
+  const { clipboard, notification } = context.api
+  const text = context.input || clipboard.readText()
+
+  // 在这里实现你的逻辑
+  const result = text.toUpperCase()
+
+  await clipboard.writeText(result)
+  notification.show('处理完成')
+}
+
+const plugin = { onLoad, onUnload, onEnable, onDisable, run }
+export default plugin
+`;
+}