feat(developer): add kmx metadata to kmxplus compiles 🙀#7286
Merged
mcdurdin merged 1 commit intofeature-ldmlfrom Sep 18, 2022
Merged
Conversation
Fixes #7273. Adds 4 kmx system stores to allow existing configuration tools to load and process KMXPlus files without modification: * `TSS_NAME` (first `<name>`) * `TSS_COMPILEDVERSION` (only if `options.addCompilerVersion == true`) * `TSS_KEYBOARDVERSION` (from `<version number>`) * `TSS_TARGETS` (currently always 'desktop', will later include more targets) In order for `TSS_COMPILEDVERSION` to be handled correctly, needed to plumb in the new `CompilerOptions` interface. This could be a separate PR, but the changes are not huge, so opted to append the changes here. Updates related tests and fixtures. Refactored some of the e2e helpers into helpers/index.ts for use with the metadata-compiler tests.
User Test ResultsTest specification and instructions User tests are not required |
srl295
approved these changes
Sep 14, 2022
| // TSS_NAME: User friendly name of keyboard | ||
| keyboard.stores.push({ | ||
| dpName: '&NAME', | ||
| dpString: kmxplus.name?.names?.[0]?.value ?? 'unknown', // Empty name should not happen, so ok to use 'unknown' here |
Member
Author
There was a problem hiding this comment.
It probably can't happen unless we abuse metadata-compiler in our code, so I'll leave this one 😁.
| 00 10 00 00 # KMX_DWORD dwFileVersion; // 0004 Version of the file - Keyman 4.0 is 0x0400 | ||
|
|
||
| 26 d2 24 03 # KMX_DWORD dwCheckSum; // 0008 As stored in keyboard | ||
| c1 79 c0 dd # KMX_DWORD dwCheckSum; // 0008 As stored in keyboard |
Member
Author
There was a problem hiding this comment.
yes, the kmxplus compiler still generates checksums. We can remove this in another patch.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #7273.
Adds 4 kmx system stores to allow existing configuration tools to load and process KMXPlus files without modification:
TSS_NAME(first<name>)TSS_COMPILEDVERSION(only ifoptions.addCompilerVersion == true)TSS_KEYBOARDVERSION(from<version number>)TSS_TARGETS(currently always 'desktop', will later include more targets)In order for
TSS_COMPILEDVERSIONto be handled correctly, needed to plumb in the newCompilerOptionsinterface. This could be a separate PR, but the changes are not huge, so opted to append the changes here.Updates related tests and fixtures. Refactored some of the e2e helpers into helpers/index.ts for use with the metadata-compiler tests.
@keymanapp-test-bot skip