erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 08:25:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10
spiegel-keyman/developer/js
History
Marc Durdin 22b1580e52 chore: remove node as a dependency
2019-12-10 10:33:52 +00:00
..
source Merge pull request #2392 from keymanapp/developer-strict-checks 2019-11-30 16:14:49 -07:00
tests test: also test for REPLACEMENT CHARACTER 2019-12-09 18:48:36 +00:00
.gitignore [developer] Initial lexical model compiler files (not yet working) 2019-05-08 10:40:46 +10:00
.npmignore Create publish script and document. 2019-09-30 13:24:51 -06:00
build.sh build.sh always installs deps, even when given -test. 2019-10-02 13:46:02 -06:00
package-lock.json chore: remove node as a dependency 2019-12-10 10:33:52 +00:00
package.json chore: remove node as a dependency 2019-12-10 10:33:52 +00:00
README.md Make lexical-model-compiler README slightly more user-centric. 2019-10-05 14:50:39 -06:00
tsconfig.json change(developer): enable strict null checks 2019-11-27 16:43:31 -07: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)]