mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-05 16:35:33 +00:00
f3fb3ac87b
Removes a number of unused functions from the file, renames remaining functions to match our builder script prefix patterns, removes unused imports from various build scripts (e.g. Android). Fixes: #14453
216 lines
8.5 KiB
Bash
Executable file
216 lines
8.5 KiB
Bash
Executable file
#!/usr/bin/env bash
|
|
#
|
|
# Compile keymanweb and copy compiled javascript and resources to output/embedded folder
|
|
|
|
## 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
|
|
|
|
. "$KEYMAN_ROOT/resources/build/utils.inc.sh"
|
|
|
|
# ################################ Main script ################################
|
|
|
|
builder_set_child_base src
|
|
builder_describe "Builds engine modules for Keyman Engine for Web (KMW)." \
|
|
\
|
|
"@/resources/tools/check-markdown test:help" \
|
|
\
|
|
"clean" \
|
|
"configure" \
|
|
"build" \
|
|
"test" \
|
|
"coverage Create an HTML page with code coverage" \
|
|
":app/browser The form of Keyman Engine for Web for use on websites" \
|
|
":app/webview A puppetable version of KMW designed for use in a host app's WebView" \
|
|
":app/ui Builds KMW's desktop form-factor keyboard-selection UI modules" \
|
|
":engine/attachment Subset used for detecting valid page contexts for use in text editing " \
|
|
":engine/common/web-utils Low-level, headless utility methods and classes used across multiple modules" \
|
|
":engine/dom-utils A common subset of function used for DOM calculations, layout, etc" \
|
|
":engine/events Specialized classes utilized to support KMW API events" \
|
|
":engine/element-wrappers Subset used to integrate with website elements" \
|
|
":engine/interfaces Subset used to configure KMW" \
|
|
":engine/js-processor Build JS processor for KMW" \
|
|
":engine/keyboard Builds KMW's keyboard-loading and caching code" \
|
|
":engine/keyboard-storage Subset used to collate keyboards and request them from the cloud" \
|
|
":engine/main Builds all common code used by KMW's app/-level targets" \
|
|
":engine/osk Builds the Web OSK module" \
|
|
":engine/predictive-text Builds KMW's predictive text module" \
|
|
":help Online documentation" \
|
|
":samples Builds all needed resources for the KMW sample-page set" \
|
|
":tools Builds engine-related development resources" \
|
|
":test-pages=src/test/manual Builds resources needed for the KMW manual testing pages" \
|
|
":_all (Meta build target used when targets are not specified)"
|
|
|
|
# Possible TODO?
|
|
# "upload-symbols Uploads build product to Sentry for error report symbolification. Only defined for $DOC_BUILD_EMBED_WEB" \
|
|
|
|
builder_parse "$@"
|
|
|
|
config=release
|
|
if builder_is_debug_build; then
|
|
config=debug
|
|
fi
|
|
|
|
builder_describe_outputs \
|
|
configure "/node_modules" \
|
|
build "/web/build/test/dom/cases/attachment/outputTargetForElement.tests.html" \
|
|
build:app/browser "/web/build/app/browser/lib/index.mjs" \
|
|
build:app/webview "/web/build/app/webview/${config}/keymanweb-webview.js" \
|
|
build:app/ui "/web/build/app/ui/${config}/kmwuitoggle.js" \
|
|
build:engine/attachment "/web/build/engine/attachment/lib/index.mjs" \
|
|
build:engine/dom-utils "/web/build/engine/dom-utils/obj/index.js" \
|
|
build:engine/events "/web/build/engine/events/lib/index.mjs" \
|
|
build:engine/element-wrappers "/web/build/engine/element-wrappers/lib/index.mjs" \
|
|
build:engine/interfaces "/web/build/engine/interfaces/lib/index.mjs" \
|
|
build:engine/js-processor "/web/build/engine/js-processor/lib/index.mjs" \
|
|
build:engine/keyboard "/web/build/engine/keyboard/lib/index.mjs" \
|
|
build:engine/keyboard-storage "/web/build/engine/keyboard-storage/lib/index.mjs" \
|
|
build:engine/main "/web/build/engine/main/lib/index.mjs" \
|
|
build:engine/osk "/web/build/engine/osk/lib/index.mjs" \
|
|
build:engine/predictive-text "/web/src/engine/predictive-text/worker-main/build/lib/web/index.mjs" \
|
|
build:engine/common/web-utils "/web/src/engine/common/web-utils/build/lib/index.mjs" \
|
|
build:samples "/web/src/samples/simplest/keymanweb.js" \
|
|
build:tools "/web/build/tools/building/sourcemap-root/index.js" \
|
|
build:test-pages "/web/build/test-resources/sentry-manager.js"
|
|
|
|
BUNDLE_CMD="node ${KEYMAN_ROOT}/web/src/tools/es-bundling/build/common-bundle.mjs"
|
|
|
|
#### Build action definitions ####
|
|
|
|
##################### TODO: call child action, verify things work as expected!
|
|
|
|
# We can run all clean & configure actions at once without much issue.
|
|
|
|
builder_run_action clean:_all rm -rf build/
|
|
|
|
builder_run_child_actions clean
|
|
|
|
## Clean actions
|
|
|
|
###--- Future tie-in: if #8831 gets accepted, uncomment the next two lines. ---###
|
|
# # If a full-on general clean was requested, we can nuke the entire build folder.
|
|
# builder_run_action clean:project rm -rf ./build
|
|
|
|
builder_run_child_actions configure
|
|
|
|
## Build actions
|
|
|
|
precompile() {
|
|
local DIR
|
|
DIR="$1"
|
|
|
|
builder_echo "Pre-compiling ${DIR}..."
|
|
|
|
# pre-compile bundle for use in DOM testing. When running in the browser several
|
|
# types built-in to Node aren't available, and @web/test-runner doesn't do
|
|
# treeshaking when loading the imports. We work around by pre-compiling.
|
|
for f in "${DIR}"/*.js; do
|
|
${BUNDLE_CMD} "${f}" \
|
|
--out "${f%.js}".mjs \
|
|
--format esm
|
|
done
|
|
}
|
|
|
|
build_action() {
|
|
builder_echo "Building auto tests..."
|
|
|
|
# The currently-bundled declaration file for gesture-processor generates
|
|
# errors when compiling against it with current tsc versions.
|
|
rm -f "${KEYMAN_ROOT}/node_modules/promise-status-async/lib/index.d.ts"
|
|
|
|
tsc --project "${KEYMAN_ROOT}/web/src/test/auto/tsconfig.json"
|
|
|
|
for dir in \
|
|
"${KEYMAN_ROOT}/web/build/test/dom/cases"/*/ \
|
|
"${KEYMAN_ROOT}/web/build/test/integrated/" \
|
|
"${KEYMAN_ROOT}/web/build/test/integrated/cases/";
|
|
do
|
|
precompile "${dir}"
|
|
done
|
|
|
|
cp "${KEYMAN_ROOT}/web/src/test/auto/dom/cases/attachment/outputTargetForElement.tests.html" \
|
|
"${KEYMAN_ROOT}/web/build/test/dom/cases/attachment/"
|
|
}
|
|
|
|
coverage_action() {
|
|
builder_echo "Creating coverage report..."
|
|
|
|
# Always ensure our collation folder is clean, just in case something went wrong on a prior run.
|
|
rm -rf build/coverage/tmp
|
|
|
|
# Also clean out the sub-report directories + main index.html; don't keep old ones if we fail!
|
|
rm -rf build/coverage/app
|
|
rm -rf build/coverage/engine
|
|
rm -f build/coverage/index.html
|
|
|
|
# Collate the results into a single folder
|
|
mkdir build/coverage/tmp
|
|
find . -type f -name coverage-\*.json -print0 | xargs -0 cp -t build/coverage/tmp
|
|
|
|
# Note for maintainers: the .c8rc.json config needs to be written from the perspective of
|
|
# the working directory - including its `include` and `exclude` entries. All ignores and
|
|
# such must be redefined in whatever that top-level .c8rc.json is.
|
|
c8 report --reporter html
|
|
|
|
# No need to keep the collation folder around afterward; we can always redo that work.
|
|
rm -rf build/coverage/tmp
|
|
}
|
|
|
|
builder_run_child_actions build:engine/common/web-utils
|
|
builder_run_child_actions build:engine/dom-utils
|
|
|
|
builder_run_child_actions build:engine/keyboard
|
|
builder_run_child_actions build:engine/js-processor
|
|
builder_run_child_actions build:engine/element-wrappers
|
|
builder_run_child_actions build:engine/events
|
|
builder_run_child_actions build:engine/interfaces
|
|
|
|
# Uses engine/dom-utils and engine/interfaces
|
|
builder_run_child_actions build:engine/osk
|
|
|
|
# Uses engine/element-wrappers
|
|
builder_run_child_actions build:engine/attachment
|
|
|
|
# Uses engine/interfaces (due to resource-path config interface)
|
|
builder_run_child_actions build:engine/keyboard-storage
|
|
|
|
# Builds the predictive-text components
|
|
builder_run_child_actions build:engine/predictive-text
|
|
|
|
# Uses engine/interfaces, engine/keyboard-storage, engine/predictive-text, & engine/osk
|
|
builder_run_child_actions build:engine/main
|
|
|
|
# Uses all but engine/element-wrappers and engine/attachment
|
|
builder_run_child_actions build:app/webview
|
|
|
|
# Uses literally everything `engine/` above
|
|
builder_run_child_actions build:app/browser
|
|
|
|
# Uses app/browser above for engine type-defs
|
|
builder_run_child_actions build:app/ui
|
|
|
|
# Needs both app/browser and app/ui.
|
|
builder_run_child_actions build:samples
|
|
|
|
builder_run_child_actions build:tools
|
|
|
|
# Some test pages refer to KMW tools.
|
|
builder_run_child_actions build:test-pages
|
|
|
|
# Build tests
|
|
builder_run_action build:_all build_action
|
|
|
|
# Run tests
|
|
builder_run_child_actions test
|
|
builder_run_action test:_all ./test.sh
|
|
|
|
function do_test_help() {
|
|
check-markdown "$KEYMAN_ROOT/web/docs/engine"
|
|
}
|
|
|
|
builder_run_action test:help do_test_help
|
|
|
|
# Create coverage report
|
|
builder_run_action coverage:_all coverage_action
|