mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-05 00:15:32 +00:00
chore(developer): fix docs, api_extractor params in build.sh's
Some checks failed
Keyman Build Summary / Summarize build status checks (push) Has been cancelled
Some checks failed
Keyman Build Summary / Summarize build status checks (push) Has been cancelled
Test-bot: skip Build-bot: skip release:developer
This commit is contained in:
parent
d86604902e
commit
b535203e36
8 changed files with 28 additions and 22 deletions
|
|
@ -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.
|
||||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
#-------------------------------------------------------------------------------------------------------------------
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue