feat: openapi and typedoc build

GopeedLab · Oct 12, 2023 · 8d3478e · 8d3478e
1 parent c8e7c03
commit 8d3478e
Show file tree

Hide file tree

Showing 28 changed files with 2,507 additions and 59 deletions.
diff --git a/.gitignore b/.gitignore
@@ -128,3 +128,6 @@ dist
 .yarn/build-state.yml
 .yarn/install-state.gz
 .pnp.*
+
+# Typedoc output
+docs
diff --git a/package.json b/package.json
@@ -1,10 +1,11 @@
 {
   "private": true,
-  "version": "1.0.4",
+  "version": "1.0.5",
   "packageManager": "pnpm@8.6.1",
   "type": "module",
   "scripts": {
     "build": "rollup -c",
+    "docs": "typedoc",
     "publish": "pnpm publish -r"
   },
   "devDependencies": {
@@ -18,6 +19,8 @@
     "prettier": "^2.8.8",
     "rollup": "^3.23.1",
     "rollup-plugin-typescript2": "^0.34.1",
+    "typedoc": "^0.25.2",
+    "typedoc-plugin-missing-exports": "^2.1.0",
     "typescript": "5.0.3"
   }
 }
diff --git a/packages/create-gopeed-ext/package.json b/packages/create-gopeed-ext/package.json
@@ -1,6 +1,6 @@
 {
   "name": "create-gopeed-ext",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "keywords": [
     "gopeed"
   ],

diff --git a/packages/create-gopeed-ext/templates/pure/index.js b/packages/create-gopeed-ext/templates/pure/index.js
@@ -1,11 +1,13 @@
+import gopeed from 'gopeed';
+
 gopeed.events.onResolve((ctx) => {
   ctx.res = {
-    name: 'gopeed',
+    name: 'example',
     files: [
       {
-        name: 'test.txt',
+        name: 'index.html',
         req: {
-          url: 'https://example.com/test.txt',
+          url: 'https://example.com',
         },
       },
     ],

diff --git a/packages/create-gopeed-ext/templates/webpack/.eslintrc b/packages/create-gopeed-ext/templates/webpack/.eslintrc
@@ -4,7 +4,7 @@
     "dist/"
   ],
   "parserOptions": {
-    "ecmaVersion": 7,
+    "ecmaVersion": "latest",
     "sourceType": "module"
   },
   "extends": [

diff --git a/packages/create-gopeed-ext/templates/webpack/babel.config.js b/packages/create-gopeed-ext/templates/webpack/babel.config.js
@@ -1,9 +1,9 @@
 export default {
   presets: [
     [
-      "@babel/preset-env",
+      '@babel/preset-env',
       {
-        exclude: ["transform-async-to-generator", "transform-regenerator"],
+        exclude: ['transform-async-to-generator', 'transform-regenerator'],
       },
     ],
   ],

diff --git a/packages/create-gopeed-ext/templates/webpack/package.json b/packages/create-gopeed-ext/templates/webpack/package.json
@@ -20,7 +20,7 @@
     "eslint": "^8.51.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-prettier": "^5.0.0",
-    "gopeed": "^1.0.4",
+    "gopeed": "^1.0.5",
     "prettier": "^3.0.3",
     "webpack": "^5.75.0",
     "webpack-cli": "^5.0.1"

diff --git a/packages/create-gopeed-ext/templates/webpack/src/index.js b/packages/create-gopeed-ext/templates/webpack/src/index.js
@@ -2,12 +2,12 @@ import gopeed from 'gopeed';
 
 gopeed.events.onResolve((ctx) => {
   ctx.res = {
-    name: 'gopeed',
+    name: 'example',
     files: [
       {
-        name: 'test.txt',
+        name: 'index.html',
         req: {
-          url: 'https://example.com/test.txt',
+          url: 'https://example.com',
         },
       },
     ],

diff --git a/packages/gopeed-openapi/build/index.html b/packages/gopeed-openapi/build/index.html
@@ -0,0 +1,16 @@
+<!doctype html>
+<html>
+
+<head>
+  <meta charset="utf-8">
+  <script type="module" src="https://unpkg.com/rapidoc/dist/rapidoc-min.js"></script>
+</head>
+
+<body>
+  <rapi-doc spec-url="swagger.json" show-header="false" show-method-in-nav-bar="as-colored-block"
+    allow-spec-url-load="false" allow-spec-file-load="false" font-size="largest" render-style="focused"
+    primary-color="#79C476" nav-item-spacing="relaxed">
+  </rapi-doc>
+</body>
+
+</html>