@intlayer/docs 5.5.8

package/ja/packages/intlayer/getConfiguration.md

@@ -0,0 +1,120 @@
+# ドキュメント: `getConfiguration` 関数 in `intlayer`
+
+## 説明
+
+`getConfiguration` 関数は、環境変数を抽出することによって `intlayer` アプリケーションの全体の設定を取得します。この関数は、クライアント側とサーバー側の両方で同じ設定を使用する柔軟性を提供し、アプリケーション全体で一貫性を確保します。
+
+---
+
+## パラメータ
+
+この関数はパラメータを受け取りません。その代わりに、環境変数を使用して設定を行います。
+
+### 戻り値
+
+- **型**: `IntlayerConfig`
+- **説明**: `intlayer` の完全な設定を含むオブジェクト。この設定には以下のセクションが含まれます:
+
+  - `internationalization`: ロケールおよびストリクトモードに関連する設定。
+  - `middleware`: URLおよびクッキー管理に関連する設定。
+  - `content`: コンテンツファイル、ディレクトリ、およびパターンに関連する設定。
+  - `editor`: エディター固有の設定。
+
+詳細については、[Intlayer 設定ドキュメント](https://github.com/aymericzip/intlayer/blob/main/docs/ja/configuration.md) を参照してください。
+
+---
+
+## 使用例
+
+### 完全な設定を取得する
+
+```typescript codeFormat="typescript"
+import { getConfiguration } from "intlayer";
+
+const config = getConfiguration();
+console.log(config);
+// 出力:
+// {
+//   internationalization: { ... },
+//   middleware: { ... },
+//   content: { ... },
+//   editor: { ... }
+// }
+```
+
+```javascript codeFormat="esm"
+import { getConfiguration } from "intlayer";
+
+const config = getConfiguration();
+console.log(config);
+// 出力:
+// {
+//   internationalization: { ... },
+//   middleware: { ... },
+//   content: { ... },
+//   editor: { ... }
+// }
+```
+
+```javascript codeFormat="commonjs"
+const { getConfiguration } = require("intlayer");
+
+const config = getConfiguration();
+console.log(config);
+// 出力:
+// {
+//   internationalization: { ... },
+//   middleware: { ... },
+//   content: { ... },
+//   editor: { ... }
+// }
+```
+
+### `availableLocales` と `defaultLocale` を抽出する
+
+設定の `internationalization` セクションには、`locales`（利用可能なロケール）や `defaultLocale`（フォールバック言語）などのロケール関連の設定が含まれています。
+
+```typescript codeFormat="typescript"
+import { getConfiguration } from "intlayer";
+
+const { internationalization, middleware } = getConfiguration();
+const { locales: availableLocales, defaultLocale } = internationalization;
+const { cookieName } = middleware;
+
+console.log(availableLocales); // 出力例: ["en", "fr", "es"]
+console.log(defaultLocale); // 出力例: "en"
+console.log(cookieName); // 出力: "INTLAYER_LOCALE"
+```
+
+```javascript codeFormat="esm"
+import { getConfiguration } from "intlayer";
+
+const { internationalization, middleware } = getConfiguration();
+const { locales: availableLocales, defaultLocale } = internationalization;
+const { cookieName } = middleware;
+
+console.log(availableLocales); // 出力例: ["en", "fr", "es"]
+console.log(defaultLocale); // 出力例: "en"
+console.log(cookieName); // 出力: "INTLAYER_LOCALE"
+```
+
+```javascript codeFormat="commonjs"
+const { getConfiguration } = require("intlayer");
+
+const { internationalization, middleware } = getConfiguration();
+const { locales: availableLocales, defaultLocale } = internationalization;
+const { cookieName } = middleware;
+
+console.log(availableLocales); // 出力例: ["en", "fr", "es"]
+console.log(defaultLocale); // 出力例: "en"
+console.log(cookieName); // 出力: "INTLAYER_LOCALE"
+```
+
+## 注意事項
+
+- この関数を呼び出す前に、必要なすべての環境変数が正しく設定されていることを確認してください。不足している変数は初期化時にエラーを引き起こします。
+- この関数はクライアント側とサーバー側の両方で使用できるため、統一された方法で設定を管理するための汎用的なツールです。
+
+## アプリケーションでの使用
+
+`getConfiguration` 関数は、`intlayer` アプリケーションの設定を初期化および管理するための重要なユーティリティです。ロケール、ミドルウェア、コンテンツディレクトリなどの設定にアクセスすることで、多言語対応およびコンテンツ駆動型アプリケーションにおける一貫性とスケーラビリティを確保します。

package/ja/packages/intlayer/getEnumeration.md

@@ -0,0 +1,140 @@
+# ドキュメント: `getEnumeration` 関数 in `intlayer`
+
+## 説明
+
+`getEnumeration` 関数は、列挙オブジェクト内の事前定義された条件に基づいて、特定の数量に対応するコンテンツを取得します。条件はキーとして定義され、オブジェクト内の順序によって優先順位が決まります。
+
+## パラメータ
+
+- `enumerationContent: QuantityContent<Content>`
+
+  - **説明**: キーが条件（例: `<=`, `<`, `>=`, `=`）を表し、値が対応するコンテンツを表すオブジェクト。キーの順序が一致の優先順位を定義します。
+  - **型**: `QuantityContent<Content>`
+    - `Content` は任意の型を取ることができます。
+
+- `quantity: number`
+
+  - **説明**: `enumerationContent` 内の条件と一致させるために使用される数値。
+  - **型**: `number`
+
+## 戻り値
+
+- **型**: `Content`
+- **説明**: `enumerationContent` 内の最初に一致する条件に対応するコンテンツ。一致が見つからない場合、実装に基づいて（例: エラーやフォールバックコンテンツ）処理されます。
+
+## 使用例
+
+### 基本的な使用法
+
+```typescript codeFormat="typescript"
+import { getEnumeration } from "intlayer";
+
+const content = getEnumeration(
+  {
+    "<=-2.3": "You have less than -2.3", // -2.3以下の場合
+    "<1": "You have less than one", // 1未満の場合
+    "2": "You have two", // 2の場合
+    ">=3": "You have three or more", // 3以上の場合
+  },
+  2
+);
+
+console.log(content); // 出力: "You have two"
+```
+
+```javascript codeFormat="esm"
+import { getEnumeration } from "intlayer";
+
+const content = getEnumeration(
+  {
+    "<1": "You have less than one", // 1未満の場合
+    "2": "You have two", // 2の場合
+    ">=3": "You have three or more", // 3以上の場合
+  },
+  2
+);
+
+console.log(content); // 出力: "You have two"
+```
+
+```javascript codeFormat="commonjs"
+const { getEnumeration } = require("intlayer");
+
+const content = getEnumeration(
+  {
+    "<1": "You have less than one", // 1未満の場合
+    "2": "You have two", // 2の場合
+    ">=3": "You have three or more", // 3以上の場合
+  },
+  2
+);
+
+console.log(content); // 出力: "You have two"
+```
+
+### 条件の優先順位
+
+```typescript codeFormat="typescript"
+import { getEnumeration } from "intlayer";
+
+const content = getEnumeration(
+  {
+    "<4": "You have less than four", // 4未満の場合
+    "2": "You have two", // 2の場合
+  },
+  2
+);
+
+console.log(content); // 出力: "You have less than four"
+```
+
+```javascript codeFormat="esm"
+import { getEnumeration } from "intlayer";
+
+const content = getEnumeration(
+  {
+    "<4": "You have less than four", // 4未満の場合
+    "2": "You have two", // 2の場合
+  },
+  2
+);
+
+console.log(content); // 出力: "You have less than four"
+```
+
+```javascript codeFormat="commonjs"
+const { getEnumeration } = require("intlayer");
+
+const content = getEnumeration(
+  {
+    "<4": "You have less than four", // 4未満の場合
+    "2": "You have two", // 2の場合
+  },
+  2
+);
+
+console.log(content); // 出力: "You have less than four"
+```
+
+## エッジケース
+
+- **一致する条件がない場合:**
+
+  - 提供された数量に一致する条件がない場合、関数は `undefined` を返すか、明示的にデフォルト/フォールバックシナリオを処理します。
+
+- **曖昧な条件:**
+
+  - 条件が重複している場合、最初に一致する条件（オブジェクトの順序に基づく）が優先されます。
+
+- **無効なキー:**
+
+  - 関数は、`enumerationContent` 内のすべてのキーが有効で条件として解析可能であると仮定します。無効または形式が不適切なキーは予期しない動作を引き起こす可能性があります。
+
+- **TypeScript の強制:**
+  - 関数は、すべてのキーで `Content` 型が一貫していることを保証し、取得されたコンテンツの型安全性を確保します。
+
+## 注意事項
+
+- `findMatchingCondition` ユーティリティは、指定された数量に基づいて適切な条件を決定するために使用されます。
+
+[GitHub リンク](https://github.com/aymericzip/intlayer/blob/main/docs/ja/**/*.md)

package/ja/packages/intlayer/getHTMLTextDir.md

@@ -0,0 +1,97 @@
+# ドキュメント: `getHTMLTextDir` 関数 in `intlayer`
+
+## 説明
+
+`getHTMLTextDir` 関数は、指定されたロケールに基づいてテキストの方向 (`ltr`, `rtl`, または `auto`) を決定します。この関数は、HTML内で適切なテキストレンダリングのために `dir` 属性を設定する際に役立ちます。
+
+## パラメータ
+
+- `locale?: Locales`
+
+  - **説明**: テキスト方向を決定するために使用されるロケール文字列 (例: `Locales.ENGLISH`, `Locales.ARABIC`)。
+  - **型**: `Locales` (オプション)
+
+## 戻り値
+
+- **型**: `Dir` (`'ltr' | 'rtl' | 'auto'`)
+- **説明**: ロケールに対応するテキスト方向:
+  - `'ltr'`: 左から右に読む言語。
+  - `'rtl'`: 右から左に読む言語。
+  - `'auto'`: ロケールが認識されない場合。
+
+## 使用例
+
+### テキスト方向の決定
+
+```typescript codeFormat="typescript"
+import { getHTMLTextDir } from "intlayer";
+
+getHTMLTextDir(Locales.ENGLISH); // 出力: "ltr"
+getHTMLTextDir(Locales.FRENCH); // 出力: "ltr"
+getHTMLTextDir(Locales.ARABIC); // 出力: "rtl"
+```
+
+```javascript codeFormat="esm"
+import { getHTMLTextDir } from "intlayer";
+
+getHTMLTextDir(Locales.ENGLISH); // 出力: "ltr"
+getHTMLTextDir(Locales.FRENCH); // 出力: "ltr"
+getHTMLTextDir(Locales.ARABIC); // 出力: "rtl"
+```
+
+```javascript codeFormat="commonjs"
+const { getHTMLTextDir } = require("intlayer");
+
+getHTMLTextDir(Locales.ENGLISH); // 出力: "ltr"
+getHTMLTextDir(Locales.FRENCH); // 出力: "ltr"
+getHTMLTextDir(Locales.ARABIC); // 出力: "rtl"
+```
+
+## エッジケース
+
+- **ロケールが指定されていない場合:**
+
+  - `locale` が `undefined` の場合、関数は `'auto'` を返します。
+
+- **認識されないロケール:**
+  - 認識されないロケールの場合、関数はデフォルトで `'auto'` を返します。
+
+## コンポーネントでの使用:
+
+`getHTMLTextDir` 関数は、ロケールに基づいてHTMLドキュメント内の `dir` 属性を動的に設定するために使用できます。
+
+```tsx codeFormat="typescript"
+import type { FC } from "react";
+import { getHTMLTextDir, type Locales } from "intlayer";
+
+export const HTMLLayout: FC<PropsWithChildren<{ locale: Locales }>> = ({
+  children,
+  locale,
+}) => (
+  <html dir={getHTMLTextDir(locale)} locale={locale}>
+    <body>{children}</body>
+  </html>
+);
+```
+
+```jsx codeFormat="esm"
+import { getHTMLTextDir } from "intlayer";
+
+const HTMLLayout = ({ children, locale }) => (
+  <html dir={getHTMLTextDir(locale)} locale={locale}>
+    <body>{children}</body>
+  </html>
+);
+```
+
+```jsx codeFormat="commonjs"
+const { getHTMLTextDir } = require("intlayer");
+
+const HTMLLayout = ({ children, locale }) => (
+  <html dir={getHTMLTextDir(locale)} locale={locale}>
+    <body>{children}</body>
+  </html>
+);
+```
+
+上記の例では、`dir` 属性がロケールに基づいて動的に設定されます。

package/ja/packages/intlayer/getLocaleLang.md

@@ -0,0 +1,59 @@
+# ドキュメント: `getLocaleLang` 関数 in `intlayer`
+
+## 説明
+
+`getLocaleLang` 関数は、ロケール文字列から言語コードを抽出します。国コードの有無にかかわらずロケールをサポートします。ロケールが指定されていない場合は、デフォルトで空の文字列を返します。
+
+## パラメータ
+
+- `locale?: Locales`
+
+  - **説明**: 言語コードが抽出されるロケール文字列（例: `Locales.ENGLISH_UNITED_STATES`, `Locales.FRENCH_CANADA`）。
+  - **型**: `Locales`（オプション）
+
+## 戻り値
+
+- **型**: `string`
+- **説明**: ロケールから抽出された言語コード。ロケールが指定されていない場合は、空の文字列（`''`）を返します。
+
+## 使用例
+
+### 言語コードの抽出:
+
+```typescript codeFormat="typescript"
+import { getLocaleLang, Locales } from "intlayer";
+
+getLocaleLang(Locales.ENGLISH_UNITED_STATES); // 出力: "en"
+getLocaleLang(Locales.ENGLISH); // 出力: "en"
+getLocaleLang(Locales.FRENCH_CANADA); // 出力: "fr"
+getLocaleLang(Locales.FRENCH); // 出力: "fr"
+```
+
+```javascript codeFormat="esm"
+import { getLocaleLang } from "intlayer";
+
+getLocaleLang(Locales.ENGLISH_UNITED_STATES); // 出力: "en"
+getLocaleLang(Locales.ENGLISH); // 出力: "en"
+getLocaleLang(Locales.FRENCH_CANADA); // 出力: "fr"
+getLocaleLang(Locales.FRENCH); // 出力: "fr"
+```
+
+```javascript codeFormat="commonjs"
+const { getLocaleLang } = require("intlayer");
+
+getLocaleLang(Locales.ENGLISH_UNITED_STATES); // 出力: "en"
+getLocaleLang(Locales.ENGLISH); // 出力: "en"
+getLocaleLang(Locales.FRENCH_CANADA); // 出力: "fr"
+getLocaleLang(Locales.FRENCH); // 出力: "fr"
+```
+
+## エッジケース
+
+- **ロケールが指定されていない場合:**
+
+  - `locale` が `undefined` の場合、関数は空の文字列を返します。
+
+- **不正なロケール文字列:**
+  - `locale` が `language-country` フォーマット（例: `Locales.ENGLISH-US`）に従わない場合、関数は安全に `'-'` の前の部分、または `'-'` が存在しない場合は文字列全体を返します。
+
+[詳細はこちら](https://github.com/aymericzip/intlayer/blob/main/docs/ja/getLocaleLang.md)

package/ja/packages/intlayer/getLocaleName.md

@@ -0,0 +1,93 @@
+# ドキュメント: `getLocaleName` 関数 in `intlayer`
+
+## 説明
+
+`getLocaleName` 関数は、指定されたロケール (`targetLocale`) の名前を表示ロケール (`displayLocale`) でローカライズして返します。`targetLocale` が指定されていない場合、`displayLocale` 自身の言語での名前を返します。
+
+## パラメータ
+
+- `displayLocale: Locales`
+
+  - **説明**: ターゲットロケールの名前を表示するロケール。
+  - **型**: 有効なロケールを表す列挙型または文字列。
+
+- `targetLocale?: Locales`
+  - **説明**: ローカライズする名前の対象となるロケール。
+  - **型**: 任意。有効なロケールを表す列挙型または文字列。
+
+## 戻り値
+
+- **型**: `string`
+- **説明**: `displayLocale` でローカライズされた `targetLocale` の名前、または `targetLocale` が指定されていない場合は `displayLocale` 自身の名前。翻訳が見つからない場合は `"Unknown locale"` を返します。
+
+## 使用例
+
+```typescript codeFormat="typescript"
+import { Locales, getLocaleName } from "intlayer";
+
+getLocaleName(Locales.ENGLISH); // 出力: "English"
+getLocaleName(Locales.ENGLISH, Locales.FRENCH); // 出力: "Anglais"
+getLocaleName(Locales.ENGLISH, Locales.ESPANOL); // 出力: "Inglés"
+getLocaleName(Locales.ENGLISH, Locales.ENGLISH); // 出力: "English"
+
+getLocaleName(Locales.FRENCH); // 出力: "Français"
+getLocaleName(Locales.FRENCH, Locales.FRENCH); // 出力: "Français"
+getLocaleName(Locales.FRENCH, Locales.ESPANOL); // 出力: "Francés"
+getLocaleName(Locales.FRENCH, Locales.ENGLISH); // 出力: "French"
+
+getLocaleName(Locales.CHINESE); // 出力: "中文"
+getLocaleName(Locales.CHINESE, Locales.FRENCH); // 出力: "Chinois"
+getLocaleName(Locales.CHINESE, Locales.ESPANOL); // 出力: "Chino"
+getLocaleName(Locales.CHINESE, Locales.ENGLISH); // 出力: "Chinese"
+
+getLocaleName("unknown-locale"); // 出力: "Unknown locale"
+```
+
+```javascript codeFormat="esm"
+import { Locales, getLocaleName } from "intlayer";
+
+getLocaleName(Locales.ENGLISH); // 出力: "English"
+getLocaleName(Locales.ENGLISH, Locales.FRENCH); // 出力: "Anglais"
+getLocaleName(Locales.ENGLISH, Locales.ESPANOL); // 出力: "Inglés"
+getLocaleName(Locales.ENGLISH, Locales.ENGLISH); // 出力: "English"
+
+getLocaleName(Locales.FRENCH); // 出力: "Français"
+getLocaleName(Locales.FRENCH, Locales.FRENCH); // 出力: "Français"
+getLocaleName(Locales.FRENCH, Locales.ESPANOL); // 出力: "Francés"
+getLocaleName(Locales.FRENCH, Locales.ENGLISH); // 出力: "French"
+
+getLocaleName(Locales.CHINESE); // 出力: "中文"
+getLocaleName(Locales.CHINESE, Locales.FRENCH); // 出力: "Chinois"
+getLocaleName(Locales.CHINESE, Locales.ESPANOL); // 出力: "Chino"
+getLocaleName(Locales.CHINESE, Locales.ENGLISH); // 出力: "Chinese"
+
+getLocaleName("unknown-locale"); // 出力: "Unknown locale"
+```
+
+```javascript codeFormat="commonjs"
+const { Locales, getLocaleName } = require("intlayer");
+
+getLocaleName(Locales.ENGLISH); // 出力: "English"
+getLocaleName(Locales.ENGLISH, Locales.FRENCH); // 出力: "Anglais"
+getLocaleName(Locales.ENGLISH, Locales.ESPANOL); // 出力: "Inglés"
+getLocaleName(Locales.ENGLISH, Locales.ENGLISH); // 出力: "English"
+
+getLocaleName(Locales.FRENCH); // 出力: "Français"
+getLocaleName(Locales.FRENCH, Locales.FRENCH); // 出力: "Français"
+getLocaleName(Locales.FRENCH, Locales.ESPANOL); // 出力: "Francés"
+getLocaleName(Locales.FRENCH, Locales.ENGLISH); // 出力: "French"
+
+getLocaleName(Locales.CHINESE); // 出力: "中文"
+getLocaleName(Locales.CHINESE, Locales.FRENCH); // 出力: "Chinois"
+getLocaleName(Locales.CHINESE, Locales.ESPANOL); // 出力: "Chino"
+getLocaleName(Locales.CHINESE, Locales.ENGLISH); // 出力: "Chinese"
+
+getLocaleName("unknown-locale"); // 出力: "Unknown locale"
+```
+
+## エッジケース
+
+- **`targetLocale` が指定されていない場合:**
+  - 関数はデフォルトで `displayLocale` 自身の名前を返します。
+- **翻訳が見つからない場合:**
+  - `localeNameTranslations` に `targetLocale` または特定の `displayLocale` のエントリがない場合、関数は `ownLocalesName` を使用するか、`"Unknown locale"` を返します。