erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-09-21 23:27:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

fix(developer): enforce presence of kps Info.Description field in info compilers

Browse source 
The Description field should be required for published keyboards and
models, so this change means kmc-keyboard-info and kmc-model-info will
report an error if it is missing.

Relates-to: keymanapp/keyboards#3037
Relates-to: keymanapp/lexical-models#262
Fixes: #12202
This commit is contained in:
Marc Durdin 2024-08-16 08:04:18 +02:00
parent 8b2d157a4e
commit 2f75bb24db
4 changed files with 19 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
developer/src/kmc-keyboard-info/src/keyboard-info-compiler-messages.ts
View file

@ -52,8 +52,14 @@ export class KeyboardInfoCompilerMessages {
static Error_FontFileCannotBeRead = (o:{filename: string}) => m(this.ERROR_FontFileCannotBeRead,
`Font ${def(o.filename)} could not be parsed to extract a font family.`);
static ERROR_FontFileMetaDataIsInvalid = SevError | 0x000F;
static Error_FontFileMetaDataIsInvalid = (o:{filename: string,message:string}) => m(this.ERROR_FontFileMetaDataIsInvalid,
static ERROR_FontFileMetaDataIsInvalid = SevError | 0x000F;
static Error_FontFileMetaDataIsInvalid = (o:{filename: string,message:string}) => m(
this.ERROR_FontFileMetaDataIsInvalid,
`Font ${def(o.filename)} meta data invalid: ${def(o.message)}.`);
static ERROR_DescriptionIsMissing = SevError | 0x0010;
static Error_DescriptionIsMissing = (o:{filename:string}) => m(
this.ERROR_DescriptionIsMissing,
`The Info.Description field in the package ${def(o.filename)} is required, but is missing or empty.`);
}

3
developer/src/kmc-keyboard-info/src/keyboard-info-compiler.ts
View file

@ -246,6 +246,9 @@ export class KeyboardInfoCompiler implements KeymanCompiler {
if(kmpJsonData.info.description?.description) {
keyboard_info.description = kmpJsonData.info.description.description.trim();
} else {
this.callbacks.reportMessage(KeyboardInfoCompilerMessages.Error_DescriptionIsMissing({filename:sources.kpsFilename}));
return null;
}
// extract the language identifiers from the language metadata arrays for

5
developer/src/kmc-model-info/src/model-info-compiler-messages.ts
View file

@ -44,5 +44,10 @@ export class ModelInfoCompilerMessages {
static ERROR_NoLicenseFound = SevError | 0x0009;
static Error_NoLicenseFound = () => m(this.ERROR_NoLicenseFound,
`No license for the model was found. MIT license is required for publication to Keyman lexical-models repository.`);
static ERROR_DescriptionIsMissing = SevError | 0x000A;
static Error_DescriptionIsMissing = (o:{filename:string}) => m(
this.ERROR_DescriptionIsMissing,
`The Info.Description field in the package ${def(o.filename)} is required, but is missing or empty.`);
}

3
developer/src/kmc-model-info/src/model-info-compiler.ts
View file

@ -199,6 +199,9 @@ export class ModelInfoCompiler implements KeymanCompiler {
if(sources.kmpJsonData.info.description?.description) {
model_info.description = sources.kmpJsonData.info.description.description.trim();
} else {
this.callbacks.reportMessage(ModelInfoCompilerMessages.Error_DescriptionIsMissing({filename:sources.kpsFilename}));
return null;
}
// isRTL -- this is a little bit of a heuristic from a compiled .js