i18n: use automatic type inference of translation keys

Finally figured out a way to make typescript strongly type translation
keys so we can avoid the tedium of creating enums of translation keys.
This commit is contained in:
David Lechner
2022-07-22 13:48:50 -05:00
parent 3e10096b6e
commit d6df128860
80 changed files with 402 additions and 875 deletions
@@ -6,7 +6,7 @@ import type { AriaButtonProps } from '@react-types/button';
import React, { useCallback, useRef } from 'react';
import { useButton } from 'react-aria';
import { FileNameValidationResult } from '../../pybricksMicropython/lib';
import { I18nId, useI18n } from './i18n';
import { useI18n } from './i18n';
/**
* Trims trailing and leading whitespace and replaces additional whitespace
@@ -51,7 +51,7 @@ const FixItButton: React.VoidFunctionComponent<FixItButtonProps> = (props) => {
ref,
);
return <a {...buttonProps}>{i18n.translate(I18nId.HelpTextFixIt)}</a>;
return <a {...buttonProps}>{i18n.translate('helpText.fixIt')}</a>;
};
type FileNameHelpTextProps = {
@@ -87,27 +87,27 @@ const FileNameHelpText: React.VoidFunctionComponent<FileNameHelpTextProps> = ({
switch (validation) {
case FileNameValidationResult.IsOk:
return <>{i18n.translate(I18nId.HelpTextIsOk)}</>;
return <>{i18n.translate('helpText.isOk')}</>;
case FileNameValidationResult.IsEmpty:
return <>{i18n.translate(I18nId.HelpTextIsEmpty)}</>;
return <>{i18n.translate('helpText.isEmpty')}</>;
case FileNameValidationResult.HasSpaces:
return (
<>
{i18n.translate(I18nId.HelpTextHasSpaces)}{' '}
{i18n.translate('helpText.hasSpaces')}{' '}
<FixItButton onPress={handleHasSpaces} />
</>
);
case FileNameValidationResult.HasFileExtension:
return (
<>
{i18n.translate(I18nId.HelpTextHasFileExtension)}{' '}
{i18n.translate('helpText.hasFileExtension')}{' '}
<FixItButton onPress={handleHasFileExtension} />
</>
);
case FileNameValidationResult.HasInvalidFirstCharacter:
return (
<>
{i18n.translate(I18nId.HelpTextHasInvalidFirstCharacter, {
{i18n.translate('helpText.hasInvalidFirstCharacter', {
letters: <code className={Classes.CODE}>az</code>,
underscore: <code className={Classes.CODE}>_</code>,
})}
@@ -116,7 +116,7 @@ const FileNameHelpText: React.VoidFunctionComponent<FileNameHelpTextProps> = ({
case FileNameValidationResult.HasInvalidCharacters:
return (
<>
{i18n.translate(I18nId.HelpTextHasInvalidCharacters, {
{i18n.translate('helpText.hasInvalidCharacters', {
letters: <code className={Classes.CODE}>az</code>,
numbers: <code className={Classes.CODE}>09</code>,
dash: <code className={Classes.CODE}>-</code>,
@@ -126,7 +126,7 @@ const FileNameHelpText: React.VoidFunctionComponent<FileNameHelpTextProps> = ({
</>
);
case FileNameValidationResult.AlreadyExists:
return <>{i18n.translate(I18nId.HelpTextAlreadyExists)}</>;
return <>{i18n.translate('helpText.alreadyExists')}</>;
}
};
@@ -162,7 +162,7 @@ const FileNameFormGroup: React.VoidFunctionComponent<FileNameFormGroupProps> = (
return (
<FormGroup
label={i18n.translate(I18nId.Label)}
label={i18n.translate('label')}
intent={fileNameIntent}
subLabel={
<FileNameHelpText
@@ -1,12 +0,0 @@
// SPDX-License-Identifier: MIT
// Copyright (c) 2022 The Pybricks Authors
import { lookup } from '../../../test';
import { I18nId } from './i18n';
import en from './translations/en.json';
describe('Ensure .json file has matches for I18nId', () => {
test.each(Object.values(I18nId))('%s', (id) => {
expect(lookup(en, id)).toBeDefined();
});
});
+4 -14
View File
@@ -1,22 +1,12 @@
// SPDX-License-Identifier: MIT
// Copyright (c) 2022 The Pybricks Authors
import { I18n, useI18n as useShopifyI18n } from '@shopify/react-i18n';
import { useI18n as useShopifyI18n } from '@shopify/react-i18n';
import type { TypedI18n } from '../../i18n';
import type translations from './translations/en.json';
export function useI18n(): I18n {
export function useI18n(): TypedI18n<typeof translations> {
// istanbul ignore next: babel-loader rewrites this line
const [i18n] = useShopifyI18n();
return i18n;
}
export enum I18nId {
Label = 'label',
HelpTextIsOk = 'helpText.isOk',
HelpTextIsEmpty = 'helpText.isEmpty',
HelpTextHasSpaces = 'helpText.hasSpaces',
HelpTextHasFileExtension = 'helpText.hasFileExtension',
HelpTextHasInvalidFirstCharacter = 'helpText.hasInvalidFirstCharacter',
HelpTextHasInvalidCharacters = 'helpText.hasInvalidCharacters',
HelpTextAlreadyExists = 'helpText.alreadyExists',
HelpTextFixIt = 'helpText.fixIt',
}