Merge pull request #25 from unity-template/Genluo/issue15

feat: 函数自动判断版本支持(fix: #15)

Author: Genluo

package.json

@@ -45,7 +45,6 @@
     "name": "lg208143"
   },
   "dependencies": {
-    "axios": "^0.21.1",
     "dayjs": "^1.9.6",
     "lodash.chunk": "^4.2.0",
     "lodash.debounce": "^4.0.8",
@@ -108,6 +107,7 @@
     "sass-loader": "^10.1.0",
     "sinon": "^9.2.1",
     "stats-filelist": "^1.0.1",
+    "sync-request": "^6.1.0",
     "ts-jest": "^26.4.4",
     "ts-loader": "^8.0.11",
     "ts-node": "^9.1.1",

script/plugin/packages/version/index.ts

@@ -0,0 +1,64 @@
+import { Application } from 'typedoc';
+import { JsonObject, PackageJson } from 'type-fest';
+import { PageEvent, RendererEvent } from 'typedoc/dist/lib/output/events';
+import { resolve } from 'path';
+import { writeJson, readJsonSync } from 'fs-extra';
+import { Reflection, ReflectionGroup } from 'typedoc/dist/lib/models';
+
+const request = require('sync-request');
+
+
+const pkg: PackageJson = readJsonSync(resolve(process.cwd(), './package.json'));
+const fileName = 'version.map.json';
+const versionMapUrl = `https://unity-template.github.io/onex-utils/${fileName}`;
+
+let versionMap: JsonObject = {};
+
+export const load = (that: Application) => {
+  that.listenTo(that.application.renderer, {
+    [RendererEvent.BEGIN]: getVersionMap,
+    [RendererEvent.END]: saveVersionMap,
+    [PageEvent.BEGIN]: updateVersionMap,
+  });
+};
+
+/**
+ * 获取官网中对应的json
+ */
+const getVersionMap = () => {
+  try {
+    const result = request('GET', versionMapUrl);
+    versionMap = JSON.parse(result.body.toString());
+  } catch (err) {
+    console.log('获取远程versionMap报错： ', err);
+  }
+};
+
+/**
+ * 将生成的json进行保存
+ */
+const saveVersionMap = (event: RendererEvent) => {
+  writeJson(resolve(event.outputDirectory, fileName), versionMap);
+};
+
+/**
+ * 依据 versionMap 更新 version map 相关字段
+ */
+const updateVersionMap = (page: PageEvent) => {
+  page?.model?.groups.forEach((group: ReflectionGroup) => {
+    if (!group.categories) {
+      group.children.forEach((reflect: Reflection) => {
+        if ((reflect.parent as any)?.version) {
+          const parentAlias = reflect.parent?.getAlias() ?? '';
+          const currentAlias = reflect.getAlias();
+          const key = `${parentAlias}_${currentAlias}`;
+          versionMap[key] ??= pkg.version;
+          (reflect as any).version = versionMap[key];
+          return;
+        }
+        versionMap[reflect.name] ??= pkg.version;
+        (reflect as any).version = versionMap[reflect.name];
+      });
+    }
+  });
+};

script/plugin/packages/version/lib.d.ts

@@ -0,0 +1 @@
+declare module 'promise-synchronizer';

script/theme/src/assets/css/elements/_member.sass

@@ -34,3 +34,12 @@
 
     a[data-tsd-kind="Private"]
         color: var(--color-ts-private)
+.tsd-version
+    margin-bottom: 10px
+    span
+        padding: 5px 10px
+        border-radius: 4px
+        background: rgb(19, 82, 0)
+        color: rgb(228, 247, 210)
+        opacity: 1
+        font-size: 14px

script/theme/src/partials/member.hbs

@@ -4,6 +4,10 @@
         <h3>{{#each flags}}<span class="tsd-flag ts-flag{{this}}">{{this}}</span> {{/each}}{{{wbr name}}}</h3>
     {{/if}}
 
+    {{#if version}}
+        <div class="tsd-version"><span>{{version}}</span> provide</div>
+    {{/if}}
+
     {{#if signatures}}
         {{> member.signatures}}
     {{else}}{{#if hasGetterOrSetter}}

tsconfig.json

@@ -31,7 +31,8 @@
     "plugin": [
       "typedoc-plugin-nojekyll",
       "./script/plugin/build/packages/alias/index.js",
-      "./script/plugin/build/packages/categories/index.js"
+      "./script/plugin/build/packages/categories/index.js",
+      "./script/plugin/build/packages/version/index.js"
     ],
     "out": "docs",
     "entryPoints": ["./src"],