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

fix(developer): non-minimal BCP 47 tags in kps should be a hint 🎺 #9712

Merged
merged 2 commits into from
Oct 11, 2023
Merged

fix(developer): non-minimal BCP 47 tags in kps should be a hint 🎺 #9712

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
36a3a27
fix(developer): non-minimal BCP 47 tags in kps should be a hint
mcdurdin Oct 8, 2023
7544b33
fix(developer): reduce WARN_PackageShouldNotRepeatLanguages to HINT
mcdurdin Oct 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions developer/src/kmc-package/src/compiler/kmp-compiler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ export class KmpCompiler {

public transformKpsToKmpObject(kpsFilename: string): KmpJsonFile.KmpJsonFile {
const kps = this.loadKpsFile(kpsFilename);
if(!kps) {
return null;
}
return this.transformKpsFileToKmpObject(kpsFilename, kps);
}

Expand Down
8 changes: 4 additions & 4 deletions developer/src/kmc-package/src/compiler/messages.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ export class CompilerMessages {
`The package contains both lexical models and keyboards, which is not permitted.`);
static ERROR_PackageCannotContainBothModelsAndKeyboards = SevError | 0x000B;

static Warn_PackageShouldNotRepeatLanguages = (o:{resourceType: string, id: string, minimalTag: string, firstTag: string, secondTag: string}) => m(this.WARN_PackageShouldNotRepeatLanguages,
static Hint_PackageShouldNotRepeatLanguages = (o:{resourceType: string, id: string, minimalTag: string, firstTag: string, secondTag: string}) => m(this.HINT_PackageShouldNotRepeatLanguages,
`Two language tags in ${o.resourceType} ${o.id}, '${o.firstTag}' and '${o.secondTag}', reduce to the same minimal tag '${o.minimalTag}'.`);
static WARN_PackageShouldNotRepeatLanguages = SevWarn | 0x000C;
static HINT_PackageShouldNotRepeatLanguages = SevHint | 0x000C;

static Warn_PackageNameDoesNotFollowLexicalModelConventions = (o:{filename: string}) => m(this.WARN_PackageNameDoesNotFollowLexicalModelConventions,
`The package file ${o.filename} does not follow the recommended model filename conventions. The name should be all lower case, `+
Expand Down Expand Up @@ -88,9 +88,9 @@ export class CompilerMessages {
`Language tag '${o.lang}' in ${o.resourceType} ${o.id} is invalid.`);
static ERROR_LanguageTagIsNotValid = SevError | 0x0014;

static Warn_LanguageTagIsNotMinimal = (o: {resourceType: string, id:string, actual:string, expected:string}) => m(this.WARN_LanguageTagIsNotMinimal,
static Hint_LanguageTagIsNotMinimal = (o: {resourceType: string, id:string, actual:string, expected:string}) => m(this.HINT_LanguageTagIsNotMinimal,
`Language tag '${o.actual}' in ${o.resourceType} ${o.id} is not minimal, and should be '${o.expected}'.`);
static WARN_LanguageTagIsNotMinimal = SevWarn | 0x0015;
static HINT_LanguageTagIsNotMinimal = SevHint | 0x0015;

static Error_ModelMustHaveAtLeastOneLanguage = (o:{id:string}) => m(this.ERROR_ModelMustHaveAtLeastOneLanguage,
`The lexical model ${o.id} must have at least one language specified.`);
Expand Down
4 changes: 2 additions & 2 deletions developer/src/kmc-package/src/compiler/package-validation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,11 @@ export class PackageValidation {
const minimalTag = locale.minimize().toString();

if(minimalTag.toLowerCase() !== lang.id.toLowerCase()) {
this.callbacks.reportMessage(CompilerMessages.Warn_LanguageTagIsNotMinimal({resourceType, id, actual: lang.id, expected: minimalTag}));
this.callbacks.reportMessage(CompilerMessages.Hint_LanguageTagIsNotMinimal({resourceType, id, actual: lang.id, expected: minimalTag}));
}

if(minimalTags[minimalTag]) {
this.callbacks.reportMessage(CompilerMessages.Warn_PackageShouldNotRepeatLanguages({resourceType, id, minimalTag, firstTag: lang.id, secondTag: minimalTags[minimalTag]}));
this.callbacks.reportMessage(CompilerMessages.Hint_PackageShouldNotRepeatLanguages({resourceType, id, minimalTag, firstTag: lang.id, secondTag: minimalTags[minimalTag]}));
}
else {
minimalTags[minimalTag] = lang.id;
Expand Down
2 changes: 1 addition & 1 deletion ...alid/warn_language_tag_is_not_minimal.kps → ...alid/hint_language_tag_is_not_minimal.kps
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<ID>basic</ID>
<Version>1.0</Version>
<Languages>
<!-- WARN_LanguageTagIsNotMinimal -->
<!-- HINT_LanguageTagIsNotMinimal -->
<Language ID="km-Khmr-KH">Central Khmer (Khmer, Cambodia)</Language>
</Languages>
</Keyboard>
Expand Down
2 changes: 1 addition & 1 deletion ...n_package_should_not_repeat_languages.kps → ...t_package_should_not_repeat_languages.kps
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<ID>basic</ID>
<Version>1.0</Version>
<Languages>
<!-- WARN_PackageShouldNotRepeatLanguages -->
<!-- HINT_PackageShouldNotRepeatLanguages -->
<Language ID="km">Central Khmer (Khmer, Cambodia)</Language>
<Language ID="KM">Khmer</Language>
</Languages>
Expand Down
2 changes: 1 addition & 1 deletion ...age_should_not_repeat_languages.model.kps → ...age_should_not_repeat_languages.model.kps
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<ID>example.qaa.sencoten</ID>
<Languages>
<Language ID="qaa">North Straits Salish</Language>
<!-- WARN_PackageShouldNotRepeatLanguages -->
<!-- HINT_PackageShouldNotRepeatLanguages -->
<Language ID="QAA">Salish Again</Language>
<Language ID="qaa-Latn">SENĆOŦEN</Language>
</Languages>
Expand Down
20 changes: 10 additions & 10 deletions developer/src/kmc-package/test/test-messages.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,16 +95,16 @@ describe('CompilerMessages', function () {
testForMessage(this, ['invalid', 'error_package_cannot_contain_both_models_and_keyboards.kps'], CompilerMessages.ERROR_PackageCannotContainBothModelsAndKeyboards);
});

// WARN_PackageShouldNotRepeatLanguages (models)
// HINT_PackageShouldNotRepeatLanguages (models)

it('should generate WARN_PackageShouldNotRepeatLanguages if model has same language repeated', async function() {
testForMessage(this, ['invalid', 'keyman.en.warn_package_should_not_repeat_languages.model.kps'], CompilerMessages.WARN_PackageShouldNotRepeatLanguages);
it('should generate HINT_PackageShouldNotRepeatLanguages if model has same language repeated', async function() {
testForMessage(this, ['invalid', 'keyman.en.hint_package_should_not_repeat_languages.model.kps'], CompilerMessages.HINT_PackageShouldNotRepeatLanguages);
});

// WARN_PackageShouldNotRepeatLanguages (keyboards)
// HINT_PackageShouldNotRepeatLanguages (keyboards)

it('should generate WARN_PackageShouldNotRepeatLanguages if keyboard has same language repeated', async function() {
testForMessage(this, ['invalid', 'warn_package_should_not_repeat_languages.kps'], CompilerMessages.WARN_PackageShouldNotRepeatLanguages);
it('should generate HINT_PackageShouldNotRepeatLanguages if keyboard has same language repeated', async function() {
testForMessage(this, ['invalid', 'hint_package_should_not_repeat_languages.kps'], CompilerMessages.HINT_PackageShouldNotRepeatLanguages);
});

// WARN_PackageNameDoesNotFollowLexicalModelConventions
Expand Down Expand Up @@ -160,10 +160,10 @@ describe('CompilerMessages', function () {
testForMessage(this, ['invalid', 'error_language_tag_is_not_valid.kps'], CompilerMessages.ERROR_LanguageTagIsNotValid);
});

// WARN_LanguageTagIsNotMinimal
// HINT_LanguageTagIsNotMinimal

it('should generate WARN_LanguageTagIsNotMinimal if keyboard has a non-minimal language tag', async function() {
testForMessage(this, ['invalid', 'warn_language_tag_is_not_minimal.kps'], CompilerMessages.WARN_LanguageTagIsNotMinimal);
it('should generate HINT_LanguageTagIsNotMinimal if keyboard has a non-minimal language tag', async function() {
testForMessage(this, ['invalid', 'hint_language_tag_is_not_minimal.kps'], CompilerMessages.HINT_LanguageTagIsNotMinimal);
});

// ERROR_ModelMustHaveAtLeastOneLanguage
Expand Down Expand Up @@ -218,7 +218,7 @@ describe('CompilerMessages', function () {
it('should not generate HINT_JsKeyboardFileHasNoTouchTargets if keyboard has a touch target', async function() {
testForMessage(this, ['khmer_angkor', 'source', 'khmer_angkor.kps'], null);
});

// HINT_PackageContainsSourceFile

it('should generate HINT_PackageContainsSourceFile if package contains a source file', async function() {
Expand Down