refactor(developer): .keyboard_info examples should use keys as a string 🎺 #9711
Conversation
This file contains 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
Fixes #9708. Matches the kmp.json format of keys string in the .keyboard_info schema and compiler, in order to reduce the number of formats we are working with. This same format may be used elsewhere in Keyman schemas in the future for sets of keys, for example, I hope we can use it in regression tests.
User Test ResultsTest specification and instructions User tests are not required Test Artifacts |
keymanapp-test-bot
bot
changed the title
jahorton
reviewed
Oct 10, 2023
| { "key": "E" }, | ||
| { "key": "r" } | ||
| ], | ||
| "keys": "x j m E r", | ||
| "text": "\u1781\u17D2\u1798\u17C2\u179A", |
There was a problem hiding this comment.
I opted to go with the much shorter .kps format and not have two different formats for key strings.
For #9671, I don't really have a good answer, not sure what useful test to put in for that at present. The pattern is deliberately open-ended because we don't know what the key caps will have. Only four substrings have meaning:
x j m shift+e r+: modifier joiner, e.g.shift+ralt+z, orshift+3.space: longhand for spacebar, e.g.k a space m r, andplus: + key, made available to avoid confusion with specs likeshift+plus, which would otherwise beshift++.
These are not intended to be used to generate key events -- they are supposed to be human readable keys.
ermshiperete
approved these changes
Oct 10, 2023
Base automatically changed from
feat/developer/9478-welcome-file-property
to
epic/package-metadata
October 11, 2023 00:18
mcdurdin
deleted the
refactor/developer/9708-keyboard_info-example-keys-as-string
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 #9708.
Matches the kmp.json format of keys string in the .keyboard_info schema and compiler, in order to reduce the number of formats we are working with. This same format may be used elsewhere in Keyman schemas in the future for sets of keys, for example, I hope we can use it in regression tests.
@keymanapp-test-bot skip