@intlayer/docs 9.0.0-canary.3 → 9.0.0-canary.4

package/docs/zh/packages/svelte-intlayer/usePathname.md

@@ -0,0 +1,103 @@
+---
+createdAt: 2026-06-22
+updatedAt: 2026-06-22
+title: usePathname 函数文档 | svelte-intlayer
+description: 了解如何使用 svelte-intlayer 包中的 usePathname 函数
+keywords:
+  - usePathname
+  - pathname
+  - locale
+  - Intlayer
+  - 国际化
+  - 文档
+  - Svelte
+  - JavaScript
+slugs:
+  - doc
+  - packages
+  - svelte-intlayer
+  - usePathname
+history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "添加 usePathname 实用程序"
+  - version: 8.2.0
+    date: 2026-06-22
+    changes: "初始化历史记录"
+author: aymericzip
+---
+
+# Svelte 集成：`usePathname` 文档
+
+`usePathname` 函数以 Svelte 的 `Readable<string>` store 形式返回去除了 locale 段的当前浏览器路径名（pathname）。这对于构建支持 locale 的导航非常有用——例如，判断哪个导航项是激活状态的——而无需手动去除 locale 前缀。
+
+## 在 Svelte 中导入 `usePathname`
+
+```typescript
+import { usePathname } from "svelte-intlayer";
+```
+
+## 概述
+
+`usePathname` 创建一个 Svelte readable store，它读取 `window.location.pathname`，通过 `getPathWithoutLocale` 去除 locale 前缀，并在浏览器触发 `popstate` 事件（后退/前进导航）时发出新值。在组件中使用 `$` 语法来订阅。
+
+## 用法
+
+```svelte fileName="src/components/NavItem.svelte"
+<script lang="ts">
+  import { usePathname } from "svelte-intlayer";
+
+  export let href: string;
+  export let label: string;
+
+  const pathname = usePathname();
+</script>
+
+<a {href} aria-current={$pathname === href ? "page" : undefined}>
+  {label}
+</a>
+```
+
+## 返回值
+
+| 类型               | 描述                                                                   |
+| ------------------ | ---------------------------------------------------------------------- |
+| `Readable<string>` | 包含不带 locale 前缀的当前路径名（pathname）的 Svelte readable store。 |
+
+## 行为
+
+- **去除 Locale**：移除开头的 locale 段（例如 `/zh/dashboard` → `/dashboard`）。
+- **响应式**：在每次 `popstate` 事件（浏览器的后退 / 前进导航）触发时发出新值。
+- **SSR 安全**：在 `window` 不可用时返回 `""`。
+- **清理（Cleanup）**：当最后一个订阅者取消订阅时，会自动移除 `popstate` 监听器。
+
+## 示例
+
+```svelte fileName="src/components/Sidebar.svelte"
+<script lang="ts">
+  import { usePathname } from "svelte-intlayer";
+
+  const links = [
+    { href: "/dashboard", label: "仪表盘" },
+    { href: "/settings", label: "设置" },
+  ];
+
+  const pathname = usePathname();
+</script>
+
+<nav>
+  {#each links as link}
+    <a
+      href={link.href}
+      style:font-weight={$pathname === link.href ? "bold" : "normal"}
+    >
+      {link.label}
+    </a>
+  {/each}
+</nav>
+```
+
+## 相关阅读
+
+- [`useLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/svelte-intlayer/useLocale.md) — 当前 locale + locale 切换器
+- [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getPathWithoutLocale.md) — 该 hook 所使用的底层实用程序

package/docs/zh/packages/vue-intlayer/exports.md

@@ -14,6 +14,9 @@ slugs:
   - vue-intlayer
   - exports
 history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "添加 usePathname 实用程序"
   - version: 8.0.0
     date: 2026-01-21
     changes: "统一了所有导出的文档"
@@ -52,16 +55,17 @@ import "vue-intlayer";
 import "vue-intlayer";
 ```
 
-| 组合函数               | 说明                                                                             | 相关文档                                                                                                              |
-| ---------------------- | -------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
-| `useIntlayer`          | 基于 `useDictionary`，但注入来自生成声明的经过优化的字典版本。                   | -                                                                                                                     |
-| `useDictionary`        | 处理类似字典的对象（key、content）。它会处理 `t()` 翻译、枚举等。                | -                                                                                                                     |
-| `useDictionaryAsync`   | 与 `useDictionary` 相同，但处理异步字典。                                        | -                                                                                                                     |
-| `useDictionaryDynamic` | 与 `useDictionary` 相同，但处理动态字典。                                        | -                                                                                                                     |
-| `useLocale`            | 返回当前 locale 以及用于设置它的函数。                                           | -                                                                                                                     |
-| `useRewriteURL`        | 客户端 composable，用于管理 URL 重写。如果存在本地化的重写规则，会自动更新 URL。 | [useRewriteURL](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/vue-intlayer/useRewriteURL.md) |
-| `useIntl`              | 返回当前 locale 的 Intl 对象。                                                   | -                                                                                                                     |
-| `useLoadDynamic`       | 用于加载动态字典的 composable。                                                  | -                                                                                                                     |
+| 组合函数               | 说明                                                                                                   | 相关文档                                                                                                              |
+| ---------------------- | ------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- |
+| `useIntlayer`          | 基于 `useDictionary`，但注入来自生成声明的经过优化的字典版本。                                         | -                                                                                                                     |
+| `useDictionary`        | 处理类似字典的对象（key、content）。它会处理 `t()` 翻译、枚举等。                                      | -                                                                                                                     |
+| `useDictionaryAsync`   | 与 `useDictionary` 相同，但处理异步字典。                                                              | -                                                                                                                     |
+| `useDictionaryDynamic` | 与 `useDictionary` 相同，但处理动态字典。                                                              | -                                                                                                                     |
+| `useLocale`            | 返回当前 locale 以及用于设置它的函数。                                                                 | -                                                                                                                     |
+| `usePathname`          | 返回当前路径名（pathname）作为 `ComputedRef<string>`，并已移除 locale 片段。对 `popstate` 具有响应式。 | [usePathname](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/vue-intlayer/usePathname.md)     |
+| `useRewriteURL`        | 客户端 composable，用于管理 URL 重写。如果存在本地化的重写规则，会自动更新 URL。                       | [useRewriteURL](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/vue-intlayer/useRewriteURL.md) |
+| `useIntl`              | 返回当前 locale 的 Intl 对象。                                                                         | -                                                                                                                     |
+| `useLoadDynamic`       | 用于加载动态字典的 composable。                                                                        | -                                                                                                                     |
 
 ### 函数
 

package/docs/zh/packages/vue-intlayer/usePathname.md

@@ -0,0 +1,109 @@
+---
+createdAt: 2026-06-22
+updatedAt: 2026-06-22
+title: usePathname 函数文档 | vue-intlayer
+description: 了解如何使用 vue-intlayer 包中的 usePathname 函数
+keywords:
+  - usePathname
+  - pathname
+  - locale
+  - Intlayer
+  - 国际化 (Internationalization)
+  - 文档 (Documentation)
+  - Vue
+  - JavaScript
+slugs:
+  - doc
+  - packages
+  - vue-intlayer
+  - usePathname
+history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "添加 usePathname 实用程序"
+  - version: 8.2.0
+    date: 2026-06-22
+    changes: "初始化历史记录"
+author: aymericzip
+---
+
+# Vue 集成：`usePathname` 文档
+
+`usePathname` 函数返回当前浏览器的路径名（pathname），并以 Vue `ComputedRef<string>` 的形式提供移除了 locale 片段后的路径名。这对于构建可感知 locale 的导航非常有用——例如，确定哪个导航项处于激活状态——而无需手动移除 locale 前缀。
+
+## 在 Vue 中导入 `usePathname`
+
+```typescript
+import { usePathname } from "vue-intlayer";
+```
+
+## 概览
+
+`usePathname` 创建一个 Vue 计算引用 (computed ref)，它读取 `window.location.pathname`，通过 `getPathWithoutLocale` 移除 locale 前缀，并且每当浏览器触发 `popstate` 事件（后退/前进导航）时自动更新其值。该值可以直接在你的 Vue 模板或 setup 函数中使用。
+
+## 用法
+
+```vue fileName="src/components/NavItem.vue"
+<script setup lang="ts">
+import { usePathname } from "vue-intlayer";
+
+const props = defineProps<{
+  href: string;
+  label: string;
+}>();
+
+const pathname = usePathname();
+</script>
+
+<template>
+  <a :href="href" :aria-current="pathname === href ? 'page' : undefined">
+    {{ label }}
+  </a>
+</template>
+```
+
+## 返回值
+
+| 类型                  | 描述                                                             |
+| --------------------- | ---------------------------------------------------------------- |
+| `ComputedRef<string>` | Vue Computed Ref，包含不带 locale 前缀的当前路径名（pathname）。 |
+
+## 行为
+
+- **Locale 剥离 (Locale stripping)**：移除路径开头的 locale 片段（例如：`/zh/dashboard` → `/dashboard`）。
+- **响应式 (Reactive)**：在每次 `popstate` 事件（浏览器后退 / 前进导航）时更新值。
+- **SSR 安全 (SSR-safe)**：当 `window` 不可用时返回 `""`。
+- **清理 (Cleanup)**：`popstate` 监听器在初始化时全局添加，由于 Vue 对生命周期的管理，通常不需要在每个组件中手动进行清理。
+
+## 示例
+
+```vue fileName="src/components/Sidebar.vue"
+<script setup lang="ts">
+import { usePathname } from "vue-intlayer";
+
+const links = [
+  { href: "/dashboard", label: "仪表盘" },
+  { href: "/settings", label: "设置" },
+];
+
+const pathname = usePathname();
+</script>
+
+<template>
+  <nav>
+    <a
+      v-for="link in links"
+      :key="link.href"
+      :href="link.href"
+      :style="{ fontWeight: pathname === link.href ? 'bold' : 'normal' }"
+    >
+      {{ link.label }}
+    </a>
+  </nav>
+</template>
+```
+
+## 相关内容
+
+- [`useLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/vue-intlayer/useLocale.md) — 当前 locale 及其切换器
+- [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getPathWithoutLocale.md) — 此 hook 所使用的底层实用函数

package/docs/zh-TW/intlayer_with_angular_21.md

@@ -85,28 +85,44 @@ author: aymericzip
 
 使用npm安裝必要的套件：
 
+```bash packageManager="npm"
+npx intlayer-cli init --interactive
+```
+
+```bash packageManager="pnpm"
+pnpm dlx intlayer-cli init --interactive
+```
+
+```bash packageManager="yarn"
+yarn dlx intlayer-cli init --interactive
+```
+
+```bash packageManager="bun"
+bunx intlayer-cli init --interactive
+```
+
+> `--interactive` 標誌是可選的。如果您是 AI 代理，請使用 `intlayer-cli init`。
+
+> 此命令將偵測您的環境並安裝所需的套件。例如：
+
 ```bash packageManager="npm"
 npm install intlayer angular-intlayer
 npm install @angular-builders/custom-esbuild --save-dev
-npx intlayer init
 ```
 
 ```bash packageManager="pnpm"
 pnpm add intlayer angular-intlayer
 pnpm add @angular-builders/custom-esbuild --save-dev
-pnpm intlayer init
 ```
 
 ```bash packageManager="yarn"
 yarn add intlayer angular-intlayer
 yarn add @angular-builders/custom-esbuild --save-dev
-yarn intlayer init
 ```
 
 ```bash packageManager="bun"
 bun add intlayer angular-intlayer
 bun add @angular-builders/custom-esbuild --dev
-bun x intlayer init
 ```
 
 - **intlayer**

package/docs/zh-TW/packages/intlayer/comparePaths.md

@@ -0,0 +1,173 @@
+---
+createdAt: 2026-06-22
+updatedAt: 2026-06-22
+title: comparePaths 函式文件 | intlayer
+description: 了解如何使用 intlayer 套件中的 comparePaths 函式
+keywords:
+  - comparePaths
+  - normalizePath
+  - 活躍連結
+  - 導覽
+  - Intlayer
+  - intlayer
+  - 國際化
+  - 文件
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - comparePaths
+history:
+  - version: 9.0.0
+    date: 2026-06-22
+    changes: "初始文件"
+author: aymericzip
+---
+
+# 文件: `intlayer` 中的 `comparePaths` 函式
+
+## 描述
+
+`comparePaths` 函式在忽略語言設定（locale）區段、通訊協定/主機名稱、查詢字串、雜湊值和結尾斜線的情況下，比較兩個 URL 或路徑是否相等。這是判斷導覽連結是否指向目前頁面的推薦方法（例如，用於標示目前活動的連結），而無需撰寫自己（容易出錯）的正規化邏輯。
+
+它在內部重複使用了 [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh-TW/packages/intlayer/getPathWithoutLocale.md) 來移除語言設定區段，因此它會遵循您配置的路由模式和語言設定。
+
+該套件還匯出了底層的 [`normalizePath`](#normalizepath) 輔助函式，它會回傳用於比較的、與語言設定無關的正規路徑名稱。
+
+**主要功能：**
+
+- 與語言設定無關的比較（`/zh-TW/about` 與 `/about` 匹配）
+- 適用於絕對 URL 和相對路徑
+- 忽略查詢字串、雜湊值和結尾斜線
+- 容許缺少前導斜線和空值（正規化為 `/`）
+- 輕量級 — 建構在 `getPathWithoutLocale` 之上
+
+---
+
+## 函式簽名
+
+```typescript
+comparePaths(
+  pathname: string,  // 必填
+  href: string,      // 必填
+  locales?: Locales[] // 選填
+): boolean
+
+normalizePath(
+  inputUrl: string,   // 必填
+  locales?: Locales[] // 選填
+): string
+```
+
+---
+
+## 參數
+
+- `pathname: string`
+  - **描述**: 要比較的第一個 URL 字串或路徑名稱（通常是目前路徑）。
+  - **型別**: `string`
+  - **必填**: 是
+
+- `href: string`
+  - **描述**: 要比較的第二個 URL 字串或路徑名稱（通常是導覽連結的 `href`）。
+  - **型別**: `string`
+  - **必填**: 是
+
+- `locales: Locales[]`
+  - **描述**: 支援的語言設定的選填陣列。預設為專案中設定的語言。
+  - **型別**: `Locales[]`
+  - **必填**: 否 (選填)
+
+### 回傳值
+
+- **型別**: `boolean`
+- **描述**: 當兩個輸入都解析為相同的與語言設定無關的路徑時回傳 `true`，否則回傳 `false`。
+
+---
+
+## 範例用法
+
+### 基本用法
+
+```typescript codeFormat={["typescript", "esm", "commonjs"]}
+import { comparePaths } from "intlayer";
+
+comparePaths("/ru/path", "/path"); // true
+comparePaths("/ru/path/", "/path"); // true
+comparePaths("/ru/path", "/path/"); // true
+comparePaths("/ru/", "/"); // true
+comparePaths("/ru", "/"); // true
+comparePaths("ru/path", "/path"); // true
+comparePaths("", "/"); // true
+comparePaths("/ru", ""); // true
+comparePaths("/ru/path", "/other"); // false
+```
+
+### 絕對和相對 URL
+
+```typescript
+import { comparePaths } from "intlayer";
+
+comparePaths("https://example.com/ru/path", "/path"); // true
+```
+
+### 標示活動的導覽連結
+
+```tsx
+import { comparePaths } from "intlayer";
+import { useLocation } from "react-router";
+
+const NavLink = ({ href, children }) => {
+  const { pathname } = useLocation();
+  const isActive = comparePaths(pathname, href);
+
+  return (
+    <a href={href} aria-current={isActive ? "page" : undefined}>
+      {children}
+    </a>
+  );
+};
+```
+
+---
+
+## normalizePath
+
+`normalizePath` 回傳由 `comparePaths` 使用的、與語言設定無關的正規路徑名稱。它移除了語言設定區段、通訊協定/主機、查詢字串和雜湊，確保單個前導斜線，刪除任何結尾斜線（根目錄除外），對於空值則回退為 `/`。
+
+```typescript codeFormat={["typescript", "esm", "commonjs"]}
+import { normalizePath } from "intlayer";
+
+normalizePath("/ru/path"); // "/path"
+normalizePath("/ru/path/"); // "/path"
+normalizePath("ru/path"); // "/path"
+normalizePath("/ru/"); // "/"
+normalizePath("/ru"); // "/"
+normalizePath(""); // "/"
+normalizePath("https://example.com/ru/path"); // "/path"
+```
+
+---
+
+## 相關函式
+
+- [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh-TW/packages/intlayer/getPathWithoutLocale.md): 從 URL 或路徑中刪除語言設定區段。
+- [`getPrefix`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh-TW/packages/intlayer/getPrefix.md): 取得給定語言設定的 URL 前綴。
+- [`getLocalizedUrl`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh-TW/packages/intlayer/getLocalizedUrl.md): 為特定語言設定生成本地化 URL。
+
+---
+
+## TypeScript
+
+```typescript
+function normalizePath(inputUrl: string, locales?: Locales[]): string;
+
+function comparePaths(
+  pathname: string,
+  href: string,
+  locales?: Locales[]
+): boolean;
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intlayer/docs",
-  "version": "9.0.0-canary.3",
+  "version": "9.0.0-canary.4",
   "private": false,
   "description": "Intlayer documentation",
   "keywords": [
@@ -73,14 +73,14 @@
     "watch": "webpack --config ./webpack.config.ts --watch"
   },
   "dependencies": {
-    "@intlayer/config": "9.0.0-canary.3",
-    "@intlayer/core": "9.0.0-canary.3",
-    "@intlayer/types": "9.0.0-canary.3"
+    "@intlayer/config": "9.0.0-canary.4",
+    "@intlayer/core": "9.0.0-canary.4",
+    "@intlayer/types": "9.0.0-canary.4"
   },
   "devDependencies": {
-    "@intlayer/api": "9.0.0-canary.3",
-    "@intlayer/cli": "9.0.0-canary.3",
-    "@types/node": "25.9.3",
+    "@intlayer/api": "9.0.0-canary.4",
+    "@intlayer/cli": "9.0.0-canary.4",
+    "@types/node": "25.9.4",
     "@utils/ts-config": "1.0.4",
     "@utils/ts-config-types": "1.0.4",
     "@utils/tsdown-config": "1.0.4",