@linyjs/plugin-docs 0.1.2 → 0.1.4

package/examples/hello-world/src/server/index.ts

@@ -1,4 +1,4 @@
-import type { IModule } from '@linyjs/server-module-interface';
+import type { IModule, IServiceDef } from '@linyjs/server-module-interface';
 
 /**
  * Hello World 控制器
@@ -27,16 +27,16 @@ class HelloController {
   }
 }
 
+const helloControllerDef: IServiceDef = {
+  serviceTag: 'helloController',
+  serviceImpl: HelloController,
+  meta: { usageType: 'controller' }
+};
+
 /**
  * 服务端模块定义
  */
 export const helloServerModule: IModule = {
   name: 'helloServer',
-  serviceDefs: [
-    {
-      serviceTag: 'helloController',
-      serviceImpl: HelloController,
-      meta: { usageType: 'controller' }
-    }
-  ]
+  serviceDefs: [helloControllerDef]
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linyjs/plugin-docs",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Plugin development documentation and examples for linyjs framework",
   "keywords": [
     "linyjs",
@@ -27,16 +27,20 @@
   },
   "main": "src/cli.ts",
   "type": "module",
+  "scripts": {
+    "build": "tsc"
+  },
   "peerDependencies": {
-    "@linyjs/server-module-interface": "0.0.3",
-    "@linyjs/client-module-interface": "0.0.3",
-    "@linyjs/ui-slots-interface": "0.0.3"
+    "@linyjs/client-module-interface": "0.0.11",
+    "@linyjs/server-module-interface": "0.0.11",
+    "@linyjs/ui-slots-interface": "0.0.11"
   },
   "dependencies": {
     "commander": "^11.1.0"
   },
   "devDependencies": {
-    "typescript": "^5.7.0",
-    "@types/node": "^20.10.0"
+    "@types/commander": "^2.12.0",
+    "@types/node": "^20.10.0",
+    "typescript": "^5.7.0"
   }
 }

package/src/cli.ts

@@ -104,9 +104,9 @@ function searchDocs(keyword: string): void {
           }
         }
       }
-    } catch (error) {
-      console.error(`Error searching in directory ${dir}:`, error);
-    }
+      } catch (error) {
+        console.error(`Error searching in directory ${dir}:`, String(error));
+      }
   }
 
   searchInDirectory(docsDir);
@@ -167,9 +167,9 @@ function listExamples(): void {
     console.log('\n💡 使用命令:');
     console.log('  example <name>            生成示例到当前目录');
     console.log('  example <name> -o <dir>   生成示例到指定目录');
-  } catch (error) {
-    console.error('❌ 读取示例列表失败:', error.message);
-  }
+    } catch (error) {
+      console.error('❌ 读取示例列表失败:', String(error));
+    }
 }
 
 // 生成示例项目
@@ -235,9 +235,9 @@ async function copyDirectory(source: string, target: string): Promise<void> {
         }
       }
     }
-  } catch (error) {
-    throw new Error(`复制目录失败: ${error.message}`);
-  }
+    } catch (error) {
+      throw new Error(`复制目录失败: ${String(error)}`);
+    }
 }
 
 // 设置CLI命令
@@ -253,7 +253,7 @@ program
   .option('--open', '在浏览器中打开在线文档')
   .option('--list', '列出所有文档分类')
   .argument('[keyword]', '搜索关键词')
-  .action((keyword, options) => {
+  .action((keyword: string | undefined, options: { open?: boolean; list?: boolean }) => {
     if (options.open) {
       console.log('🌐 正在打开在线文档...');
       const docsUrl = 'https://github.com/linyjs/linyjs/tree/main/packages/plugin-docs/docs';
@@ -270,11 +270,11 @@ program
   .command('example <name>')
   .description('生成示例项目')
   .option('-o, --output <directory>', '指定输出目录')
-  .action(async (name, options) => {
+  .action(async (name: string, options: { output?: string }) => {
     try {
       await generateExample(name, options.output);
     } catch (error) {
-      console.error('❌ 生成示例失败:', error.message);
+      console.error('❌ 生成示例失败:', String(error));
       process.exit(1);
     }
   });