feat(developer): eliminate source .model_info and .keyboard_info files 🎺 #9535
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
Removes all references to source .keyboard_info and .model_info files in the kmc compiler and types. Updates the model info compiler to support building purely from model sources (isRTL, license fields are TODO).
Adds support for calculating isRTL and license fields in .model_info compiler. Also: * establishes @keymanapp/developer-utils shared module * moves license validation into @keymanapp/developer-utils * refactors kmc-model-info to a class and general cleanup
User Test ResultsTest specification and instructions User tests are not required Test Artifacts
|
github-actions
bot
added
web/
developer/
common/
developer/compilers/
common/web/
developer/ide/
and removed
epic-package-metadata
labels
keymanapp-test-bot
bot
changed the title
86 tasks
mcdurdin
commented
Sep 1, 2023
Comment on lines
+69
to
+71
| if(activity.sourceExtension == KeymanFileTypes.Source.Project) { | ||
| return await this.buildTarget(this.project.projectFile, activity); | ||
| } |
There was a problem hiding this comment.
.keyboard_info and .model_info are built from the project
Works around npm/cli#3466 when bundling internal dependencies using the bundleDependencies package.json property. This change works in tandem with the npm pack/publish process -- when we run `developer/src/kmc/build.sh publish` (or `pack`), we end up with `npm version` stomping on all our package.json files, so the repo is dirty after this. We need a copy of the top-level package.json before this stomping happens, in order to get a simple map of the location of each of our internal dependencies, from the `dependencies` property (it would be possible to figure this out with a lot more parsing of our package.json files, but this is simpler). This means, in future, we should avoid publishing our internal dependencies such as those under common/ to npm, as they serve no practical purpose there.
darcywong00
reviewed
Sep 11, 2023
darcywong00
reviewed
Sep 11, 2023
darcywong00
reviewed
Sep 11, 2023
| <Filepath>dmg.dv.test.model_info</Filepath> | ||
| <FileVersion></FileVersion> | ||
| <FileType>.model_info</FileType> | ||
| </File> |
There was a problem hiding this comment.
Should we also clean up .keyboard_info files in other web test folders?
web/src/test/manual/web/issue917-context-and-notany/test_917/test_917.keyboard_info
web/src/test/manual/web/issue2924/source/testvariable/testvariable.keyboard_info
web/src/test/manual/web/issue3701/test3701/test3701.keyboard_info
darcywong00
reviewed
Sep 11, 2023
| model_info.packageIncludes = sources.kmpJsonData.files.filter((e) => !!e.name.match(/.[ot]tf$/i)).length ? ['fonts'] : []; | ||
| model_info.version = sources.kmpJsonData.info.version.description; | ||
| model_info.minKeymanVersion = minKeymanVersion; | ||
| model_info.helpLink = HelpRoot + model_info.id; |
There was a problem hiding this comment.
Are we going to be publishing lexical-model help? I didn't see HelpRoot in the help.keyman.com repo
https://help.keyman.com/model
There was a problem hiding this comment.
This leaves the option open for the future, but no current plans 😁
Co-authored-by: Darcy Wong <[email protected]>
jahorton
approved these changes
Sep 26, 2023
Base automatically changed from
feat/developer/use-last-commit-date-for-keyboard_info
to
epic/package-metadata
September 28, 2023 08:54
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.
Removes all references to source .keyboard_info and .model_info files in the kmc compiler and types. Updates the model info compiler to support building purely from model sources.
Adds support for calculating
isRTLandlicensefields in .model_info compiler.Also:
@keymanapp-test-bot skip