docs: ng19 typedoc fixes

SAP · Dec 27, 2024 · 847f3a0 · 847f3a0
1 parent d5ed28f
commit 847f3a0
Show file tree

Hide file tree

Showing 16 changed files with 1,960 additions and 603 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -212,7 +212,6 @@
                         "types": "prefer-import"
                     }
                 ],
-                "@typescript-eslint/type-annotation-spacing": "error",
                 "@typescript-eslint/unified-signatures": "error",
                 "arrow-body-style": "error",
                 "arrow-parens": ["off", "always"],

diff --git a/libs/core/project.json b/libs/core/project.json
@@ -12,7 +12,8 @@
         "compile-typedoc": {
             "executor": "@fundamental-ngx/nx-plugin:compile-typedoc",
             "options": {
-                "outputPath": "libs/docs/typedoc/core"
+                "outputPath": "libs/docs/typedoc/core",
+                "tsConfig": "libs/core/tsconfig.typedoc.json"
             },
             "outputs": ["{options.outputPath}"]
         },

diff --git a/libs/core/tsconfig.json b/libs/core/tsconfig.json
@@ -3,6 +3,9 @@
     "files": [],
     "include": [],
     "references": [
+        {
+            "path": "./tsconfig.typedoc.json"
+        },
         {
             "path": "./tsconfig.lib.json"
         },

diff --git a/libs/core/tsconfig.typedoc.json b/libs/core/tsconfig.typedoc.json
@@ -0,0 +1,21 @@
+{
+    "extends": "./tsconfig.json",
+    "compilerOptions": {
+        "outDir": "../../dist/out-tsc",
+        "target": "ES2022",
+        "declaration": true,
+        "declarationMap": true,
+        "types": [],
+        "lib": ["dom", "es2018"],
+        "useDefineForClassFields": false,
+        "jsx": "react",
+        "jsxFactory": "JSX.createElement",
+        "jsxFragmentFactory": "JSX.Fragment"
+    },
+    "angularCompilerOptions": {
+        "skipTemplateCodegen": true,
+        "strictMetadataEmit": true,
+        "enableResourceInlining": true
+    },
+    "files": ["./index.ts"]
+}
diff --git a/libs/cx/project.json b/libs/cx/project.json
@@ -12,7 +12,8 @@
         "compile-typedoc": {
             "executor": "@fundamental-ngx/nx-plugin:compile-typedoc",
             "options": {
-                "outputPath": "libs/docs/typedoc/cx"
+                "outputPath": "libs/docs/typedoc/cx",
+                "tsConfig": "libs/cx/tsconfig.typedoc.json"
             },
             "outputs": ["{options.outputPath}"]
         },

diff --git a/libs/cx/tsconfig.json b/libs/cx/tsconfig.json
@@ -3,6 +3,9 @@
     "files": [],
     "include": [],
     "references": [
+        {
+            "path": "./tsconfig.typedoc.json"
+        },
         {
             "path": "./tsconfig.lib.json"
         },

diff --git a/libs/cx/tsconfig.typedoc.json b/libs/cx/tsconfig.typedoc.json
@@ -0,0 +1,21 @@
+{
+    "extends": "./tsconfig.json",
+    "compilerOptions": {
+        "outDir": "../../dist/out-tsc",
+        "target": "ES2022",
+        "declaration": true,
+        "declarationMap": true,
+        "types": [],
+        "lib": ["dom", "es2018"],
+        "useDefineForClassFields": false,
+        "jsx": "react",
+        "jsxFactory": "JSX.createElement",
+        "jsxFragmentFactory": "JSX.Fragment"
+    },
+    "angularCompilerOptions": {
+        "skipTemplateCodegen": true,
+        "strictMetadataEmit": true,
+        "enableResourceInlining": true
+    },
+    "files": ["./index.ts"]
+}
diff --git a/libs/nx-plugin/src/executors/compile-typedoc/executor.ts b/libs/nx-plugin/src/executors/compile-typedoc/executor.ts
@@ -25,7 +25,7 @@ export default async function compileTypedocs(_options: CompileTypedocExecutorSc
         },
         context
     );
-    const { tsConfig } = readTargetOptions({ project: context.projectName as string, target: 'build' }, context);
+    const tsConfig: string = _options.tsConfig || readTargetOptions({ project: context.projectName as string, target: 'build' }, context).tsConfig;
     const ngPackageJsonFiles = fastGlobSync(projectPath + '/**/*/ng-package.json');
     const entryPoints = ngPackageJsonFiles.map((f) => {
         const json = JSON.parse(readFileSync(f, 'utf-8'));
@@ -44,16 +44,11 @@ export default async function compileTypedocs(_options: CompileTypedocExecutorSc
         plugin: ['typedoc-plugin-merge-modules'],
         mergeModulesRenameDefaults: true,
         mergeModulesMergeMode: 'project',
-        compilerOptions: {
-            jsx: 'react',
-            jsxFactory: 'JSX.createElement',
-            jsxFragmentFactory: 'JSX.Fragment'
-        },
         theme: 'fd-typedoc'
     } as unknown as Partial<TypeDocOptions>);
     app.options.addReader(new TSConfigReader());
 
-    app.renderer.defineTheme('fd-typedoc', FdTheme);
+    app.renderer.defineTheme('fd-typedoc', DefaultTheme);
 
     const project = await app.convert();
 

diff --git a/libs/nx-plugin/src/executors/compile-typedoc/schema.d.ts b/libs/nx-plugin/src/executors/compile-typedoc/schema.d.ts
@@ -1,3 +1,4 @@
 export interface CompileTypedocExecutorSchema {
     outputPath: string;
+    tsConfig?: string;
 }
diff --git a/libs/nx-plugin/src/executors/compile-typedoc/schema.json b/libs/nx-plugin/src/executors/compile-typedoc/schema.json
@@ -8,6 +8,10 @@
         "outputPath": {
             "type": "string",
             "description": "Path to the output directory"
+        },
+        "tsConfig": {
+            "type": "string",
+            "description": "Path to the tsconfig file. If not provided, the executor will pick the 'build' target's tsConfig"
         }
     },
     "required": []