intools-cli 1.0.5 → 1.0.7

package/PLUGIN_API.md

@@ -49,6 +49,7 @@
 | description | string | | 插件描述 |
 | main | string | ✓ | 后端入口文件 |
 | ui | string | | UI 入口文件 |
+| preload | string | | 自定义 preload 脚本（可使用 Node.js） |
 | icon | string/object | | 插件图标（路径/URL/SVG） |
 | features | array | ✓ | 功能入口列表 |
 | pluginSetting | object | | 插件行为设置 |
@@ -140,6 +141,57 @@
 "icon": { "type": "svg", "value": "<svg>...</svg>" }
 ```
 
+## Preload 配置（自定义 Node.js 能力）
+
+配置自定义 preload 脚本，可在渲染进程中直接使用 Node.js 能力。
+
+### 配置方式
+
+```json
+{
+  "preload": "preload.js"
+}
+```
+
+### preload.js 示例
+
+```javascript
+// preload.js - 遵循 CommonJS 规范
+const fs = require('fs')
+const os = require('os')
+const path = require('path')
+
+// 通过 window 暴露给前端
+window.myApi = {
+  getHomeDir: () => os.homedir(),
+  readFile: (filePath) => fs.readFileSync(filePath, 'utf-8'),
+  platform: process.platform
+}
+```
+
+### 前端调用
+
+```typescript
+// 在 UI 组件中使用
+const homeDir = window.myApi?.getHomeDir()
+const content = window.myApi?.readFile('/path/to/file.txt')
+
+// 核心 API 仍然可用
+const text = await window.intools.clipboard.readText()
+```
+
+### 注意事项
+
+| 项目 | 说明 |
+|------|------|
+| 文件格式 | CommonJS 格式，使用 `require()` 导入模块 |
+| 代码规范 | 必须是清晰可读的源码，**不能压缩/混淆** |
+| 可用模块 | Node.js 原生模块 + 第三方 npm 模块 |
+| API 暴露 | 通过 `window.xxx` 暴露自定义 API |
+| 核心 API | `window.intools` 核心 API 仍然可用 |
+| 安全性 | 有完整 Node.js 权限，需注意安全风险 |
+| 打包 | 运行 `intools pack` 会自动包含 preload 文件 |
+
 ---
 
 # 第二部分：API 参考
@@ -163,7 +215,7 @@
 | 方法 | 环境 | 说明 |
 |------|------|------|
 | `readFile(path, encoding?)` | R/B | 读取文件 → `Buffer | string` |
-| `writeFile(path, data, encoding?)` | R/B | 写入文件 |
+| `writeFile(path, data, encoding?)` | R/B | 写入文件 (`data`: `string \| Buffer \| ArrayBuffer`) |
 | `exists(path)` | R/B | 检查是否存在 → `boolean` |
 | `unlink(path)` | R/B | 删除文件 |
 | `readdir(path)` | R/B | 读取目录 → `string[]` |
@@ -229,10 +281,10 @@
 
 | 方法 | 环境 | 说明 |
 |------|------|------|
-| `request(options)` | R/B | 发起请求 → `HttpResponse` |
+| `request(options)` | R/B | 发起请求 (`body`: `string \| object \| Buffer \| ArrayBuffer`) → `HttpResponse` |
 | `get(url, headers?)` | R/B | GET 请求 |
-| `post(url, body?, headers?)` | R/B | POST 请求 |
-| `put(url, body?, headers?)` | R/B | PUT 请求 |
+| `post(url, body?, headers?)` | R/B | POST 请求 (`body`: `string \| object \| Buffer \| ArrayBuffer`) |
+| `put(url, body?, headers?)` | R/B | PUT 请求 (`body`: `string \| object \| Buffer \| ArrayBuffer`) |
 | `delete(url, headers?)` | R/B | DELETE 请求 |
 
 **HttpRequestOptions**: `url`, `method`, `headers`, `body`, `timeout`  
@@ -280,7 +332,7 @@
 | 方法 | 环境 | 说明 |
 |------|------|------|
 | `hideMainWindowPasteText(text)` | R/B | 粘贴文本到焦点应用 |
-| `hideMainWindowPasteImage(image)` | R/B | 粘贴图片到焦点应用 |
+| `hideMainWindowPasteImage(image)` | R/B | 粘贴图片到焦点应用 (`image`: `Path \| Buffer \| DataURL \| ArrayBuffer`) |
 | `hideMainWindowPasteFile(paths)` | R/B | 粘贴文件到焦点应用 |
 | `hideMainWindowTypeString(text)` | R/B | 模拟键入文本 |
 | `simulateKeyboardTap(key, ...modifiers)` | R/B | 模拟按键 |
@@ -437,7 +489,7 @@
 |------|------|------|
 | `isEncryptionAvailable()` | R/B | 检查加密可用性 |
 | `encryptString(plainText)` | R/B | 加密字符串 → `Buffer` |
-| `decryptString(encrypted)` | R/B | 解密字符串 → `string` |
+| `decryptString(encrypted)` | R/B | 解密字符串 (`encrypted`: `Buffer \| ArrayBuffer`) → `string` |
 
 ---
 

package/dist/commands/create/basic.js

@@ -55,6 +55,14 @@ async function createBasicProject(targetDir, name) {
     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'));
+    // 创建 .gitignore
+    const gitignore = (0, basic_1.buildGitignore)();
+    fs.writeFileSync(path.join(targetDir, '.gitignore'), gitignore);
+    console.log(chalk_1.default.green('  ✓ .gitignore'));
+    // 创建 README.md
+    const readme = (0, basic_1.buildBasicReadme)(name);
+    fs.writeFileSync(path.join(targetDir, 'README.md'), readme);
+    console.log(chalk_1.default.green('  ✓ README.md'));
     // 复制 API 参考文档
     const apiDocSrc = path.join(__dirname, '../../..', 'PLUGIN_API.md');
     if (fs.existsSync(apiDocSrc)) {

package/dist/commands/create/react.js

@@ -54,6 +54,8 @@ async function createReactProject(targetDir, name) {
     createBackendMain(targetDir, name);
     createReactUI(targetDir, name);
     createIntoolsTypes(targetDir);
+    createGitignore(targetDir);
+    createReadme(targetDir, name);
     // 复制 API 参考文档
     const apiDocSrc = path.join(__dirname, '../../..', 'PLUGIN_API.md');
     if (fs.existsSync(apiDocSrc)) {
@@ -110,3 +112,13 @@ function createIntoolsTypes(targetDir) {
     fs.writeFileSync(path.join(targetDir, 'src/types/intools.d.ts'), typesDts);
     console.log(chalk_1.default.green('  ✓ src/types/intools.d.ts'));
 }
+function createGitignore(targetDir) {
+    const gitignore = (0, react_1.buildGitignore)();
+    fs.writeFileSync(path.join(targetDir, '.gitignore'), gitignore);
+    console.log(chalk_1.default.green('  ✓ .gitignore'));
+}
+function createReadme(targetDir, name) {
+    const readme = (0, react_1.buildReactReadme)(name);
+    fs.writeFileSync(path.join(targetDir, 'README.md'), readme);
+    console.log(chalk_1.default.green('  ✓ README.md'));
+}

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

@@ -3,6 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildBasicManifest = buildBasicManifest;
 exports.buildBasicPackageJson = buildBasicPackageJson;
 exports.buildBasicMain = buildBasicMain;
+exports.buildGitignore = buildGitignore;
+exports.buildBasicReadme = buildBasicReadme;
 function buildBasicManifest(name) {
     return {
         id: name,
@@ -93,3 +95,68 @@ const plugin = { onLoad, onUnload, onEnable, onDisable, run }
 export default plugin
 `;
 }
