@keymanapp/kmc NPM | npm.io

17.0.60-alpha • Published 22 hours ago

Install

Weekly downloads

-

License

MIT

Repository

Last release

22 hours ago

Keyman Developer - Next Generation Compiler

This package provides the following Keyman command line tools:

kmc — takes LDML Keyboard .xml sources and compiles them in to a KMXPlus .kmx file.
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.

Note: kmc will in the future replace kmlmc, kmlmp, and kmlmi.

In order to build lexical models, these tools must be built and compiled.

Install

Install kmc globally:

npm install -g @keymanapp/kmc

kmc Usage

To compile an LDML keyboard from its .xml source, use kmc:

kmc build my-keyboard.xml --outFile my-keyboard.kmx

To see more command line options by using the --help option:

kmc --help

kmlmc 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 configure build

or (less preferably -- build.sh is more efficient):

nmake configure build

Once you have configured once, you should not normally need to do it again unless dependencies change or you clean the build folder. ./build.sh without parameters will do the default action, which is build.

TODO: Note that kmc currently depends on kmc-* to have been configured; while the build of kmc will do the typescript component of the build, it will not be able to do any other build steps, so you may wish to build each of the components separately, one time.

How to run the tests

./build.sh test

How to prepare bundling for installation

./build.sh bundle --build-path <temp_path>

The temp_path must be a path outside the repository to avoid npm getting confused by the root package.json. This is called by inst/download.in.mak normally when building the Keyman Developer installer.

How to publish to NPM

./build.sh publish [--dry-run]

Publishes the current release to NPM. This should only be run from CI.

keyboard keyman ldml unicode lexical-model predictive-text

@keymanapp/common-types @keymanapp/developer-utils @keymanapp/keyman-version @keymanapp/kmc-analyze @keymanapp/kmc-keyboard-info @keymanapp/kmc-kmn @keymanapp/kmc-ldml @keymanapp/kmc-model @keymanapp/kmc-model-info @keymanapp/kmc-package @keymanapp/models-types @sentry/node chalk commander supports-color

@everything-registry/sub-chunk-515

22 hours ago

24 hours ago

2 days ago

3 days ago

3 days ago

4 days ago

6 days ago

6 days ago

8 days ago

7 days ago

8 days ago

9 days ago

10 days ago

10 days ago

11 days ago

14 days ago

14 days ago

15 days ago

15 days ago

16 days ago

17 days ago

18 days ago

21 days ago

21 days ago

22 days ago

23 days ago

25 days ago

27 days ago

28 days ago

28 days ago

29 days ago

30 days ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

6 months ago

7 months ago

7 months ago

9 months ago

10 months ago

10 months ago

6 months ago

9 months ago

7 months ago

6 months ago

7 months ago

10 months ago

9 months ago

9 months ago

9 months ago

10 months ago

6 months ago

10 months ago

7 months ago

7 months ago

10 months ago

9 months ago

6 months ago

7 months ago

8 months ago

9 months ago

5 months ago

9 months ago

10 months ago

6 months ago

9 months ago

5 months ago

10 months ago

7 months ago

9 months ago

6 months ago

7 months ago

9 months ago

6 months ago

8 months ago

9 months ago

10 months ago

5 months ago

7 months ago

7 months ago

6 months ago

10 months ago

9 months ago

11 months ago

8 months ago

5 months ago

6 months ago

9 months ago

10 months ago

7 months ago

6 months ago

10 months ago

10 months ago

10 months ago

9 months ago

10 months ago

9 months ago

9 months ago

6 months ago

10 months ago

7 months ago

7 months ago

6 months ago

7 months ago

8 months ago

9 months ago

5 months ago

6 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

12 months ago

1 year ago

11 months ago

11 months ago

12 months ago

11 months ago

11 months ago

11 months ago

12 months ago

1 year ago

12 months ago

1 year ago

11 months ago

12 months ago

11 months ago

11 months ago

12 months ago

1 year ago

1 year ago

11 months ago

12 months ago

11 months ago

11 months ago

11 months ago

1 year ago

1 year ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago