From b535203e366311cba22f7d50b5ef08a6a17c8aaa Mon Sep 17 00:00:00 2001 From: Marc Durdin Date: Mon, 29 Jun 2026 16:34:39 +0200 Subject: [PATCH] chore(developer): fix docs, api_extractor params in build.sh's Test-bot: skip Build-bot: skip release:developer --- common/tools/api-extractor/README.md | 36 ++++++++++++++---------- developer/src/kmc-generate/build.sh | 2 +- developer/src/kmc-keyboard-info/build.sh | 2 +- developer/src/kmc-kmn/build.sh | 2 +- developer/src/kmc-ldml/build.sh | 2 +- developer/src/kmc-model-info/build.sh | 2 +- developer/src/kmc-model/build.sh | 2 +- developer/src/kmc-package/build.sh | 2 +- 8 files changed, 28 insertions(+), 22 deletions(-) diff --git a/common/tools/api-extractor/README.md b/common/tools/api-extractor/README.md index e936730929..0462e78bcb 100644 --- a/common/tools/api-extractor/README.md +++ b/common/tools/api-extractor/README.md @@ -1,19 +1,29 @@ -# api-extractor.template.json +# Introduction + +These files are used by `typescript_run_api_extractor()` in typescript.inc.sh. + +This is setup only for Developer projects at this time as outputs go into +developer/docs and developer/build; future generalization requires changing only +`$report_temp` and `$report_folder` parameters in +`typescript_run_api_extractor()`. + +## api-extractor.template.json * Reference: https://api-extractor.com -api-extractor.template.json contains a template for api-extractor; these parameters -cannot be passed in to the tool, so we modify this template as needed with the following -parameters: +api-extractor.template.json contains a template for api-extractor; these +parameters cannot be passed in to the tool, so we modify this template as needed +with the following parameters: -* `$keyman_root`: the `$KEYMAN_ROOT` variable, with backslash \ translated to forward slash / +* `$keyman_root`: the `$KEYMAN_ROOT` variable, with backslash \ translated to + forward slash / * `$index_d_ts`: the filename `index.d.ts` or the corresponding filename for the entry point of the project * `$project_path`: the path for the module, relative to the base of the repo * `$report_temp`: a temporary path for output files for api-extractor * `$report_folder`: target folder for completed api-extractor API documentation -# tsdoc.template.json +## tsdoc.template.json * Reference: https://tsdoc.org/pages/packages/tsdoc-config/ @@ -22,14 +32,10 @@ project folders (alongside tsconfig.json) before running api-extractor and removed again afterwards; there is no way to specify an alternate location for the file. -tsdoc.template.json includes a definition for "@since" which has been proposed in -https://github.com/microsoft/tsdoc/issues/136. +tsdoc.template.json includes a definition for "@since" which has been proposed +in https://github.com/microsoft/tsdoc/issues/136. -# Notes +## Notes -These files are used by `typescript_run_api_extractor()` in typescript.inc.sh. - -This is setup only for Developer projects at this time as outputs go into -developer/docs and developer/build; future generalization requires changing only -`$report_temp` and `$report_folder` parameters in -`typescript_run_api_extractor()`. +See also .github/workflows/api-verification.yml which does API validation of +Core for desktop platforms. \ No newline at end of file diff --git a/developer/src/kmc-generate/build.sh b/developer/src/kmc-generate/build.sh index fd4c71de6e..323c78937b 100755 --- a/developer/src/kmc-generate/build.sh +++ b/developer/src/kmc-generate/build.sh @@ -39,5 +39,5 @@ do_build() { builder_run_action clean rm -rf ./build/ ./tsconfig.tsbuildinfo builder_run_action configure node_select_version_and_npm_ci builder_run_action build do_build -builder_run_action api typescript_run_api_extractor developer/src/kmc-copy main.d.ts +builder_run_action api typescript_run_api_extractor developer/src/kmc-generate main.d.ts builder_run_action test typescript_run_eslint_mocha_tests diff --git a/developer/src/kmc-keyboard-info/build.sh b/developer/src/kmc-keyboard-info/build.sh index 58b415b47f..abd4604d96 100755 --- a/developer/src/kmc-keyboard-info/build.sh +++ b/developer/src/kmc-keyboard-info/build.sh @@ -32,7 +32,7 @@ builder_parse "$@" builder_run_action clean rm -rf ./build/ ./tsconfig.tsbuildinfo builder_run_action configure node_select_version_and_npm_ci builder_run_action build tsc --build -builder_run_action api typescript_run_api_extractor developer/src/kmc-copy index.d.ts +builder_run_action api typescript_run_api_extractor developer/src/kmc-keyboard-info index.d.ts builder_run_action test typescript_run_eslint_mocha_tests #------------------------------------------------------------------------------------------------------------------- diff --git a/developer/src/kmc-kmn/build.sh b/developer/src/kmc-kmn/build.sh index bb64f5c48d..2f1dd214ed 100755 --- a/developer/src/kmc-kmn/build.sh +++ b/developer/src/kmc-kmn/build.sh @@ -65,5 +65,5 @@ function do_test() { } builder_run_action build do_build -builder_run_action api typescript_run_api_extractor developer/src/kmc-copy main.d.ts +builder_run_action api typescript_run_api_extractor developer/src/kmc-kmn main.d.ts builder_run_action test do_test diff --git a/developer/src/kmc-ldml/build.sh b/developer/src/kmc-ldml/build.sh index 627286551c..b9e259e8df 100755 --- a/developer/src/kmc-ldml/build.sh +++ b/developer/src/kmc-ldml/build.sh @@ -85,5 +85,5 @@ builder_run_action clean do_clean builder_run_action configure do_configure builder_run_action build do_build builder_run_action build-fixtures do_build_fixtures -builder_run_action api typescript_run_api_extractor developer/src/kmc-copy main.d.ts +builder_run_action api typescript_run_api_extractor developer/src/kmc-ldml main.d.ts builder_run_action test typescript_run_eslint_mocha_tests 90 diff --git a/developer/src/kmc-model-info/build.sh b/developer/src/kmc-model-info/build.sh index deb29bcd01..75b1d5d17e 100755 --- a/developer/src/kmc-model-info/build.sh +++ b/developer/src/kmc-model-info/build.sh @@ -29,5 +29,5 @@ builder_parse "$@" builder_run_action clean rm -rf ./build/ ./tsconfig.tsbuildinfo builder_run_action configure node_select_version_and_npm_ci builder_run_action build tsc --build -builder_run_action api typescript_run_api_extractor developer/src/kmc-copy index.d.ts +builder_run_action api typescript_run_api_extractor developer/src/kmc-model-info index.d.ts builder_run_action test typescript_run_eslint_mocha_tests 55 diff --git a/developer/src/kmc-model/build.sh b/developer/src/kmc-model/build.sh index ab32fbd153..c01a4cdb76 100755 --- a/developer/src/kmc-model/build.sh +++ b/developer/src/kmc-model/build.sh @@ -36,5 +36,5 @@ function do_build() { builder_run_action clean rm -rf ./build/ ./tsconfig.tsbuildinfo builder_run_action configure node_select_version_and_npm_ci builder_run_action build do_build -builder_run_action api typescript_run_api_extractor developer/src/kmc-copy main.d.ts +builder_run_action api typescript_run_api_extractor developer/src/kmc-model main.d.ts builder_run_action test typescript_run_eslint_mocha_tests diff --git a/developer/src/kmc-package/build.sh b/developer/src/kmc-package/build.sh index d435bb5919..fe2102ff40 100755 --- a/developer/src/kmc-package/build.sh +++ b/developer/src/kmc-package/build.sh @@ -34,5 +34,5 @@ builder_parse "$@" builder_run_action clean rm -rf ./build/ ./tsconfig.tsbuildinfo builder_run_action configure node_select_version_and_npm_ci builder_run_action build tsc --build -builder_run_action api typescript_run_api_extractor developer/src/kmc-copy main.d.ts +builder_run_action api typescript_run_api_extractor developer/src/kmc-package main.d.ts builder_run_action test typescript_run_eslint_mocha_tests