From 1bdc242638609f52086fee5084d339642c207108 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hugo=20H=C3=B6rnquist?= Date: Tue, 5 Sep 2023 00:56:07 +0200 Subject: Add build step for jsdoc. --- static/tsconfig.json | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'static/tsconfig.json') diff --git a/static/tsconfig.json b/static/tsconfig.json index 82359e01..45c6ae73 100644 --- a/static/tsconfig.json +++ b/static/tsconfig.json @@ -30,5 +30,11 @@ /* Completeness */ "skipLibCheck": true /* Skip type checking all .d.ts files. */ + }, + "include": ["**/*"], + "exclude": ["node_modules", "**/*.spec.ts"], + "typedocOptions": { + "entryPoints": ["./src"], + "out": "docs" } } -- cgit v1.2.3 From 7949fcdc683d07689bad5da5d20bfa3eeb5a6a46 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hugo=20H=C3=B6rnquist?= Date: Tue, 5 Sep 2023 01:25:00 +0200 Subject: Move frontend code to subdirectories, to simplify command line flags. --- static/tsconfig.json | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'static/tsconfig.json') diff --git a/static/tsconfig.json b/static/tsconfig.json index 45c6ae73..69d8fe06 100644 --- a/static/tsconfig.json +++ b/static/tsconfig.json @@ -34,7 +34,9 @@ "include": ["**/*"], "exclude": ["node_modules", "**/*.spec.ts"], "typedocOptions": { - "entryPoints": ["./src"], + "entryPointStrategy": "expand", + "entryPoints": ["./ts"], + "exclude": ["node_modules"], "out": "docs" } } -- cgit v1.2.3 From f653a01328be3b8be6af35c0c96867623765ca5b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hugo=20H=C3=B6rnquist?= Date: Tue, 5 Sep 2023 11:41:46 +0200 Subject: Move JS documentation into the JS-code. Texinfo was a bad match for how TypeScript is structured. This also allows generation of jsdoc pages, which can be nice. Another large win is that this opens up for the texinfo pages to replace the Guile heading with different subheadings, including - external library - internal library - C library - ... --- static/tsconfig.json | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) (limited to 'static/tsconfig.json') diff --git a/static/tsconfig.json b/static/tsconfig.json index 69d8fe06..c421a586 100644 --- a/static/tsconfig.json +++ b/static/tsconfig.json @@ -34,9 +34,13 @@ "include": ["**/*"], "exclude": ["node_modules", "**/*.spec.ts"], "typedocOptions": { - "entryPointStrategy": "expand", - "entryPoints": ["./ts"], - "exclude": ["node_modules"], - "out": "docs" + "entryPointStrategy": "expand", + "entryPoints": ["./ts"], + "exclude": ["node_modules"], + "plugin": [ + "@mxssfd/typedoc-theme" + ], + "theme": "my-theme", + "out": "docs" } } -- cgit v1.2.3 From 644df12ff5ab037911cb0db4593d5b8a1b1d1d2f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hugo=20H=C3=B6rnquist?= Date: Thu, 7 Sep 2023 01:33:28 +0200 Subject: Normalize tsconfig formatting. --- static/tsconfig.json | 85 +++++++++++++++++++++++++--------------------------- 1 file changed, 40 insertions(+), 45 deletions(-) (limited to 'static/tsconfig.json') diff --git a/static/tsconfig.json b/static/tsconfig.json index c421a586..02d475f3 100644 --- a/static/tsconfig.json +++ b/static/tsconfig.json @@ -1,46 +1,41 @@ { - "compilerOptions": { - /* Visit https://aka.ms/tsconfig.json to read more about this file */ - - /* Projects */ - - /* Language and Environment */ - "target": "es2017", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ - - /* Modules */ - "module": "CommonJS", /* Specify what module code is generated. */ - - /* JavaScript Support */ - "allowJs": false, /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */ - - /* Emit */ - // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ - // "declarationMap": true, /* Create sourcemaps for d.ts files. */ - // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ - "sourceMap": true, /* Create source map files for emitted JavaScript files. */ - "newLine": "lf", /* Set the newline character for emitting files. */ - "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ - - /* Interop Constraints */ - "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */ - "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ - - /* Type Checking */ - "strict": true, /* Enable all strict type-checking options. */ - - /* Completeness */ - "skipLibCheck": true /* Skip type checking all .d.ts files. */ - }, - "include": ["**/*"], - "exclude": ["node_modules", "**/*.spec.ts"], - "typedocOptions": { - "entryPointStrategy": "expand", - "entryPoints": ["./ts"], - "exclude": ["node_modules"], - "plugin": [ - "@mxssfd/typedoc-theme" - ], - "theme": "my-theme", - "out": "docs" - } -} + "compilerOptions": { + /* Visit https://aka.ms/tsconfig.json to read more about this file */ + /* Projects */ + /* Language and Environment */ + "target": "es2017", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. *//* Modules */ + "module": "CommonJS", /* Specify what module code is generated. *//* JavaScript Support */ + "allowJs": false, /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. *//* Emit */ + // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + // "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + "newLine": "lf", /* Set the newline character for emitting files. */ + "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. *//* Interop Constraints */ + "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */ + "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. *//* Type Checking */ + "strict": true, /* Enable all strict type-checking options. *//* Completeness */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + }, + "include": [ + "**/*" + ], + "exclude": [ + "node_modules", + "**/*.spec.ts" + ], + "typedocOptions": { + "entryPointStrategy": "expand", + "entryPoints": [ + "./ts" + ], + "exclude": [ + "node_modules" + ], + "plugin": [ + "@mxssfd/typedoc-theme" + ], + "theme": "my-theme", + "out": "docs" + } +} \ No newline at end of file -- cgit v1.2.3 From e753d721519f72014241b3d2fc804a919f655769 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hugo=20H=C3=B6rnquist?= Date: Thu, 7 Sep 2023 02:58:41 +0200 Subject: Document remaining javascript items. --- static/tsconfig.json | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) (limited to 'static/tsconfig.json') diff --git a/static/tsconfig.json b/static/tsconfig.json index 02d475f3..352c8ab5 100644 --- a/static/tsconfig.json +++ b/static/tsconfig.json @@ -3,18 +3,17 @@ /* Visit https://aka.ms/tsconfig.json to read more about this file */ /* Projects */ /* Language and Environment */ - "target": "es2017", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. *//* Modules */ - "module": "CommonJS", /* Specify what module code is generated. *//* JavaScript Support */ - "allowJs": false, /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. *//* Emit */ - // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + "target": "es2017", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ /* Modules */ + "module": "CommonJS", /* Specify what module code is generated. */ /* JavaScript Support */ + "allowJs": false, /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */ /* Emit */// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ // "declarationMap": true, /* Create sourcemaps for d.ts files. */ // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ "sourceMap": true, /* Create source map files for emitted JavaScript files. */ "newLine": "lf", /* Set the newline character for emitting files. */ - "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. *//* Interop Constraints */ + "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ /* Interop Constraints */ "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */ - "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. *//* Type Checking */ - "strict": true, /* Enable all strict type-checking options. *//* Completeness */ + "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ /* Type Checking */ + "strict": true, /* Enable all strict type-checking options. */ /* Completeness */ "skipLibCheck": true /* Skip type checking all .d.ts files. */ }, "include": [ @@ -36,6 +35,9 @@ "@mxssfd/typedoc-theme" ], "theme": "my-theme", + "validation": { + "notDocumented": true + }, "out": "docs" } } \ No newline at end of file -- cgit v1.2.3