Skip to content

feat(developer): kmc-convert: new conversion xkb->kmn 😎#15922

Draft
SabineSIL wants to merge 299 commits into
epic/kmc-convertfrom
feat/developer/kmc-convert-xkb-kmn
Draft

feat(developer): kmc-convert: new conversion xkb->kmn 😎#15922
SabineSIL wants to merge 299 commits into
epic/kmc-convertfrom
feat/developer/kmc-convert-xkb-kmn

Conversation

@SabineSIL
Copy link
Copy Markdown
Contributor

@SabineSIL SabineSIL commented May 7, 2026 •
edited
Loading

The next conversion (kmc-convert: xkb->kmn ):

This is to decice on a possibly new foder structure:

As a starting point we created an additional runable version of kmc-convert: keylayout ->kmn both being identical:

  • a new XkbToKmnConverter has been added and used in Converter/ConverterClassFactory
  • new src files have been created (which are exact copies from src files of the conversions keylayout ->kmn )
  • new test src files have been created (which are exact copies from test src files of the conversions keylayout ->kmn )
  • new test data files have been created (which are exact copies from test data files of the conversions keylayout ->kmn )

For kmc-convert there are 9 conversion modules but we may reuse some files:
there are:

  • 6 for reading ( e.g. keylayout-file-reader.ts, xkb-file-reader.ts,...) ,
  • 9 for converting (e.g. keylayout-to-kmn-converter.ts, xkb-to-kmn-converter.ts,...)
  • 2 for writing . (kmn-file-writer.ts ,ldml-file-writer.ts)

To prevent duplicate files and to obtain a cleaner structure of src, test-src and test-data files we might create a new folder structure which would suit all present and future conversions well.

This PR proposes:

  • creation of 3 src- subfolders read, convert and write to sort src according to function
  • creation of 3 test-src subfolders read, convert and write to sort tests according to function
  • creation of a test-data subfolder for each conversion

@keymanapp-test-bot skip

SabineSIL and others added 30 commits February 6, 2025 18:05
@SabineSIL
feat(developer): kmc-convert tidy up; split read() into read + convert()
d3db314
@SabineSIL
feat(developer): kmc-convert ambiguous/duplicate rules across C0-C3
c4d2400
@SabineSIL
feat(developer): kmc-convert more ambiguous/duplicate rules across C0-C3
099b0c0
@SabineSIL
feat(developer): kmc-convert new approach ambiguous/duplicate rules C…
fe0f4b2 
…3 OK
@SabineSIL
feat(developer): kmc-convert new approach ambiguous/duplicate rules C…
44bedec 
…0/C1 and C2 OK
@SabineSIL
feat(developer): kmc-convert tidy up
1ee0990
@SabineSIL
feat(developer): kmc-convert more tidy up
c10313e
@SabineSIL
feat(developer): kmc-convert even more tidy up
176550e
@SabineSIL
feat(developer): review createRuleData to simplify creation of C2 and…
b649e75 
… C3 rules
@SabineSIL
feat(developer): change trimValues to false to allow space to be output
f7a0ac8
@SabineSIL
feat(developer): check code according to stye guides
356dd35
@SabineSIL
feat(developer): check more code according to style guides
7e2c5b4
@SabineSIL
Merge branch 'epic/kmc-convert' into feat/developer/kmc-convert
3bc4b81
@SabineSIL
feat(developer): start function comments and tests
f3f7155
@SabineSIL
feat(developer): untrack files (kmn and keylayout)
5ba3201
@SabineSIL
feat(developer): small changes in src due to new tests
a2c592e
@SabineSIL
feat(developer): tests for kmc-convert
3bbbc91
@SabineSIL
feat(developer): more tests for kmc-convert
3bd2c5e
@SabineSIL
feat(developer): comment out first occurance+write out later occuranc…
794db98 
…e of a rule

