@linyjs/plugin-docs 0.0.13

package/examples/hello-world/node_modules/typescript/package.json

@@ -0,0 +1,120 @@
+{
+    "name": "typescript",
+    "author": "Microsoft Corp.",
+    "homepage": "https://www.typescriptlang.org/",
+    "version": "5.9.3",
+    "license": "Apache-2.0",
+    "description": "TypeScript is a language for application scale JavaScript development",
+    "keywords": [
+        "TypeScript",
+        "Microsoft",
+        "compiler",
+        "language",
+        "javascript"
+    ],
+    "bugs": {
+        "url": "https://github.com/microsoft/TypeScript/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/microsoft/TypeScript.git"
+    },
+    "main": "./lib/typescript.js",
+    "typings": "./lib/typescript.d.ts",
+    "bin": {
+        "tsc": "./bin/tsc",
+        "tsserver": "./bin/tsserver"
+    },
+    "engines": {
+        "node": ">=14.17"
+    },
+    "files": [
+        "bin",
+        "lib",
+        "!lib/enu",
+        "LICENSE.txt",
+        "README.md",
+        "SECURITY.md",
+        "ThirdPartyNoticeText.txt",
+        "!**/.gitattributes"
+    ],
+    "devDependencies": {
+        "@dprint/formatter": "^0.4.1",
+        "@dprint/typescript": "0.93.4",
+        "@esfx/canceltoken": "^1.0.0",
+        "@eslint/js": "^9.20.0",
+        "@octokit/rest": "^21.1.1",
+        "@types/chai": "^4.3.20",
+        "@types/diff": "^7.0.1",
+        "@types/minimist": "^1.2.5",
+        "@types/mocha": "^10.0.10",
+        "@types/ms": "^0.7.34",
+        "@types/node": "latest",
+        "@types/source-map-support": "^0.5.10",
+        "@types/which": "^3.0.4",
+        "@typescript-eslint/rule-tester": "^8.24.1",
+        "@typescript-eslint/type-utils": "^8.24.1",
+        "@typescript-eslint/utils": "^8.24.1",
+        "azure-devops-node-api": "^14.1.0",
+        "c8": "^10.1.3",
+        "chai": "^4.5.0",
+        "chokidar": "^4.0.3",
+        "diff": "^7.0.0",
+        "dprint": "^0.49.0",
+        "esbuild": "^0.25.0",
+        "eslint": "^9.20.1",
+        "eslint-formatter-autolinkable-stylish": "^1.4.0",
+        "eslint-plugin-regexp": "^2.7.0",
+        "fast-xml-parser": "^4.5.2",
+        "glob": "^10.4.5",
+        "globals": "^15.15.0",
+        "hereby": "^1.10.0",
+        "jsonc-parser": "^3.3.1",
+        "knip": "^5.44.4",
+        "minimist": "^1.2.8",
+        "mocha": "^10.8.2",
+        "mocha-fivemat-progress-reporter": "^0.1.0",
+        "monocart-coverage-reports": "^2.12.1",
+        "ms": "^2.1.3",
+        "picocolors": "^1.1.1",
+        "playwright": "^1.50.1",
+        "source-map-support": "^0.5.21",
+        "tslib": "^2.8.1",
+        "typescript": "^5.7.3",
+        "typescript-eslint": "^8.24.1",
+        "which": "^3.0.1"
+    },
+    "overrides": {
+        "typescript@*": "$typescript"
+    },
+    "scripts": {
+        "test": "hereby runtests-parallel --light=false",
+        "test:eslint-rules": "hereby run-eslint-rules-tests",
+        "build": "npm run build:compiler && npm run build:tests",
+        "build:compiler": "hereby local",
+        "build:tests": "hereby tests",
+        "build:tests:notypecheck": "hereby tests --no-typecheck",
+        "clean": "hereby clean",
+        "gulp": "hereby",
+        "lint": "hereby lint",
+        "knip": "hereby knip",
+        "format": "dprint fmt",
+        "setup-hooks": "node scripts/link-hooks.mjs"
+    },
+    "browser": {
+        "fs": false,
+        "os": false,
+        "path": false,
+        "crypto": false,
+        "buffer": false,
+        "source-map-support": false,
+        "inspector": false,
+        "perf_hooks": false
+    },
+    "packageManager": "npm@8.19.4",
+    "volta": {
+        "node": "20.1.0",
+        "npm": "8.19.4"
+    },
+    "gitHead": "c63de15a992d37f0d6cec03ac7631872838602cb"
+}

package/examples/hello-world/package-lock.json

