feat(developer): add user interface for kmc copy to TIKE

[mcdurdin]

Adds a new set of 'New Project' dialogs to allow authors to easily copy keyboards from local filesystem, Keyman Cloud (including a keyboard search web page, implemented in keymanapp/keyman.com#536), and directly from a GitHub URL. Adds related documentation.

Clone from local filesystem:

Clone from Keyman Cloud:

Clone from GitHub:

Fixes: #13073
Depends-on: keymanapp/keyman.com#536

User Testing

Please note that user test of TEST_CLONE_CLOUD is blocked until keymanapp/keyman.com#536 is merged.

For each of these tests, follow the steps to clone the project, using a new keyboard/lexical model id of your choice, and then make sure that the newly created project builds successfully.

• TEST_CLONE_LOCAL: Try and clone a keyboard project from the local filesystem using Project|New Project|Clone Local Project.
• TEST_CLONE_MODEL_LOCAL: Try and clone a lexical model project from the local filesystem using Project|New Project|Clone Local Project.
• TEST_CLONE_CLOUD: Try and clone a Keyman Cloud keyboard project using Project|New Project|Clone Project from Keyman Cloud. For example, try cloning sil_euro_latin or another well-known keyboard project.
• TEST_CLONE_GITHUB: Try and clone a keyboard project from a GitHub URL, using Project|New Project|Clone Project from GitHub. For example, use 'https://github.com/keymanapp/keyboards/tree/master/release/g/ghana/ghana.kpj'
• TEST_CLONE_MODEL_GITHUB: Try and clone a lexical model project from a GitHub URL, using Project|New Project|Clone Project from GitHub. For example, use 'https://github.com/keymanapp/lexical-models/blob/master/release/av/av.eo.esperanto/av.eo.esperanto.kpj'

[keymanapp-test-bot]

User Test Results

Test specification and instructions

• ✅ TEST_CLONE_LOCAL (PASSED) (notes)
• ✅ TEST_CLONE_MODEL_LOCAL (PASSED) (notes)
• ✅ TEST_CLONE_CLOUD (PASSED) (notes)
• ✅ TEST_CLONE_GITHUB (PASSED) (notes)
• ✅ TEST_CLONE_MODEL_GITHUB (PASSED) (notes)

Test Artifacts

• Developer
  • Keyman Developer
  • Compiler Regression Tests
  • kmcomp.zip
• Keyboards
  • Test Keyboards
• Windows
  • Keyman for Windows
  • FirstVoices Keyboards for Windows
  • Text Editor (32 bit)
  • Text Editor (64 bit)

[darcywong00]

What happens if the user tries to clone

• a legacy keyboard where the source isn't available?
• a multi-keyboard package?

[mcdurdin]

Good questions. The legacy keyboard would generate an error in the kmc-copy log, so the user would get feedback that way. An open source multi-keyboard package should copy fine -- the .kpj and .kps would get the new id, but the keyboards within would retain their original names. Would be worth a test for each of these, and so I'll give that a go.

[dinakaranr]

Test Results

I tested this issue with the attached "Keyman-18.0.178-alpha-test-13076" build(30/01/2025) on Windows 10. I'm sharing my observation here.

• TEST_CLONE_LOCAL (Passed):

1. Open the Keyman Developer application.
2. Open the "Clone local project" dialog by clicking the project -> New Project --> Clone local project.
3. "Source project filename": Select the keyboard *.kpj file from the Local GitHub clone directory.
4. Enter the project name in the "New project ID" text box.
5. Click the "Ok" button on the dialog.
   It works well. Thank you.

• TEST_CLONE_MODEL_LOCAL (Failed):

1. Open the Keyman_Developer application.
2. Open the "Clone local project" dialog by clicking the project -> New Project --> Clone local project.
3. "Source project filename": Select the keyboard *.kpj file from the local GitHub clone directory.(lexical-models)
4. Enter the project name in the "New project ID" text box.
5. Click the "Ok" button on the dialog.
   Actual Results: Here, an Error line appeared in the message box. (I have entered the project name in lowercase. but still, I am getting an error)
   Please take a look below screenshot

• TEST_CLONE_CLOUD (Failed):

1. Open the Keyman_Developer application.
2. Open the "Clone project from Keyman Cloud" dialog by clicking the project -> New Project --> Clone project from Keyman Cloud.
   Actual Results: Here, the Search box does not appear instead of "Not Found" message appears.
   Please take a look below screenshot

• TEST_CLONE_GITHUB (Passed):

1. Open the Keyman_Developer application.
2. Open the "Clone project from GitHub" dialog by clicking the project -> New Project --> Clone project from GitHub.
3. "GitHub URL": Paste the keyboard's GitHub URL
4. Enter the project name in the "New project ID" text box.
5. Click the "Ok" button on the dialog.
   It works well. Thank you.

• TEST_CLONE_MODEL_GITHUB (Failed):

1. Open the Keyman_Developer application.
2. Open the "Clone project from GitHub" dialog by clicking the project -> New Project --> Clone project from GitHub.
3. "GitHub URL": Paste the keyboard's GitHub URL(Lexical model)
4. Enter the project name in the "New project ID" text box.
5. Click the "Ok" button on the dialog.
   Actual Results: Here, an Error line appeared in the message box. (I have entered the project name in lowercase. but still, I am getting an error)
   Please take a look below screenshot

[darcywong00]

lgtm

[mcdurdin]

@dinakaranr thank you for running these tests. I have updated the user interface to clarify that lexical model IDs should match the pattern author.bcp47.uniq

The test TEST_CLONE_CLOUD was dependent on keymanapp/keyman.com#536 being merged, and that has now been merged.

Can you please re-test all given the changes that I have implemented? Thank you!

@keymanapp-test-bot retest

[rc-swag]

lgtm

[dinakaranr]

Test Results

I tested this issue with the attached "Keyman-18.0.178-alpha-test-13076" build(31/01/2025) on Windows 10. I'm sharing my observation here.

• TEST_CLONE_LOCAL (Passed):

1. Open the Keyman Developer application.
2. Open the "Clone local project" dialog by clicking the project -> New Project --> Clone local project.
3. "Source project filename": Select the keyboard *.kpj file from the Local GitHub clone directory.
4. Enter the project name in the "New project ID" text box.
5. Click the "Ok" button on the dialog.
6. Verified that the project copied and local directory. It opened in a new window.
   It works well. Thank you.

• TEST_CLONE_MODEL_LOCAL (Passed):

1. Open the Keyman_Developer application.
2. Open the "Clone local project" dialog by clicking the project -> New Project --> Clone local project.
3. "Source project filename": Select the keyboard *.kpj file from the local GitHub clone directory.(lexical-models)
4. Enter the project name in the "New project ID" text box.
5. Click the "Ok" button on the dialog.
6. Verified that the project copied and local directory. It opened in a new window.
7. It works well. Thank you.

• TEST_CLONE_CLOUD (Passed):

1. Open the Keyman_Developer application.
2. Open the "Clone project from Keyman Cloud" dialog by clicking the project -> New Project --> Clone project from Keyman Cloud.
3. "Clone project from Keyman Cloud" appeared.
4. Enter the keyboard in the search box.
5. Enter the project name in the "New project ID" text box.(in lowercase)
6. Verified that the project was downloaded and copied in the local directory. It opened in a new window.
7. It works well. Thank you.
   Note: I tried six projects. four projects succeeded and two projects failed.(Message: could not be downloaded)
   Please refer to the attached text file.
   Scenario3and5.txt

• TEST_CLONE_GITHUB (Passed):

1. Open the Keyman_Developer application.
2. Open the "Clone project from GitHub" dialog by clicking the project -> New Project --> Clone project from GitHub.
3. "GitHub URL": Paste the keyboard's GitHub URL
4. Enter the project name in the "New project ID" text box.
5. Click the "Ok" button on the dialog.
6. Verified that the project was downloaded and copied in the local directory. It opened in a new window.
   It works well. Thank you.

• TEST_CLONE_MODEL_GITHUB (Passed):

1. Open the Keyman_Developer application.
2. Open the "Clone project from GitHub" dialog by clicking the project -> New Project --> Clone project from GitHub.
3. "GitHub URL": Paste the keyboard's GitHub URL(Lexical model)
4. Enter the project name in the "New project ID" text box.
5. Click the "Ok" button on the dialog.
6. Verified that the project was downloaded and copied in the local directory. It opened in a new window.
   It works well. Thank you.
   Note: I tried six projects. four projects succeeded and two projects failed. (Message: could not be downloaded)
   Please refer to the attached text file.

[mcdurdin]

7. Note: I tried six projects. four projects succeeded and two projects failed.(Message: could not be downloaded)
Please refer to the attached text file.

These messages had the following pattern

info KM0B01B: The Keyman binary file 'keymanapp/keyboards/tree/master//release/rac/rac_marwari/build/rac_marwari.kmx' could not be downloaded: Error downloading https://raw.githubusercontent.com/keymanapp/keyboards/refs/heads/master/release/rac/rac_marwari/build/rac_marwari.kmx HTTP error 404: Not Found. This is not normally a problem

The important thing to note is 'This is not normally a problem'. Looking up the reference for the error message KM0B01B shows us:

$ kmc message b01b

INFO_CannotDownloadBinaryFileFromGitHub
* Code:      KM0B01B
* Module:    kmc-copy.CopierMessages
* Message:   The Keyman binary file '<param>' could not be downloaded: <param> <param>. This is not normally a problem
* Reference: https://kmn.sh/km0b01b

In most repositories, Keyman binary files such as .kmx, .kmp, .js are not included.
This is not normally a problem, as the files can be built from the source. Check
the provided error details for more details.