if a rule is ambiguous i.e. if it is a C0/C1 rule and has an abiguous C2 or C3 rule we comment out the C0/C1 rule and only use the C2 or C3 rule
c WARNING  + [CAPS K_EQUAL]  > 'ì'  (C0/C1)
+ [CAPS K_EQUAL]  >  dk(A3)				  (C2 or C3)
@SabineSIL
feat(developer): add semicolon where needed; function names
454b035
@SabineSIL
feat(developer): print codepoints instead of numeric character ref. a…
169cad7 
…nd check for control characters
@SabineSIL
feat(developer): review, tidy up
cdada43
@SabineSIL
feat(developer): add test for converter
b36b0f6
@SabineSIL
Merge branch 'feat/developer/kmc-convert' of https://github.com/keyma…
6505f09 
…napp/keyman into feat/developer/kmc-convert
@SabineSIL
feat(developer): remove markers, checkIfCapsIsUsed for upper/lower/mi…
647fb0a 
…xed case case
@SabineSIL
feat(developer): split createRuleData to createRuleData and reviewRul…
40e3bec 
…eInputData | function comments
@SabineSIL
feat(developer): add several .keylayout files to git; rearrange methods
56c21bd
@SabineSIL
feat(developer): enable use without specified output file name
7315f6c
@SabineSIL
feat(developer): order of modifiers, final check prevent unwritten ru…
c9570b5 
…le in rare cases
@SabineSIL
Merge branch 'epic/kmc-convert' into feat/developer/kmc-convert
caf11a0
@SabineSIL SabineSIL requested a review from mcdurdin May 7, 2026 09:07
@SabineSIL SabineSIL self-assigned this May 7, 2026
@SabineSIL SabineSIL added developer/ common/ feat epic A long lived branch, home for a new feature, usually will have child PRs based on it labels May 7, 2026
@SabineSIL SabineSIL added this to Keyman May 7, 2026
@keymanapp-test-bot keymanapp-test-bot Bot added the user-test-missing User tests have not yet been defined for the PR label May 7, 2026
@keymanapp-test-bot
Copy link
Copy Markdown

keymanapp-test-bot Bot commented May 7, 2026 •
edited
Loading

User Test Results

Test specification and instructions

User tests are not required

Test Artifacts

  • Android
    • Keyman for Android apk - build : all tests passed (no artifacts on BuildLevel "build")
    • FirstVoices Keyboards for Android apk - build : all tests passed (no artifacts on BuildLevel "build")
    • FirstVoices Keyboards for Android apk (old PRs) - build : all tests passed (no artifacts on BuildLevel "build")
    • KeyboardHarness apk - build : all tests passed (no artifacts on BuildLevel "build")
    • Keyman for Android apk (old PRs) - build : all tests passed (no artifacts on BuildLevel "build")
    • KMSample1 apk - build : all tests passed (no artifacts on BuildLevel "build")
    • KMSample2 apk - build : all tests passed (no artifacts on BuildLevel "build")
  • iOS
    • Keyman for iOS (simulator image) - build : all tests passed (no artifacts on BuildLevel "build")
    • FirstVoices Keyboards for iOS (simulator image) - build : all tests passed (no artifacts on BuildLevel "build")
    • FirstVoices Keyboards for iOS (simulator image) (old PRs) - build : all tests passed (no artifacts on BuildLevel "build")
    • Keyman for iOS (simulator image) (old PRs) - build : all tests passed (no artifacts on BuildLevel "build")
  • macOS
    • Keyman for macOS - build : all tests passed (no artifacts on BuildLevel "build")
    • Keyman for macOS (old PRs) - build : all tests passed (no artifacts on BuildLevel "build")
  • Web
    • KeymanWeb Test Home - build : all tests passed (no artifacts on BuildLevel "build")
  • Windows
    • Keyman for Windows - build : all tests passed (no artifacts on BuildLevel "build")
    • FirstVoices Keyboards for Windows - build : all tests passed (no artifacts on BuildLevel "build")
    • FirstVoices Keyboards for Windows (old PRs) - build : all tests passed (no artifacts on BuildLevel "build")
    • Keyman for Windows (old PRs) - build : all tests passed (no artifacts on BuildLevel "build")
    • Text Editor (ARM64) - build : all tests passed (no artifacts on BuildLevel "build")
    • Text Editor (x64) - build : all tests passed (no artifacts on BuildLevel "build")
    • Text Editor (x86) - build : all tests passed (no artifacts on BuildLevel "build")

@github-project-automation github-project-automation Bot moved this to Todo in Keyman May 7, 2026
@keymanapp-test-bot keymanapp-test-bot Bot changed the title feat(developer): kmc-convert: new conversion xkb->kmn ⛄ feat(developer): kmc-convert: new conversion xkb->kmn ⛄ 😎 May 7, 2026
@keymanapp-test-bot keymanapp-test-bot Bot added this to the A19S28 milestone May 7, 2026
@SabineSIL SabineSIL changed the title feat(developer): kmc-convert: new conversion xkb->kmn ⛄ 😎 feat(developer): kmc-convert: new conversion xkb->kmn 😎 May 7, 2026
@keymanapp-test-bot keymanapp-test-bot Bot removed the user-test-missing User tests have not yet been defined for the PR label May 7, 2026
@keyman-server keyman-server modified the milestones: A19S28, A19S29 May 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mcdurdin mcdurdin Awaiting requested review from mcdurdin

At least 1 approving review is required to merge this pull request.

Assignees

@SabineSIL SabineSIL

Labels

common/web/ common/ developer/compilers/ developer/ epic A long lived branch, home for a new feature, usually will have child PRs based on it epic-kmc-convert feat resources/

Projects

Keyman
Status: Todo

Milestone

A19S29

Development

Successfully merging this pull request may close these issues.

2 participants

@SabineSIL @keyman-server