Infrastructure/astro
0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-16 21:46:22 -05:00
Code Issues Activity

fix(i18n): improve error message (#11189)

Browse source 
* fix(i18n): improve error message

* Update packages/astro/src/core/errors/errors-data.ts

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

* Update packages/astro/src/core/errors/errors-data.ts

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

---------

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
This commit is contained in:
Emanuele Stoppa 2024-06-10 11:15:06 +01:00 committed by GitHub
parent 97724da93e
commit 75a8fe7e72
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 22 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/heavy-eagles-happen.md Normal file
View file

@ -0,0 +1,5 @@
---
'astro': patch
---
Improve error message when using `getLocaleByPath` on path that doesn't contain any locales.

12
packages/astro/src/core/errors/errors-data.ts
View file

@ -1196,6 +1196,18 @@ export const i18nNotEnabled = {
hint: 'See https://docs.astro.build/en/guides/internationalization for a guide on setting up i18n.',
} satisfies ErrorData;
/**
* @docs
* @description
* An i18n utility tried to use the locale from a URL path that does not contain one. You can prevent this error by using pathHasLocale to check URLs for a `locale` first before using i18n utilities.
*
*/
export const i18nNoLocaleFoundInPath = {
name: 'i18nNoLocaleFoundInPath',
title: 'The path doesn\'t contain any locale',
message: 'You tried to use an i18n utility on a path that doesn\'t contain any locale. You can use \`pathHasLocale\` first to determine if the path has a locale.',
} satisfies ErrorData;
/**
* @docs
* @description

21
packages/astro/src/i18n/index.ts
View file

@ -8,7 +8,7 @@ import type {
} from '../@types/astro.js';
import { shouldAppendForwardSlash } from '../core/build/util.js';
import { REROUTE_DIRECTIVE_HEADER } from '../core/constants.js';
import { MissingLocale } from '../core/errors/errors-data.js';
import {i18nNoLocaleFoundInPath, MissingLocale} from '../core/errors/errors-data.js';
import { AstroError } from '../core/errors/index.js';
import { createI18nMiddleware } from './middleware.js';
import type { RoutingStrategies } from './utils.js';
@ -190,11 +190,11 @@ export function getPathByLocale(locale: string, locales: Locales): string {
}
}
}
throw new Unreachable();
throw new AstroError(i18nNoLocaleFoundInPath);
}
/**
* An utility function that retrieves the preferred locale that correspond to a path.
* A utility function that retrieves the preferred locale that correspond to a path.
*
* @param path
* @param locales
@ -205,14 +205,14 @@ export function getLocaleByPath(path: string, locales: Locales): string {
if (locale.path === path) {
// the first code is the one that user usually wants
const code = locale.codes.at(0);
if (code === undefined) throw new Unreachable();
if (code === undefined) throw new AstroError(i18nNoLocaleFoundInPath);
return code;
}
} else if (locale === path) {
return locale;
}
}
throw new Unreachable();
throw new AstroError(i18nNoLocaleFoundInPath);
}
/**
@ -271,17 +271,6 @@ function peekCodePathToUse(locales: Locales, locale: string): undefined | string
return undefined;
}
class Unreachable extends Error {
constructor() {
super(
'Astro encountered an unexpected line of code.\n' +
'In most cases, this is not your fault, but a bug in astro code.\n' +
"If there isn't one already, please create an issue.\n" +
'https://astro.build/issues'
);
}
}
export type MiddlewarePayload = {
base: string;
locales: Locales;