mirror of
https://github.com/keymanapp/keyman.git
synced 2026-09-21 23:27:39 +00:00
4d94786852
Fixes #6320. Part 1 of moving from lerna to a simpler, maintained monorepo solution, using TypeScript Projects and NPM Workspaces. There is more work to be done here. At this point, KeymanWeb builds and runs without errors, but the built file is substantially different, mostly in include order. Using TypeScript Projects, we move away from the need to run build scripts in various locations for almost all the Typescript modules. TODO: Embedded versions and tests have not been verified. TODO: developer/server is not yet verified. TODO: developer/js (needs a rename!) is not yet verified. TODO: Currently, the predictive-text folder needs refactoring to move the construction of the worker wrapper out of the Predictive Text build and into the final assembly of keymanweb.js (as it should be valid to run it as a separate .js anyway). TODO: Most of the `<reference>` paths need to be re-verified. Ideally there should be no references outside the current module for any given .ts. TODO: The embedded vs browser vs node (headless) builds should be tidied up for consistency so that it's obvious what depends on what. This is currently messiest in the predictive-text folder, where the output names diverge from the filenames and the various files are mixed in the same folder (as evidenced by the exclusions listed in each tsconfig.json). TODO: `npm install` should be removed from most build scripts and instead `npm ci` (#6196) should be run only once from the top-level folder for any given build. I've had eliminated side-effects from the `install` action for npm, which makes it easier to reason about state. TODO: verify_npm_setup and related functions can probably be eliminated. TODO: most of the build scripts should be largely eliminated for web. TODO: several ts projects use inconsistent output folders. TODO: it may be possible to generate a .d.ts for models/types so that we can use a consistent reference for those as well. TODO: build.sh, tsconfig.json should always be in the module's top-level folder, not in a subfolder such as src (e.g. see input-processor/src, keyboard-processor/src, web/source). TODO: resources/web-environment should be in common/web. TODO: other js node_modules imports should be wrapped like es6-shim. TODO: fix up the publish code for npm modules TODO: eliminate version numbers from package.json if possible? Whew, that's most of the stuff I noticed! |
||
|---|---|---|
| .. | ||
| libexec | ||
| source | ||
| tests | ||
| .gitignore | ||
| .npmignore | ||
| build.sh | ||
| bundle.sh | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
Keyman Developer
This package provides the following Keyman command line tools:
kmlmc— takes lexical model sources and compiles them in to a .js file.kmlmp— uses a.model.kmpfile to generate a redistributable lexical model package.kmlmi— merges Keyman lexical model.model_infofiles.
kmlmc is intended to be used standalone, or as part of a build system.
kmlmp is used only by command line tools. kmlmi is used exclusively
in the lexical-models repository.
In order to build lexical models, these tools must be built and compiled.
Install
Install kmlmc, kmlmp, and kmlmi globally:
npm install -g @keymanapp/lexical-model-compiler
Usage
To compile a lexical model from its .model.ts source, use kmlmc:
kmlmc my-lexical-model.model.ts --outFile my-lexical-model.js
To see more command line options by using the --help option:
kmlmc --help
kmlmp --help
kmlmi --help
How to build from source
Run build.sh:
./build.sh
How to run the tests
./build.sh -test