feat(developer): KeymanWeb Typescript Compiler 🗜

[mcdurdin]

TODO

Future build infrastructure:

• # TODO: remove c8 exclusion of coverage of kmw-compiler folder

various files:

• chore(developer): Improve error handling in KmxFileReader 🗜 #8956
• Sort out discrepancy between color and style in VisualKeyboardFont --> chore(developer): remove font style/color from kvk 🗜 #9054
• chore(developer): Remove kmc-kmw/src/compiler/callbacks.ts (use common-types version) 🗜 #8957
• chore(developer): Remove kmc-kmw/src/compiler/compiler-options.ts (there is a shared intf somewhere) 🗜 #8958
• Lifecycle for global variables, put them all in one place at least, to start with (refactor(developer): move constants and globals for kmw compiler 🗜 #9046)
• Invert kmc-kmn and kmc-kmw dependency -- make kmc-kmn dependent on kmc-kmw rather than vice-versa --> refactor(developer): kmc-kmn now builds .js when needed 🗜 #9038

Future common/web/types work:

• Review consistency of various common/web/types readers and writers (group task would be good?)

javascript-strings.ts:

• Move constant declarations such as VKeyNames into separate units (in a consts folder?) (refactor(developer): move constants and globals for kmw compiler 🗜 #9046)
• kmx compiler needs to support build-to-memory-buffer
• // TODO: lifecycle (refactor(developer): move constants and globals for kmw compiler 🗜 #9046)
• Get readonly groups and store metadata from kmx compiler when building for .js --> fix(developer): support readonly groups in kmc-kmn/kmw-compiler 🗜 #9076
• // TODO: export group + store metadata in debug store, use that --> fix(developer): support readonly groups in kmc-kmn/kmw-compiler 🗜 #9076
• Remove various commented code sections (mostly Delphi variable declarations) --> chore(developer): cleanup javascript-strings.ts 🗜 #9086
• // TODO: problems with supp chars --> chore(developer): cleanup javascript-strings.ts 🗜 #9086
• // TODO: move elsewhere

Following TODO items are from the Delphi code:

• // TODO: Refactor the section below into JavaScript_String, as it's
• // TODO: this doesn't resolve the issue of, e.g. SHIFT+K_SPACE
• // TODO: context character level switches instead of full context comparisons

validate-layout-file.ts:

• variable lifecycle (refactor(developer): move constants and globals for kmw compiler 🗜 #9046)
• // TODO lifecycle (refactor(developer): move constants and globals for kmw compiler 🗜 #9046)
• error reporting --> chore(developer): handle layout file errors in kmw-compiler #9087
• // TODO: callbacks.reportMessage() ReportError(0, CWARN_TouchLayoutMissingLayer, 'Key "'+FId+'" on platform "'+FPlatform.Name+'", layer "'+FLayer.Id+'", platform "'+FPlatform.Name+'", references a missing layer "'+FNextLayer+'".'); --> chore(developer): handle layout file errors in kmw-compiler #9087
• // TODO: ReportError(0, CWARN_TouchLayoutUnidentifiedKey, 'A key on layer "'+FLayer.Id+'" has no identifier.'); --> chore(developer): handle layout file errors in kmw-compiler #9087
• // TODO: ReportError(0, CERR_TouchLayoutInvalidIdentifier, 'Key "'+FId+'" on "'+FPlatform.Name+'", layer "'+FLayer.Id+'" has an invalid identifier.'); --> chore(developer): handle layout file errors in kmw-compiler #9087
• // TODO: ReportError(0, CERR_TouchLayoutInvalidIdentifier, 'Key "'+FId+'" on "'+FPlatform.Name+'", layer "'+FLayer.Id+'" has a multi-part identifier which requires version 15.0 or newer.'); --> chore(developer): handle layout file errors in kmw-compiler #9087
• // TODO: ReportError(0, CWARN_TouchLayoutCustomKeyNotDefined, 'Key "'+FId+'" on layer "'+FLayer.Id+'", platform "'+FPlatform.Name+'", is a custom key but has no corresponding rule in the source.'); --> chore(developer): handle layout file errors in kmw-compiler #9087
• // TODO: ReportError(0, CWARN_TouchLayoutSpecialLabelOnNormalKey, --> chore(developer): handle layout file errors in kmw-compiler #9087
• // TODO: ReportError(fkp.Line, CERR_InvalidKeyCode, 'Invalid key identifier "'+FDictionary[i]+'"'); --> chore(developer): handle layout file errors in kmw-compiler #9087
• // TODO: ReportError(0, CERR_InvalidTouchLayoutFile, sMsg); --> chore(developer): handle layout file errors in kmw-compiler #9087
• // TODO: ReportError(0, CWARN_TouchLayoutFontShouldBeSameForAllPlatforms, 'The touch layout font should be the same for all platforms.'); --> chore(developer): handle layout file errors in kmw-compiler #9087
• // TODO: ReportError(0, CWARN_TouchLayoutMissingRequiredKeys, 'Layer "'+FLayer.Id+'" on platform "'+FPlatform.Name+'" is missing the required key(s) '+RequiredKeysToString(CRequiredKeys-FRequiredKeys)+'.'); --> chore(developer): handle layout file errors in kmw-compiler #9087

Future lowpri TODO items:

• // TODO: O(eeek) performance here
• // TODO: why support multiple font values if it has to be the same across all platforms?!

visual-keyboard-compiler.ts:

• support bold, italic --> chore(developer): remove font style/color from kvk 🗜 #9054
• // TODO 'bold ' if visualKeyboard.header.unicodeFont.style --> chore(developer): remove font style/color from kvk 🗜 #9054
• // TODO 'italic ' if visualKeyboard.header.unicodeFont.style --> chore(developer): remove font style/color from kvk 🗜 #9054
• refactor displayUnderlying flag (it's also misspelled) --> chore(developer): cleanup displayUnderlying flag in kmw compiler 🗜 #9056
• // TODO: this can go in caller, later --> chore(developer): cleanup displayUnderlying flag in kmw compiler 🗜 #9056

visual-keyboard.ts:

• // TODO: figure out style vs color issues --> chore(developer): remove font style/color from kvk 🗜 #9054

kmw-compiler.ts:

• Keyboard_name needs to be cleaned (done earlier)
• sHelpFile is never populated --> chore(developer): support embedded files in kmw compiler 🗜 #9058
• sEmbedJS is never populated --> chore(developer): support embedded files in kmw compiler 🗜 #9058
• sEmbedCSS is never populated --> chore(developer): support embedded files in kmw compiler 🗜 #9058
• const sName = 'Keyboard_'+name; //TODO: verify --> GetKeymanWebCompiledNameFromFileName(FInFile); (done earlier)
• //TODO: load sHelpFile from file --> chore(developer): support embedded files in kmw compiler 🗜 #9058
• //TODO: load sEmbedJS from file --> chore(developer): support embedded files in kmw compiler 🗜 #9058
• //TODO: load sEmbedCSS from file --> chore(developer): support embedded files in kmw compiler 🗜 #9058
• // TODO: error --> chore(developer): cleanup displayUnderlying flag in kmw compiler 🗜 #9056
• // TODO: reusing the same variable here is ugly --> chore(developer): support embedded files in kmw compiler 🗜 #9058
• // TODO: stop reusing sVisualKeyboard for both filename and content --> chore(developer): cleanup displayUnderlying flag in kmw compiler 🗜 #9056
• Fixup isOptionStore (see also 'get readonly groups' task) --> fix(developer): support option stores in kmc-kmn/kmw 🗜 #9075
• // TODO: how do we determine this, see CheckStoreUsage() --> fix(developer): support option stores in kmc-kmn/kmw 🗜 #9075
• rename it from write-compiled-keyboard.ts to kmw-compiler.ts --> chore(developer): cleanup for kmw-compiler.ts 🗜 #9088
• IMX support (FCallFunctions) --> chore(developer): cleanup for kmw-compiler.ts 🗜 #9088
• Complete HasSupplementaryPlaneChars --> chore(developer): cleanup for kmw-compiler.ts 🗜 #9088
• // TODO: log errors
• /* TODO
• return false; // TODO
• Error reporting
• VKDictionary
• reader.validate(source, callbacks.loadSchema("kvks")); // TODO: handle exceptions

Future lowpri TODO items:

• //TODO: We need to think about mnemonic layouts which are incompletely supported at present
• ladderlength const could be an option?
• export let FFix183_LadderLength: number = 100; // TODO: option
• // TODO: use a JSON encode
• // TODO(lowpri): rename error constant to Warn_EmbedFileMissing
• // TODO: add FTabStop to line above, once we have 100% identical match ...

messages.ts:

• chore(developer): Fixup error message codes in kmc-kmw/messages.ts to use KmnCompilerMessages 🗜 #8986
• // TODO: these Codes Are All Wrong But We'll Fix It Soon --> see above

Future lowpri TODO items:

• Extend KmwCompilerMessages to report filename and line number more reliably

test/test-compiler-manual.ts:

• // TODO: runToMemory, add option to kmxCompiler to store debug-data for conversion to .js (e.g. store metadata, group readonly metadata, etc)

test/test-compiler.ts:

• // TODO: runToMemory, add option to kmxCompiler to store debug-data for conversion to .js (e.g. store metadata, group readonly metadata, visual keyboard source filename, etc)

[mcdurdin]

Wrong issue number in 57af86e...

[mcdurdin]

These issues are all completed in PRs (or are long-term future items which don't currently require tracking). Going ahead and closing this.

Continuing work will be tracked in #9090.