@@ -0,0 +1,74 @@
+{
+  "name": "@linyjs/example-hello-world",
+  "version": "1.0.0",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "@linyjs/example-hello-world",
+      "version": "1.0.0",
+      "dependencies": {
+        "@linyjs/client-module-interface": "^0.0.1",
+        "@linyjs/server-module-interface": "^0.0.1",
+        "react": "^19.0.0"
+      },
+      "devDependencies": {
+        "@types/react": "^19.0.0",
+        "typescript": "^5.7.0"
+      }
+    },
+    "node_modules/@linyjs/client-module-interface": {
+      "version": "0.0.1",
+      "resolved": "https://registry.npmmirror.com/@linyjs/client-module-interface/-/client-module-interface-0.0.1.tgz",
+      "integrity": "sha512-StKnCtzKq+ZHoApWQqOHEPrlMq0VqZ5C4ZYB9t27LNOzep8j4qwMqNnEP99S/KC4m/9rVGJlnJw0O+Kf2NVYYg==",
+      "peerDependencies": {
+        "react": "^19.0.0"
+      }
+    },
+    "node_modules/@linyjs/server-module-interface": {
+      "version": "0.0.1",
+      "resolved": "https://registry.npmmirror.com/@linyjs/server-module-interface/-/server-module-interface-0.0.1.tgz",
+      "integrity": "sha512-jrwW0uI8F7TCwGMvGVW4EkxcdDaXTIZhDS5tcahTiA9pqsNDMXULcy0oPrmaPMp6uaqdt3rSTp0ybThggym/RQ=="
+    },
+    "node_modules/@types/react": {
+      "version": "19.2.17",
+      "resolved": "https://registry.npmmirror.com/@types/react/-/react-19.2.17.tgz",
+      "integrity": "sha512-MXfmqaVPEVgkBT/aY0aGCkRWWtByiYQXo3xdQ8r5RzuFrPiRn8Gar2tQdXSUQ2GKV3bkXckek89V8wQBY2Q/Aw==",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "csstype": "^3.2.2"
+      }
+    },
+    "node_modules/csstype": {
+      "version": "3.2.3",
+      "resolved": "https://registry.npmmirror.com/csstype/-/csstype-3.2.3.tgz",
+      "integrity": "sha512-z1HGKcYy2xA8AGQfwrn0PAy+PB7X/GSj3UVJW9qKyn43xWa+gl5nXmU4qqLMRzWVLFC8KusUX8T/0kCiOYpAIQ==",
+      "dev": true,
+      "license": "MIT"
+    },
+    "node_modules/react": {
+      "version": "19.2.7",
+      "resolved": "https://registry.npmmirror.com/react/-/react-19.2.7.tgz",
+      "integrity": "sha512-HNe9WslTbXmFK8o8cmwgAeJFSBvt1bPdHCVKtaaV+WlAN36mpT4hcRpwbf3fY56ar2oIXzsBpOAiIRHAdY0OlQ==",
+      "license": "MIT",
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
+    "node_modules/typescript": {
+      "version": "5.9.3",
+      "resolved": "https://registry.npmmirror.com/typescript/-/typescript-5.9.3.tgz",
+      "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==",
+      "dev": true,
+      "license": "Apache-2.0",
+      "bin": {
+        "tsc": "bin/tsc",
+        "tsserver": "bin/tsserver"
+      },
+      "engines": {
+        "node": ">=14.17"
+      }
+    }
+  }
+}

package/examples/hello-world/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@linyjs/example-hello-world",
+  "version": "1.0.0",
+  "description": "Hello World example plugin for linyjs framework",
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "pack": "npx @linyjs/cli pack"
+  },
+  "dependencies": {
+    "@linyjs/server-module-interface": "^0.0.1",
+    "@linyjs/client-module-interface": "^0.0.1",
+    "react": "^19.0.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.0",
+    "@types/react": "^19.0.0"
+  },
+  "linyjs": {
+    "compatibleVersions": ">=0.0.1 <1.0.0"
+  }
+}

package/examples/hello-world/src/client/index.tsx

