Skip to content

formatted useLocalesMap error and added additional checks #450

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

formatted useLocalesMap error and added additional checks #450

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
67 changes: 54 additions & 13 deletions components/use-locales-map.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,37 +5,64 @@ import { useRouter } from "next/router";
* @typedef {DefaultLocale | "zh-CN" | "es-ES" | "pt-BR" | "ja" | "ko" | "ru"} Locale
* @typedef {{locale?: Locale | undefined; locales?: Locale[] | undefined; defaultLocale?: DefaultLocale | undefined}} TypedRouter
* @typedef {Omit<import('next/router').NextRouter, "locale" | "locales" | "defaultLocale"> & TypedRouter} NextRouter
*/

/**
* @template T
* @type {(localesMap: Record<Locale, T>) => T}
*/
export default function useLocalesMap(localesMap) {
/** @type {NextRouter} */
const router = useRouter();
const { locale, defaultLocale } = router;
const { locale, locales, defaultLocale } = router;

if (!localesMap) {
throw new Error("Pass a locales map as argument to useLocalesMap");
throw new Error("Pass a locales map as argument to useLocalesMap hook.");
}

if (!isObject(localesMap)) {
throw new Error("Locales map must be an object");
if (typeof localesMap !== "object") {
localesMapError(
localesMap,
`Locales map must be an object, but you passed ${typeof localesMap}.`
);
}

if (Array.isArray(localesMap)) {
localesMapError(
localesMap,
"Locales map must be an object, but you passed an array."
);
}

if (!localesMap.hasOwnProperty(defaultLocale)) {
throw new Error(
localesMapError(
localesMap,
`Locales map must contain default locale "${defaultLocale}"`
);
}

if (
localesMap.hasOwnProperty(locale) &&
typeof localesMap[locale] !== typeof localesMap[defaultLocale]
) {
throw new Error(
`Invalid locales map: Shape of "${locale}" must be the same as "${defaultLocale}"`
);
for (const key in localesMap) {
if (!locales.includes(key)) {
const list = locales.map((l) => `"${l}"`).join(", ");

localesMapError(
localesMap,
`"${key}" is not a valid locale.`,
`Available locales are defined in "next.config.js": ${list}.`
);
}

if (typeof localesMap[key] !== typeof localesMap[defaultLocale]) {
localesMapError(
localesMap,
`Shape of "${key}" must be the same as "${defaultLocale}"`
);
}
}

if (["string", "number", "symbol"].includes(typeof localesMap[defaultLocale])) {
if (
["string", "number", "symbol"].includes(typeof localesMap[defaultLocale])
) {
return localesMap[locale] || localesMap[defaultLocale];
}

Expand Down Expand Up @@ -76,3 +103,17 @@ function mergeDeep(target, ...sources) {

return mergeDeep(target, ...sources);
}

/**
* Throw an error with a formatted message.
* @template T
* @param {Record<Locale, T>} localesMap
* @param {string[]} args
*/
export function localesMapError(localesMap, ...args) {
throw new Error(
["Invalid locales map", JSON.stringify(localesMap, null, 2), ...args].join(
"\n"
)
);
}