+function buildGitignore() {
+    return `node_modules
+dist
+.DS_Store
+*.log
+`;
+}
+function buildBasicReadme(name) {
+    return `# ${name}
+
+插件描述
+
+## 功能特性
+
+- 功能 1
+- 功能 2
+- 功能 3
+
+## 触发方式
+
+- \`${name}\` - 主功能
+
+## 开发
+
+### 安装依赖
+
+\`\`\`bash
+npm install
+\`\`\`
+
+### 开发模式
+
+\`\`\`bash
+npm run dev
+\`\`\`
+
+### 构建
+
+\`\`\`bash
+npm run build
+\`\`\`
+
+### 打包
+
+\`\`\`bash
+npm run pack
+\`\`\`
+
+## 项目结构
+
+\`\`\`
+${name}/
+├── manifest.json              # 插件配置
+├── package.json
+├── src/
+│   └── main.ts                # 后端入口
+├── dist/                      # 构建输出
+└── icon.png                   # 插件图标
+\`\`\`
+
+## 许可证
+
+MIT License
+`;
+}

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

@@ -10,6 +10,8 @@ exports.buildMainTsx = buildMainTsx;
 exports.buildAppTsx = buildAppTsx;
 exports.buildStylesCss = buildStylesCss;
 exports.buildUseIntools = buildUseIntools;