@@ -0,0 +1,110 @@
+import type { IModule, IServiceDef } from '@linyjs/client-module-interface';
+import React from 'react';
+
+/**
+ * Hello World 页面组件
+ */
+function HelloPage() {
+  const [message, setMessage] = React.useState('Loading...');
+  const [name, setName] = React.useState('World');
+
+  // 调用 API 获取问候消息
+  React.useEffect(() => {
+    fetch(`/api/hello?name=${encodeURIComponent(name)}`)
+      .then(res => res.json())
+      .then(data => {
+        setMessage(data.message);
+      })
+      .catch(err => {
+        console.error('Failed to fetch:', err);
+        setMessage('Error loading message');
+      });
+  }, [name]);
+
+  return (
+    <div style={{ 
+      padding: '40px', 
+      maxWidth: '600px', 
+      margin: '0 auto',
+      fontFamily: 'Arial, sans-serif'
+    }}>
+      <h1 style={{ color: '#333' }}>👋 Hello World Plugin</h1>
+      
+      <div style={{ 
+        marginTop: '20px',
+        padding: '20px',
+        backgroundColor: '#f5f5f5',
+        borderRadius: '8px'
+      }}>
+        <p style={{ fontSize: '18px', color: '#666' }}>{message}</p>
+      </div>
+
+      <div style={{ marginTop: '20px' }}>
+        <label style={{ display: 'block', marginBottom: '8px', color: '#666' }}>
+          Enter your name:
+        </label>
+        <input
+          type="text"
+          value={name}
+          onChange={(e) => setName(e.target.value)}
+          placeholder="Enter your name"
+          style={{
+            padding: '10px',
+            fontSize: '16px',
+            border: '1px solid #ddd',
+            borderRadius: '4px',
+            width: '100%',
+            boxSizing: 'border-box'
+          }}
+        />
+      </div>
+
+      <div style={{ 
+        marginTop: '30px',
+        padding: '15px',
+        backgroundColor: '#e3f2fd',
+        borderRadius: '4px',
+        fontSize: '14px',
+        color: '#1976d2'
+      }}>
+        <strong>💡 Tip:</strong> This is a minimal linyjs plugin example.
+        Try modifying the code in <code>src/server/index.ts</code> and <code>src/client/index.tsx</code>.
+      </div>
+    </div>
+  );
+}
+
+/**
+ * 路由服务
+ */
+class HelloRouteService {
+  basePath = '/hello';
+  
+  getRoutes() {
+    return [
+      {
+        path: '/',
+        component: HelloPage,
+        key: 'hello-page',
+        meta: { 
+          title: 'Hello World',
+          requiresAuth: false
+        }
+      }
+    ];
+  }
+}
+
+const helloRouteDef: IServiceDef = {
+  serviceTag: 'helloRoute',
+  serviceImpl: HelloRouteService,
+  meta: { usageType: 'route' }
+};
+
+/**
+ * 客户端模块定义
+ */
+export const helloClientModule: IModule = {
+  name: 'helloClient',
+  serviceDefs: [helloRouteDef]
+};

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

@@ -0,0 +1,42 @@
+import type { IModule, IServiceDef } from '@linyjs/server-module-interface';
+
+/**
+ * Hello World 控制器
+ * 提供一个简单的 API 端点返回问候消息
+ */
+class HelloController {
+  getRoutes() {
+    return [
+      {
+        method: 'GET' as const,
+        path: '/api/hello',
+        middlewares: [],
+        responseType: 'json' as const,
+        handler: async (params: any, ctx: any) => {
+          // 获取查询参数(如果有)
+          const name = params.query?.name || 'World';
+          
+          return {
+            message: `Hello, ${name}!`,
+            timestamp: new Date().toISOString(),
+            plugin: 'hello-world-example'
+          };
+        }
+      }
+    ];
+  }
+}
+
+const helloControllerDef: IServiceDef = {
+  serviceTag: 'helloController',
+  serviceImpl: HelloController,
+  meta: { usageType: 'controller' }
+};
+
+/**
+ * 服务端模块定义
+ */
+export const helloServerModule: IModule = {
+  name: 'helloServer',
+  serviceDefs: [helloControllerDef]
+};

package/examples/hello-world/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "lib": ["ES2020", "DOM"],
+    "jsx": "react-jsx",
+    "declaration": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "moduleResolution": "node"
+  },
+  "include": ["src/**/*"]
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@linyjs/plugin-docs",
+  "version": "0.0.13",
+  "description": "Plugin development documentation and examples for linyjs framework",
+  "keywords": [
+    "linyjs",
+    "plugin",
+    "documentation",
+    "examples",
+    "tutorial"
+  ],
+  "author": "linyjs Team",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/linyjs/linyjs.git",
+    "directory": "packages/plugin-docs"
+  },
+  "files": [
+    "docs",
+    "examples",
+    "src",
+    "README.md"
+  ],
+  "bin": {
+    "plugin-docs": "src/cli.ts"
+  },
+  "main": "src/cli.ts",
+  "type": "module",
+  "scripts": {
+    "build": "tsc"
+  },
+  "peerDependencies": {
+    "@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": {
+    "@types/commander": "^2.12.0",
+    "@types/node": "^20.10.0",
+    "typescript": "^5.7.0"
+  }
+}