spiegel-keyman/developer/src/kmlmc
2023-02-16 15:18:50 +07:00
..
libexec chore(developer): move kmlmc to developer/src/kmlmc 2022-05-18 10:13:03 +10:00
source chore(common/web): Merge branch 'feature-esmodule-web-engine' into change/common/web/input-processor-modularization 2023-02-02 15:42:07 +07:00
tests feat(common/models): directional quotes now match against nondirectional ones 2022-11-18 14:15:53 +07:00
.gitignore chore(developer): move kmlmc to developer/src/kmlmc 2022-05-18 10:13:03 +10:00
.npmignore fix(developer): publish @keymanapp/keyman-version to npm 2022-11-02 13:33:24 +11:00
build.sh fix(developer): publish @keymanapp/keyman-version to npm 2022-11-02 13:33:24 +11:00
bundle.sh chore(developer): +x for scripts 2022-06-25 09:32:57 +10:00
Makefile Update developer/src/kmlmc/Makefile 2022-06-14 14:51:33 +10:00
package.json chore(common): full-repo ts-node update 2023-02-09 12:39:15 +07: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