Merge pull request #3351 from opral/parjs-317-rename-locales-to-avail…

…ablelocales rename `runtime.locales` to `runtime.availableLocales` to align with v1 API and avoid ambiguity
opral · Jan 15, 2025 · a9b6c65 · a9b6c65
2 parents 1215afb + 0426fbc
commit a9b6c65
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 18 deletions.
diff --git a/inlang/packages/paraglide-js/CHANGELOG.md b/inlang/packages/paraglide-js/CHANGELOG.md
@@ -1,5 +1,9 @@
 # @inlang/paraglide-js
 
+## 2.0.0-beta.8
+
+- rename `runtime.locales` to `runtime.availableLocales` to align with v1 API and avoid ambiguity https://github.com/opral/inlang-paraglide-js/issues/314
+
 ## 2.0.0-beta.7
 
 - fixed windows path problems

diff --git a/inlang/packages/paraglide-js/package.json b/inlang/packages/paraglide-js/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "@inlang/paraglide-js",
 	"type": "module",
-	"version": "2.0.0-beta.7",
+	"version": "2.0.0-beta.8",
 	"license": "MIT",
 	"publishConfig": {
 		"access": "public",

diff --git a/inlang/packages/paraglide-js/src/compiler/compileProject.test.ts b/inlang/packages/paraglide-js/src/compiler/compileProject.test.ts
@@ -172,7 +172,7 @@ describe.each([
 			test("locales should include locales with a hyphen", async () => {
 				const { runtime } = await importCode(code);
 
-				expect(runtime.locales).toContain("en-US");
+				expect(runtime.availableLocales).toContain("en-US");
 			});
 
 			test("should set the baseLocale as default getLocale value", async () => {
@@ -419,7 +419,7 @@ describe.each([
     runtime.getLocale() satisfies "de" | "en" | "en-US"
 
     // availableLocales should have a narrow type, not a generic string
-    runtime.locales satisfies Readonly<Array<"de" | "en" | "en-US">>
+    runtime.availableLocales satisfies Readonly<Array<"de" | "en" | "en-US">>
 
     // setLocale() should fail if the given language tag is not included in availableLocales
     // @ts-expect-error - invalid locale

diff --git a/inlang/packages/paraglide-js/src/compiler/runtime.ts b/inlang/packages/paraglide-js/src/compiler/runtime.ts
@@ -29,14 +29,14 @@ const jsdocRuntime = (
 export const baseLocale = "${settings.baseLocale}";
 
 /**
- * The project's locales.
+ * The project's locales that have been specified in the settings.
  *
  * @example
- *   if (locales.includes(userSelectedLocale) === false) {
+ *   if (availableLocales.includes(userSelectedLocale) === false) {
  *     throw new Error('Locale is not available');
  *   }
  */
-export const locales = /** @type {const} */ (${JSON.stringify(settings.locales)});
+export const availableLocales = /** @type {const} */ (${JSON.stringify(settings.locales)});
 
 /**
  * This is a default implementation that is almost always
@@ -130,7 +130,7 @@ export let setLocale =
  * @returns {locale is AvailableLocale}
  */
 export function isAvailableLocale(locale) {
-	return locales.includes(locale);
+	return availableLocales.includes(locale);
 }
 
 // ------ TYPES ------
@@ -141,16 +141,16 @@ export function isAvailableLocale(locale) {
  * @example
  *   setLocale(request.locale as AvailableLocale)
  *
- * @typedef {(typeof locales)[number]} AvailableLocale
+ * @typedef {(typeof availableLocales)[number]} AvailableLocale
  */
 
 // ------ LEGACY RUNTIME (will be removed in the next major version) ------
 
 /** @deprecated Use \`baseLocale\` instead */
 export const sourceLanguageTag = baseLocale;
 
-/** @deprecated Use \`locales\` instead */
-export const availableLanguageTags = locales;
+/** @deprecated Use \`availableLocales\` instead */
+export const availableLanguageTags = availableLocales;
 
 /** @deprecated Use \`getLocale()\` instead */
 export let languageTag = getLocale;
@@ -166,7 +166,7 @@ export const isAvailableLanguageTag = isAvailableLocale;
 
 /**
  * @deprecated Use \`AvailableLocale\` instead
- * @typedef {(typeof locales)[number]} AvailableLanguageTag
+ * @typedef {(typeof availableLocales)[number]} AvailableLanguageTag
  */
 `;
 
@@ -186,14 +186,14 @@ const tsRuntime = (
 export const baseLocale = "${settings.baseLocale}";
 
 /**
- * The project's locales.
+ * The project's locales that have been specified in the settings.
  *
  * @example
- *   if (locales.includes(userSelectedLocale) === false) {
+ *   if (availableLocales.includes(userSelectedLocale) === false) {
  *     throw new Error('Locale is not available');
  *   }
  */
-export const locales = ${JSON.stringify(settings.locales)} as const;
+export const availableLocales = ${JSON.stringify(settings.locales)} as const;
 
 /**
  * This is a default implementation that is almost always
@@ -276,7 +276,7 @@ export let setLocale: (newLocale: AvailableLocale) => void = (newLocale) => {
  *   }
  */
 export function isAvailableLocale(locale: any): locale is AvailableLocale {
-	return locales.includes(locale);
+	return availableLocales.includes(locale);
 }
 
 // ------ TYPES ------
@@ -288,15 +288,15 @@ export function isAvailableLocale(locale: any): locale is AvailableLocale {
  *   setLocale(request.locale as AvailableLocale)
  *
  */
-export type AvailableLocale = (typeof locales)[number];
+export type AvailableLocale = (typeof availableLocales)[number];
 
 // ------ LEGACY RUNTIME (will be removed in the next major version) ------
 
 /** @deprecated Use \`baseLocale\` instead */
 export const sourceLanguageTag = baseLocale;
 
-/** @deprecated Use \`locales\` instead */
-export const availableLanguageTags = locales;
+/** @deprecated Use \`availableLocales\` instead */
+export const availableLanguageTags = availableLocales;
 
 /** @deprecated Use \`getLocale()\` instead */
 export let languageTag = getLocale;