c3458d040c
kmcmplib no longer has any filesystem access, so it cannot verify if a referenced filename in a source file has the same case as the actual filename on disk (a risk when moving projects between platforms). So I opted to move this to the `loadFile` callback in kmc, which is the only place where filesystem is actually accessed, and added corresponding unit test. Small additional fixes here: 1. Move from `Buffer` to `Uint8Array` in all kmc-* modules, so that we remove that barrier to running on web. 2. Use `callbacks.loadFile` instead of `callbacks.fs.readFileSync`, so that we can be sure to run the filename consistency check. 3. Fixed kps parser silently swallowing xml errors on load. 4. Added silent mode to NodeCompilerCallbacks so we could cleanly test the new filename consistency hint. 5. Noted a location where we still have NodeJS deps in kmc-ldml. |
||
|---|---|---|
| .. | ||
| src | ||
| test | ||
| .eslintrc.cjs | ||
| build.sh | ||
| Makefile | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
| tsconfig.kmc-base.json | ||
Keyman Developer - Next Generation Compiler
This package provides the following Keyman command line tools:
kmc— takes LDML Keyboard .xml sources and compiles them in to a KMXPlus .kmx file.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.
Note: kmc will in the future replace kmlmc, kmlmp, and kmlmi.
In order to build lexical models, these tools must be built and compiled.
Install
Install kmc globally:
npm install -g @keymanapp/kmc
kmc Usage
To compile an LDML keyboard from its .xml source, use kmc:
kmc build my-keyboard.xml --outFile my-keyboard.kmx
To see more command line options by using the --help option:
kmc --help
kmlmc 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 configure build
or (less preferably -- build.sh is more efficient):
nmake configure build
Once you have configured once, you should not normally need to do it again
unless dependencies change or you clean the build folder. ./build.sh without
parameters will do the default action, which is build.
TODO: Note that kmc currently depends on kmc-* to have been configured; while the build of kmc will do the typescript component of the build, it will not be able to do any other build steps, so you may wish to build each of the components separately, one time.
How to run the tests
./build.sh test
How to prepare bundling for installation
./build.sh bundle --build-path <temp_path>
The temp_path must be a path outside the repository to avoid npm getting confused by the root package.json. This is called by inst/download.in.mak normally when building the Keyman Developer installer.
How to publish to NPM
./build.sh publish [--dry-run]
Publishes the current release to NPM. This should only be run from CI.