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
Marc Durdin 2c01b19f69 chore: cleanup 
1. Renamed form UfrmNGrokOptions to UfrmServerOptions
2. Renamed kmdev-server to just plain server
3. Tidied up npm versioning to use VERSION_WITH_TAG

This last point should help avoid confusion as now only CI release
builds will ever generate a package.json with a.b.c, a.b.c-alpha or
a.b.c-beta. Local and test builds will always have the corresponding
-test or -local environment appended. This also helps avoid issues if
we accidentally publish an incorrect version.
2021-12-22 06:25:22 +11:00
..
libexec docs(developer/compilers): document purpose of create-override-script-regexp 2020-08-26 14:55:21 -06:00
source fix(developer): Update buildKmpFile to return Promise 2021-10-16 16:29:09 +07:00
tests fix(developer): downgrade additional let and arrow functions 2021-03-18 17:51:59 +11: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 chore: cleanup 2021-12-22 06:25:22 +11:00
package-lock.json auto: increment master version to 15.0.171 2021-12-16 13:01:48 -05:00
package.json auto: increment master version to 15.0.171 2021-12-16 13:01:48 -05:00
README.md fix(windows): improve version numbers 2020-10-08 09:13:48 +11: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