feat(developer): kmc generate

[mcdurdin]

Fixes: #10712
Fixes: #10509

kmc-generate is a tool that will replace most aspects of kmconvert (Windows-only). The remaining functionality in kmconvert is importing keyboards from Windows DLLs, which currently requires a running Windows environment (anticipate replacement of this last piece of functionality with something in epic/kmc-convert (#12191))..

kmc-generate follows the same patterns as other kmc modules. All functions are accessible from the kmc command-line tool, and also scriptable with the standalone npm module.

Usage:

kmc generate keyman-keyboard my_kmn_keyboard [options]
kmc generate ldml-keyboard my_ldml_keyboard [options]
kmc generate lexical-model my.en.lexical_model_uniq [options]

Options vary from generator-to-generator. At this point, the generation tooling is largely template-based, which does limit a little what this tool can do. Renaming keyboards and other functionality will emerge in a future kmc module.

Note: TODO list moved to #12641.

User Testing

The purpose of the test here is to verify that the generate command creates a template project for a keyboard or lexical model with appropriate basic metadata.

For each command, run kmc generate <command> --help, to list options for generating the project. Include as many of the options as possible in your next command to generate a template project with them, and give it a sensible name e.g. generated_project.

TEST_KEYMAN_KEYBOARD: For the keyman-keyboard command, follow the instructions above to generate a basic Keyman keyboard. Then use kmc build generated_project to verify that the keyboard builds. Install the resulting .kmp and verify that it installs without error. View the source of the files, and verify that the contents of the generated files look correct and match the parameters you provided.

TEST_LDML_KEYBOARD: For the ldml-keyboard command, follow the instructions above to generate a basic LDML .xml keyboard (e.g. using id generated_ldml_keyboard). Then use kmc build generated_ldml_keyboard to verify that the keyboard builds. Install the resulting .kmp and verify that it installs without error. View the source of the files, and verify that the contents of the generated files look correct and match the parameters you provided.

TEST_LEXICAL_MODEL: For the lexical-model command, follow the instructions above to generate a basic lexical model (e.g. using id generated.en.model). Then use kmc build generated.en.model to verify that the lexical model builds. Install the resulting .kmp on an Android phone and verify that it installs without error. View the source of the files, and verify that the contents of the generated files look correct and match the parameters you provided.

[keymanapp-test-bot]

User Test Results

Test specification and instructions

• ✅ TEST_KEYMAN_KEYBOARD (PASSED) (notes)
• ✅ TEST_LDML_KEYBOARD (PASSED) (notes)
• ✅ TEST_LEXICAL_MODEL (PASSED) (notes)

Test Artifacts

• Android
  • Keyman for Android apk
  • FirstVoices for Android 16.0 apk
  • FirstVoices Keyboards for Android apk
  • KeyboardHarness apk
  • Keyman for Android 16.0 apk
  • KMSample1 apk
  • KMSample2 apk
• Developer
  • Keyman Developer
  • Compiler Regression Tests
  • kmcomp.zip
• iOS
  • Keyman for iOS (simulator image)
  • FirstVoices Keyboards for iOS (simulator image)
  • TestFlight internal PR build version - 18.0.127 (0.11014.12169)
• Keyboards
  • Test Keyboards
• Web
  • KeymanWeb Test Home
• Windows
  • Keyman for Windows
  • FirstVoices Keyboards for Windows
  • Text Editor (32 bit)
  • Text Editor (64 bit)

[dinakaranr]

Test Results

I tested this issue with the attached "Keyman 18.0.118-alpha-test-11014" build on Windows 10 and 11. I'm sharing my observation here.
Created a new folder under the download folder.
Open the command prompt in this folder.
Executed below commands to generate keyman keyboards.

kmc generate keyman-keyboard kmnkeyboard
kmc generate ldml-keyboard ldml_keyboard
kmc generate lexical-model en.lexicalmodeluniq

Verified that the keyboard folder was created with the specified name

• TEST_KEYMAN_KEYBOARD (Passed):

1. Go to the folder that had keyboards.
2. Open the command prompt in this folder.
3. Execute the "kmc build keyboard_folder_name" command.
4. Verified that the build folder was created inside the keyboard's folder.
5. Verified that the *.kmp file was created inside the build folder.
6. Install the *.kmp file in Windows 10 or 11
7. Verified that tha keyboard was added under "English"
8. Go to the source folder.
9. Verified that the generated files.

• TEST_LDML_KEYBOARD (Passed):

1. Go to the folder that had keyboards.
2. Open the command prompt in this folder.
3. Execute the "kmc build keyboard_folder_name" command.
4. Verified that the build folder was created inside the keyboard's folder.
5. Verified that the *.kmp file was created inside the build folder.
6. Install the *.kmp file in Windows 10 or 11
7. Verified that the keyboard was added under "English"
8. Go to the source folder.
9. Verified that the generated files.

• TEST_LEXICAL_MODEL (Passed):

1. Go to the folder that had keyboards.
2. Open the command prompt in this folder.
3. Execute the "kmc build keyboard_folder_name" command.
4. Verified that the build folder was created inside the keyboard's folder.
5. Verified that the *.kmp file was created inside the build folder.
6. Install the *.kmp file on an Android 12 mobile device.
7. Verified that the keyboard was added under "English."
8. Go to the source folder.
9. Verified that the generated files.

[darcywong00]

Is this the standard import for all LDML keyboards? (vs generator referencing files in a 45/ path)

[mcdurdin]

Good question @srl295

[mcdurdin]

Pinging @srl295 on this query

Is this the standard import for all LDML keyboards? (vs generator referencing files in a 45/ path)

<keys>
  <import base="cldr" path="45/keys-Zyyy-punctuation.xml"/>
  <import base="cldr" path="45/keys-Zyyy-currency.xml"/>

[darcywong00]

whew - I've made 1 pass through all the files

[darcywong00]

lgtm

[keyman-server]

Changes in this pull request will be available for download in Keyman version 18.0.138-alpha