erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 16:35:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11
spiegel-keyman/developer/js
History
Keyman Build Agent 59e150b2c1 auto: increment master version to 14.0.156
2020-10-07 14:00:57 -04:00
..
libexec docs(developer/compilers): document purpose of create-override-script-regexp 2020-08-26 14:55:21 -06:00
source docs(developer/compilers): hopefully more clear documentation for break-words-at-spaces option 2020-08-26 14:49:24 -06:00
tests test(developer/compilers): strong assertions for script overrides breaker 2020-08-26 10:11:46 -06:00
.gitignore [developer] Initial lexical model compiler files (not yet working) 2019-05-08 10:40:46 +10:00
.npmignore change(developer/compilers): addresses PR review 2020-05-29 14:01:45 +07:00
build.sh change(common/models): remove unnecessary build step 2020-05-25 08:47:59 -06:00
package-lock.json auto: increment master version to 14.0.156 2020-10-07 14:00:57 -04:00
package.json auto: increment master version to 14.0.156 2020-10-07 14:00:57 -04:00
README.md Make lexical-model-compiler README slightly more user-centric. 2019-10-05 14:50:39 -06:00
tsconfig.json fix(common/models): use correct paths for models-types 2020-05-22 11:42:28 -06:00

README.md

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

How to update the package version

NOTE: this step should only be performed on the CI server:

./build.sh -version MAJOR.MINOR.${BUILD_NUMBER} [-tier (alpha|beta)]