Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(developer): serialize KMXPlus (back) into XML 🗼 #12969

Open
wants to merge 7 commits into
base: epic/ldml-editor
Choose a base branch
from
Open

feat(developer): serialize KMXPlus (back) into XML 🗼 #12969

wants to merge 7 commits into from
+431 −17

Conversation

srl295
Copy link
Member

@srl295 srl295 commented Jan 21, 2025 •
edited
Loading

  • Note: Does not yet handle transforms (which are excluded from the e2e test).
    • transforms are handled via new fields in the KMXPlus struct such as _from, _to which override the calculated output value.
  • e2e test checks in the fixture, so identifies if the serialized content drifts
  • this is to enable editing of XML in the XML editor.

Fixes: #12874

@keymanapp-test-bot skip

@srl295 srl295 self-assigned this Jan 21, 2025
@keymanapp-test-bot
Copy link

keymanapp-test-bot bot commented Jan 21, 2025 •
edited
Loading

User Test Results

Test specification and instructions

User tests are not required

Test Artifacts

@keymanapp-test-bot keymanapp-test-bot bot added this to the A18S20 milestone Jan 21, 2025
@srl295 srl295 changed the base branch from master to epic/ldml-editor January 21, 2025 15:08
srl295 added 2 commits January 21, 2025 09:09
@srl295
Merge branch 'epic/ldml-editor' into feat/developer/12874-kmx-to-xml-…
90cc6a0 
…epic-ldml-editor
@srl295
chore(developer): update serializer 🗼
48e57d4 
- workaround transform issue by adding bypass (_) fields in the KMXPlus structs

Fixes: #12784
@srl295 srl295 marked this pull request as ready for review January 21, 2025 15:33
darcywong00
darcywong00 reviewed Jan 23, 2025
View reviewed changes
common/web/types/src/kmx/kmx-plus/kmx-plus.ts Outdated
@@ -409,6 +409,8 @@ export class TranTransform {
to: StrsItem;
mapFrom: StrsItem; // var name
mapTo: StrsItem; // var name
_from?: string; // for serialization
_to?: string; // for serialization
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will these cause any maintenance confusion with from and to?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm using the same pattern as in kmx-plus-builder where we have

  id: BUILDER_STR_REF; // str with original key id
  _id: string; // original key id, for sorting

https://github.com/keymanapp/keyman/blob/feat/developer/12874-kmx-to-xml-epic-ldml-editor/developer/src/common/web/utils/src/types/kmx/kmx-plus-builder/build-keys.ts#L23

I will add clearer documentation on the property.

jahorton
jahorton reviewed Jan 23, 2025
View reviewed changes
developer/src/kmc-ldml/src/util/serialize.ts Outdated
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I'm clear on this file and everything after it... just not so clear on the changes before and what their role is - all the new underscore-prefixed entries.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will clarify.

@srl295
chore(developer): clarify comments around serializer and KMX+ 🗼
d1c2271 
- clarify the purpose of the serializer and the serializer-required fields in KMXPlusFile
- remove an unused SetVarItems.rawItems property added in #11059

Fixes: #12784
srl295
srl295 commented Jan 23, 2025
View reviewed changes
common/web/types/src/kmx/kmx-plus/kmx-plus.ts
// element string array
items: ElementString;
// like items, but with unprocessed marker strings
rawItems: string[];
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was going to add an underscore here ( as with _from etc) but realized it was unused.

@srl295 srl295 requested a review from darcywong00 January 23, 2025 18:41
mcdurdin
mcdurdin approved these changes Jan 24, 2025
View reviewed changes
Copy link
Member

@mcdurdin mcdurdin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM as a starting point

developer/src/kmc-ldml/src/util/serialize.ts
* and are populated by the tran compiler.
*
* - TODO-LDML-EDITOR: Comments, whitespace, etc. are not preserved by this
* approach. Updates to the XML parsing will support this, see #10622.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#10622 (comment) I think the goals I outlined here cover what we need for ldml-editor?

This does mean that we need to be able to round-trip transforms with a 'release build'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jahorton jahorton jahorton left review comments

@mcdurdin mcdurdin mcdurdin approved these changes

@SabineSIL SabineSIL Awaiting requested review from SabineSIL SabineSIL is a code owner

@markcsinclair markcsinclair Awaiting requested review from markcsinclair markcsinclair is a code owner

@darcywong00 darcywong00 Awaiting requested review from darcywong00 darcywong00 is a code owner

Assignees

@srl295 srl295

Labels
common/web/ common/ developer/compilers/ developer/ epic-ldml-editor feat
Projects
Keyman
Status: No status
Milestone
A18S20
Development

Successfully merging this pull request may close these issues.

feat(developer): kmx+ to xml serialization 🗼
4 participants
@srl295 @mcdurdin @darcywong00 @jahorton