Skip to content

chore: Remove any from i18n's internal types #2201

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

Merged
aklinker1 merged 2 commits into from
Mar 19, 2026
+25 −7
Merged

chore: Remove any from i18n's internal types #2201

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e98cd1a
chore: Remove `any` from `i18n`'s internal types
aklinker1 Mar 18, 2026
a820f66
Cleanup
aklinker1 Mar 18, 2026
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
32 changes: 25 additions & 7 deletions packages/i18n/src/build.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,25 @@ export { SUPPORTED_LOCALES } from './supported-locales';
// TYPES
//

export type SimpleMessage = string;

export type PluralMessage = Record<'n' | number, string>;

export interface ChromeMessage {
message: string;
description?: string;
placeholders?: Record<string, { content: string; example?: string }>;
}

export type Message =
| SimpleMessage
| PluralMessage
| ChromeMessage
| Message[]
| { [key: string]: Message };

export type MessagesObject = Record<string, Message>;
Copy link
Member Author

@aklinker1 aklinker1 Mar 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Created a separate type for the messages file contents, referred to as MessagesObject further down (see existing parseMessagesObject function). Couldn't think of a better name for this.


export interface ParsedBaseMessage {
key: string[];
substitutions: number;
Expand Down Expand Up @@ -95,7 +108,7 @@ const EXT_FORMATS_MAP: Record<string, MessageFormat> = {
'.toml': 'TOML',
};

const PARSERS: Record<MessageFormat, (text: string) => any> = {
const PARSERS: Record<MessageFormat, (text: string) => MessagesObject> = {
YAML: parseYAML,
JSON5: parseJSON5,
TOML: parseTOML,
Expand All @@ -117,6 +130,7 @@ export async function parseMessagesFile(
): Promise<ParsedMessage[]> {
const text = await readFile(file, 'utf8');
const ext = extname(file).toLowerCase();

return parseMessagesText(text, EXT_FORMATS_MAP[ext] ?? 'JSON5');
}

Expand All @@ -129,7 +143,7 @@ export function parseMessagesText(
}

/** Given the JS object form of a raw messages file, extract the messages. */
export function parseMessagesObject(object: any): ParsedMessage[] {
export function parseMessagesObject(object: MessagesObject): ParsedMessage[] {
return _parseMessagesObject(
[],
{
Expand All @@ -142,7 +156,7 @@ export function parseMessagesObject(object: any): ParsedMessage[] {

function _parseMessagesObject(
path: string[],
object: any,
object: Message,
depth: number,
): ParsedMessage[] {
switch (typeof object) {
Expand All @@ -163,15 +177,17 @@ function _parseMessagesObject(
];
}
case 'object':
if ([null, undefined].includes(object)) {
if (object == null) {
throw new Error(
`Messages file should not contain \`${object}\` (found at "${path.join('.')}")`,
);
}

if (Array.isArray(object))
return object.flatMap((item, i) =>
_parseMessagesObject(path.concat(String(i)), item, depth + 1),
);

if (isPluralMessage(object)) {
const message = Object.values(object).join('|');
const substitutions = getSubstitutionCount(message);
Expand All @@ -184,6 +200,7 @@ function _parseMessagesObject(
},
];
}

if (depth === 1 && isChromeMessage(object)) {
const message = applyChromeMessagePlaceholders(object);
const substitutions = getSubstitutionCount(message);
Expand All @@ -196,6 +213,7 @@ function _parseMessagesObject(
},
];
}

return Object.entries(object).flatMap(([key, value]) =>
_parseMessagesObject(path.concat(key), value, depth + 1),
);
Expand All @@ -204,13 +222,13 @@ function _parseMessagesObject(
}
}

function isPluralMessage(object: any): object is Record<number | 'n', string> {
function isPluralMessage(object: Message): object is PluralMessage {
return Object.keys(object).every(
(key) => key === 'n' || isFinite(Number(key)),
);
}

function isChromeMessage(object: any): object is ChromeMessage {
function isChromeMessage(object: Message): object is ChromeMessage {
return Object.keys(object).every((key) =>
ALLOWED_CHROME_MESSAGE_KEYS.has(key),
);
Expand All @@ -222,7 +240,7 @@ function isChromeMessage(object: any): object is ChromeMessage {

export function generateTypeText(messages: ParsedMessage[]): string {
const renderMessageEntry = (message: ParsedMessage): string => {
// Use . for deep keys at runtime and types
// Use '.' for deep keys at runtime and types
const key = message.key.join('.');

const features = [
Expand Down
Loading