chore: fix generate reference command name in action (#5320)

* chore: fix generate reference command name * fix require path in typedoc config * add missing dependencies
medusajs · Oct 11, 2023 · ab7cc6e · ab7cc6e
1 parent 3dc0619
commit ab7cc6e
Show file tree

Hide file tree

Showing 7 changed files with 482 additions and 9 deletions.
diff --git a/.github/workflows/generate-references.yml b/.github/workflows/generate-references.yml
@@ -123,7 +123,7 @@ jobs:
         working-directory: docs-util
 
       - name: Generate Entities Reference
-        run: yarn generate:references entities
+        run: yarn generate:reference entities
         working-directory: docs-util/packages/scripts
 
       - name: Create Pull Request
@@ -168,7 +168,7 @@ jobs:
         working-directory: docs-util
 
       - name: Generate Services Reference
-        run: yarn generate:references js-client
+        run: yarn generate:reference js-client
         working-directory: docs-util/packages/scripts
 
       - name: Create Pull Request

diff --git a/docs-util/package.json b/docs-util/package.json
@@ -10,6 +10,7 @@
     "lint": "turbo run lint"
   },
   "dependencies": {
+    "@babel/core": "^7.23.0",
     "@babel/eslint-parser": "^7.22.15",
     "@typescript-eslint/eslint-plugin": "^6.7.4",
     "@typescript-eslint/parser": "^6.7.4",

diff --git a/docs-util/packages/scripts/package.json b/docs-util/packages/scripts/package.json
@@ -14,6 +14,7 @@
   "dependencies": {
     "@linear/sdk": "^1.22.0",
     "@octokit/core": "^4.0.5",
+    "@types/node": "^20.8.3",
     "ts-node": "^10.9.1",
     "typedoc": "0.25.1",
     "typedoc-monorepo-link-types": "^0.0.2",
@@ -23,6 +24,7 @@
     "typedoc-plugin-merge-modules": "5.1.0",
     "typedoc-plugin-modules": "*",
     "typedoc-plugin-reference-excluder": "1.1.3",
-    "typedoc-plugin-rename-defaults": "^0.6.6"
+    "typedoc-plugin-rename-defaults": "^0.6.6",
+    "typescript": "^5.2.2"
   }
 }
diff --git a/docs-util/packages/typedoc-config/entities.js b/docs-util/packages/typedoc-config/entities.js
@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
 const path = require("path")
-const globalTypedocOptions = require("./typedoc")
+const globalTypedocOptions = require("./base")
 
 const pathPrefix = path.join(__dirname, "..", "..")
 

diff --git a/docs-util/packages/typedoc-config/js-client.js b/docs-util/packages/typedoc-config/js-client.js
@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
 const path = require("path")
-const globalTypedocOptions = require("./typedoc")
+const globalTypedocOptions = require("./base")
 
 const pathPrefix = path.join(__dirname, "..", "..")
 

diff --git a/docs-util/packages/typedoc-config/services.js b/docs-util/packages/typedoc-config/services.js
@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
 const path = require("path")
-const globalTypedocOptions = require("./typedoc")
+const globalTypedocOptions = require("./base")
 
 const pathPrefix = path.join(__dirname, "..", "..")