Merge branch 'main' into main

.github/workflows/gh-pages.yml

@@ -18,7 +18,7 @@ jobs:
         with:
           creds: ${{ secrets.GH_APP_CREDS }}
 
-      - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
         with:
           submodules: true
           fetch-depth: 0

.github/workflows/semantic.yml

@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: semantic-pull-request
-        uses: amannn/action-semantic-pull-request@cfb60706e18bc85e8aec535e3c577abe8f70378e # tag: v5
+        uses: amannn/action-semantic-pull-request@0723387faaf9b38adef4775cd42cfd5155ed6017 # tag: v5
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:

.gitignore

@@ -27,3 +27,4 @@ packages/plugin/webpack/test/fixtures/apps/native-modules/package-lock.json
 packages/plugin/fuses/test/fixture/app
 .links
 reports
+packages/**/typedoc.json

.prettierignore

@@ -8,6 +8,7 @@ packages/*/*/index.d.ts
 packages/*/*/index.ts
 packages/*/*/README.md
 packages/*/*/tsconfig.json
+packages/*/*/typedoc.json
 packages/api/core/test/fixture/bad_external_forge_config/bad.js
 packages/plugin/webpack/test/**/.webpack
 .links

package.json

@@ -11,9 +11,7 @@
     "build": "tsc -b packages",
     "build:watch": "yarn build --watch",
     "postbuild": "ts-node tools/test-dist",
-    "docs": "yarn build && yarn docs:generate",
-    "docs:generate": "yarn docs:plugin && node --max-old-space-size=16384 -r ts-node/register ./tools/gen-docs.ts",
-    "docs:plugin": "cd ./tools/doc-plugin && yarn build",
+    "docs": "yarn build && npx typedoc",
     "lerna:publish": "lerna publish --force-publish --conventional-commits --no-changelog --exact",
     "lint:js": "prettier --check . && eslint .",
     "lint:markdown": "electron-markdownlint \"**/*.md\"",
@@ -89,7 +87,6 @@
   "devDependencies": {
     "@electron/fuses": ">=1.0.0",
     "@electron/lint-roller": "1.10.1",
-    "@knodes/typedoc-plugin-monorepo-readmes": "0.22.5",
     "@malept/eslint-config": "^2.0.0",
     "@types/chai": "^4.2.12",
     "@types/chai-as-promised": "^7.1.2",
@@ -145,9 +142,7 @@
     "sinon-chai": "^3.6.0",
     "syncpack": "^8.4.11",
     "ts-node": "^10.0.0",
-    "typedoc": "^0.22.15",
-    "typedoc-plugin-missing-exports": "^1.0.0",
-    "typedoc-plugin-rename-defaults": "^0.6.4",
+    "typedoc": "0.25.13",
     "typescript": "^4.6.3",
     "xvfb-maybe": "^0.2.1",
     "yaml-hook": "^1.0.0"

tools/gen-ts-glue.ts

@@ -32,6 +32,7 @@ function convertMainToSrc(main: string): string {
 }
 
 (async () => {
+  const baseTypedocJson = path.resolve(__dirname, '../typedoc.base.json');
   const pkgs = await getPackageInfo();
 
   // Run each package in parallel
@@ -56,6 +57,19 @@ function convertMainToSrc(main: string): string {
       // Write the facade entry-point file
       const importTarget = './' + srcMain.replace(/\.ts$/, '');
       const facadeFilePath = path.resolve(pkg.path, 'index.ts');
+      const typedocJsonPath = path.resolve(pkg.path, 'typedoc.json');
+      await fs.writeFile(
+        typedocJsonPath,
+        JSON.stringify(
+          {
+            $schema: 'https://typedoc.org/schema.json',
+            extends: [baseTypedocJson],
+            entryPoints: [srcMain],
+          },
+          null,
+          2
+        )
+      );
       let facadeFileContents =
         '// ⚠️ AUTOGENERATED ⚠️ AUTOGENERATED ⚠️ AUTOGENERATED ⚠️\n' +
         '// This file was automatically generated by `tools/gen-ts-glue.ts`. Do not modify directly if you want to keep your changes.\n' +

typedoc.base.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "excludeInternal": true
+}

typedoc.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPointStrategy": "packages",
+  "entryPoints": ["packages/api/core", "packages/maker/*", "packages/plugin/*", "packages/plugin/*", "packages/publisher/*", "packages/utils/types"]
+}