+exports.buildGitignore = buildGitignore;
+exports.buildReactReadme = buildReactReadme;
 exports.buildIntoolsTypes = buildIntoolsTypes;
 function buildReactManifest(name) {
     return {
@@ -676,6 +678,82 @@ export function useIntools(pluginId?: string) {
 }
 `;
 }
+function buildGitignore() {
+    return `node_modules
+dist
+ui
+.DS_Store
+*.log
+`;
+}
+function buildReactReadme(name) {
+    return `# ${name}
+
+插件描述
+
+## 功能特性
+
+- 功能 1
+- 功能 2
+- 功能 3
+
+## 触发方式
+
+- \`${name}\` - 主功能
+
+## 开发
+
+### 安装依赖
+
+\`\`\`bash
+npm install
+\`\`\`
+
+### 开发模式
+
+\`\`\`bash
+npm run dev
+\`\`\`
+
+### 构建
+
+\`\`\`bash
+npm run build
+\`\`\`
+
+### 打包
+
+\`\`\`bash
+npm run pack
+\`\`\`
+
+## 项目结构
+
+\`\`\`
+${name}/
+├── manifest.json              # 插件配置
+├── package.json
+├── src/
+│   ├── main.ts                # 后端入口
+│   ├── ui/
+│   │   ├── App.tsx            # 主应用
+│   │   ├── main.tsx           # UI 入口
+│   │   ├── index.html         # HTML 模板
+│   │   ├── styles.css         # 全局样式
+│   │   ├── hooks/
+│   │   │   └── useIntools.ts  # InTools API Hook
+│   │   └── types/
+│   │       └── intools.d.ts   # 类型定义
+├── dist/                      # 后端构建输出
+├── ui/                        # UI 构建输出
+└── icon.png                   # 插件图标
+\`\`\`
+
+## 许可证
+
+MIT License
+`;
+}
 function buildIntoolsTypes() {
     return `// InTools API 类型定义
 

package/dist/commands/pack.js

@@ -81,6 +81,17 @@ async function createArchive(cwd, outputPath, manifest) {
         if (fs.existsSync(uiDir)) {
             archive.directory(uiDir, 'ui');
         }
+        // 添加 preload 脚本（如果在 manifest 中配置了）
+        if (manifest.preload) {
+            const preloadPath = path.join(cwd, manifest.preload);
+            if (fs.existsSync(preloadPath)) {
+                archive.file(preloadPath, { name: manifest.preload });
+                console.log(chalk_1.default.gray(`  + ${manifest.preload}`));
+            }
+            else {
+                console.log(chalk_1.default.yellow(`警告: preload 文件不存在: ${manifest.preload}`));
+            }
+        }
         // 添加 README.md（如果存在）
         const readmePath = path.join(cwd, 'README.md');
         if (fs.existsSync(readmePath)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "intools-cli",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "InTools 插件开发 CLI 工具",
   "main": "dist/index.js",
   "files": [