spiegel-keyman/developer/src/kmlmc
Marc Durdin 14094c8979 feat(developer): add kmlmc and kmldmlc to make test
Also removes `-test` from normal `make build` for kmlmc, moving that
responsibility to `make test` (but uses `-tdd` to avoid rebuild).
2022-09-01 15:28:41 +10:00
..
libexec chore(developer): move kmlmc to developer/src/kmlmc 2022-05-18 10:13:03 +10:00
source chore(developer): Merge branch 'master' into chore/developer/js-to-lmc 2022-06-25 05:48:57 +10:00
tests chore(developer): update test build scripts 2022-05-23 06:08:36 +10:00
.gitignore chore(developer): move kmlmc to developer/src/kmlmc 2022-05-18 10:13:03 +10:00
.npmignore chore(developer): move kmlmc to developer/src/kmlmc 2022-05-18 10:13:03 +10:00
build.sh chore(common): use /usr/bin/env bash 2022-07-25 14:59:37 +10:00
bundle.sh chore(developer): +x for scripts 2022-06-25 09:32:57 +10:00
Makefile feat(developer): add kmlmc and kmldmlc to make test 2022-09-01 15:28:41 +10:00
package.json chore(developer): move kmlmc to developer/src/kmlmc 2022-05-18 10:13:03 +10:00
README.md chore(developer): move kmlmc to developer/src/kmlmc 2022-05-18 10:13:03 +10:00
tsconfig.json chore(developer): move kmlmc to developer/src/kmlmc 2022-05-18 10:13:03 +10:00

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.kmp file to generate a redistributable lexical model package.
  • kmlmi — merges Keyman lexical model .model_info files.

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