spiegel-keyman/core/tools/api-header-extractor/build.sh
Marc Durdin f394245636 maint(common): consolidate builder scripts
Clarifies the confusing builder.inc.sh / build-utils.sh distinction by
giving the scripts more appropriate names. Most build scripts should use
builder-full.inc.sh; some helper scripts can use builder-basic.inc.sh.
Documented in resources/build/README.md.

Renames:
* resources/build/builder.inc.sh to resources/build/builder-full.inc.sh
* resources/build/build-utils.sh to resources/build/builder-basic.inc.sh

Other changes:
* Moves Android-specific functions out of builder-basic.inc.sh and into
  android/build.sh.
* Renames functions in builder-basic.inc.sh

More functions may be moved from builder-basic.inc.sh into utils.inc.sh
or other scripts in the future.

Fixes: #14065
Build-bot: build all
Test-bot: skip
2025-08-02 08:11:24 +10:00

36 lines
1.2 KiB
Bash
Executable file

#!/usr/bin/env bash
## START STANDARD BUILD SCRIPT INCLUDE
# adjust relative paths as necessary
THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
. "${THIS_SCRIPT%/*}/../../../resources/build/builder-full.inc.sh"
## END STANDARD BUILD SCRIPT INCLUDE
CORE_ROOT="$KEYMAN_ROOT/core"
CORE_H_FILE="$CORE_ROOT/include/keyman/keyman_core_api.h"
CORE_H_DOC="index.md"
OUTPATH="$CORE_ROOT/build/docs/internal"
################################ Main script ################################
builder_describe "Extract documentation from header files" clean configure build run
builder_parse "$@"
builder_run_action clean rm -rf "${OUTPATH}"
builder_run_action build tsc --build
if builder_start_action run; then
rm -rf "$OUTPATH"
mkdir -p "$OUTPATH"
node --enable-source-maps ./build/src/index.js "${CORE_H_FILE}" "${OUTPATH}"
echo "Wrote documentation to ${OUTPATH}/${CORE_H_DOC}"
# if [ ! -z "${HELP_KEYMAN_COM+x}" ]; then
# # TODO move this to help-keyman-com.sh
# rm -rf "${HELP_KEYMAN_COM}developer/core/desktop/17.0/c-api/"
# mkdir -p "${HELP_KEYMAN_COM}developer/core/desktop/17.0/c-api/"
# cp "${OUTPATH}/"* "${HELP_KEYMAN_COM}developer/core/desktop/17.0/c-api/"
# fi
builder_finish_action success run
fi