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 13
spiegel-keyman/developer/js
History
Marc Durdin 65c8c89be5 chore(web): adapts keyman-version bundling in Developer products 
As KEYMAN-VERSION changed from being a type to a class, this broke the
bundling and referencing strategies in Developer/Server and
Developer/kmlmc. This updates the bundling process and fixes the
references in both projects.

Note that keyman-version no longer depends on gosh. Given we are
currently manually calling the build for this in all projects (or should
be!), it's better that we keep the build of this explicit for now.

If we want to restore the postinstall/postci steps in the future, the
gosh dependency would need to be manually removed from package.json in
order for the bundling builds to work for Developer/Server and
Developer/kmlmc.
2022-05-28 10:57:24 +10:00
..
libexec docs(developer/compilers): document purpose of create-override-script-regexp 2020-08-26 14:55:21 -06:00
source chore(web): adapts keyman-version bundling in Developer products 2022-05-28 10:57:24 +10:00
tests chore(web): bulk renderer tsc cleanup 2022-05-16 05:50:11 +10:00
.gitignore chore(developer): fixup paths for tests 2022-05-14 15:35:06 +10:00
.npmignore chore(developer): refactor model compiler bundling into bash script 2021-12-22 04:47:05 +11:00
build.sh chore(web): adds direct keyman-version compile to many build.sh's 2022-05-24 10:11:57 +07:00
bundle.sh chore(web): adapts keyman-version bundling in Developer products 2022-05-28 10:57:24 +10:00
package.json chore(developer): fixup paths for tests 2022-05-14 15:35:06 +10:00
README.md fix(windows): improve version numbers 2020-10-08 09:13:48 +11:00
tsconfig.json chore(developer): fixup paths for tests 2022-05-14 15:35:06 +10: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