erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-28 19:27:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 14
spiegel-keyman/developer/js
History
Marc Durdin 2f2f998da6 fix(developer): schema conformance for model package compiler 
Fixes #3199.

Ensures that the model package compiler passes schema validation for
kmp.json. Three problems were corrected:

1. `followKeyboardVersion` is a source-only property; it should not be
   in deployable kmp.json.
2. `copyLocation` should have been a number not a string (in XML
   everything is a string... but JSON has more control here)
3. `fileType` is a source-only property; it also should not be in
   deployable kmp.json.

I have checked that the resulting files validate against the package
kmp.json schema version 1.1.0 defined at
https://github.com/keymanapp/api.keyman.com/blob/master/schemas/package/1.1.0/package.json.

None of these fixes should impact the use of these packages in target
apps. `followKeyboardVersion` and `fileType` are used only in the source
at package development time, and `copyLocation` is unused (and should be
eliminated from Keyman altogether in the future).
2021-03-01 10:57:49 +11:00
..
libexec docs(developer/compilers): document purpose of create-override-script-regexp 2020-08-26 14:55:21 -06:00
source fix(developer): schema conformance for model package compiler 2021-03-01 10:57:49 +11:00
tests fix(developer): schema conformance for model package compiler 2021-03-01 10:57:49 +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 fix(developer): schema conformance for model package compiler 2021-03-01 10:57:49 +11:00
package-lock.json auto: increment beta version to 14.0.249 2021-02-26 13:02:44 -05:00
package.json auto: increment beta version to 14.0.249 2021-02-26 13:02:44 -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