# @gravity-ui/i18n-cli 中文文档

规范地址：https://npmcn.com/package/%40gravity-ui/i18n-cli/

版本：1\.6\.0
npm 元数据更新时间：2026-11-03T15:26:01.390Z
中文译文更新时间：2026-11-16T23:57:57.754Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40gravity-ui/i18n-cli
原文对照：https://npmcn.com/package/%40gravity-ui/i18n-cli/?lang=original
项目主页：https://github.com/gravity-ui/i18n#readme
源码仓库：https://github.com/gravity-ui/i18n

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：168 kB，22 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>= 18
- 运行依赖：13 个
- peer 依赖：prettier ^3\.4\.2
- 首次发布：2025-10-16T14:34:35.955Z
- 最新版本发布：2026-11-03T15:26:00.923Z
- 近 30 天下载量：17614（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 13 个）

## 中文简介

-   为项目提供i18n配置

## 安装

```sh
npm install @gravity-ui/i18n-cli
```

也可以使用：`pnpm add @gravity-ui/i18n-cli`、`yarn add @gravity-ui/i18n-cli`、`bun add @gravity-ui/i18n-cli`

## README

# @gravity-ui/i18n-cli (英语)

-   为项目提供i18n配置
    
-   规定 `i18n-cli` 用于管理工程中语言文件的命令.
    

## 项目设置

1.  **安装软件包 :**
    
    ```bash
    npm i -D @gravity-ui/i18n-cli
    ```
    
2.  **创建配置文件 `i18n.config.ts` 在项目根中 :**
    
    ```ts
    import {defineConfig} from '@gravity-ui/i18n-cli/config';
    
    export default defineConfig({
        allowedLocales: ['ru', 'en', 'ru-kz', 'en-kz'] as const,
        fallbackLocales: {
            'ru-kz': 'ru',
            'en-kz': 'en',
        },
        defaultFallback: 'en',
        clientIntlModule: {
            path: 'src/shared/i18n/intl.ts',
            alias: '@shared/i18n',
        },
    });
    ```
    
3.  **导入 i18n 库实例中的配置( i18n- react and i18n- node)**
    
    ```ts
    import {createIntl} from '@gravity-ui/i18n-react';
    import i18nConfig from '../../../i18n.config';
    
    const {allowedLocales, fallbackLocales, defaultFallback} = i18nConfig;
    
    export const intl = createIntl({
        allowedLocales,
        fallbackLocales,
        defaultFallback,
    });
    ```
    

## 图标

### `create-keys`

检查提供的文件/目录中缺少密钥的呼叫,并将其添加到 `i18n.ts` 文档.

#### 运行一个文件

```bash
npx i18n-cli create-keys src/ui/SomeComponent/SomeComponent.tsx
```

#### 运行目录中的所有文件

```bash
npx i18n-cli create-keys src/ui/ComponentDirectory
```

### `find-unused`

从指定的目录开始对未使用的密钥进行回溯搜索 .

#### 关于未用密钥的报告

```bash
npx i18n-cli find-unused src/ui/SomeComponent
```

#### 删除未使用的密钥

```bash
npx i18n-cli find-unused -d src/ui/SomeComponent
```

## 配置选项

### 允许本地

类型 : `string[]`

在项目中允许本地人.

```ts
{
    allowedLocales: ['ru', 'en'] as const,
}
```

### 后退本地语言

给定地方的倒计时。 详情请查阅: [i18n- 核心数](https://npmcn.com/package/%40gravity-ui/i18n-core/README.md)。 。 。 .

### 默认返回

默认倒计时。 如果没有找到更高的优先级,则使用。 更多进去 [i18n- 核心数](https://npmcn.com/package/%40gravity-ui/i18n-core/README.md)。 。 。 .

### 客户端 Intl 模块

客户端的库实例位置 [i18n 反应](https://npmcn.com/package/%40gravity-ui/i18n-react/README.md) 在项目.

```ts
{
    clientIntlModule: {
        // Path to the module with intl library instance
        path: 'src/ui/shared/i18n.ts',

        // TypeScript alias of the module with intl library instance
        alias: '@shared/i18n';
    }
}
```

### 服务器Intl模块

服务器侧库实例位置 [i18n-节点](https://npmcn.com/package/%40gravity-ui/i18n-node/README.md) 在项目.

```ts
{
    serverIntlModule: {
        // Path to the module containing the intl library instance
        path: 'src/server/utils/i18n.ts',

        // TypeScript alias of the module containing the intl library instance
        alias: undefined,

        // Regular expressions that determine if a module belongs to the server-side
        pathMatchers: [/src\/server\/.+$/]
    }
}
```

## 常见问题

### @gravity-ui/i18n-cli 是什么？

为项目提供i18n配置

### 如何安装 @gravity-ui/i18n-cli？

在项目目录运行 npm install @gravity-ui/i18n-cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 i18n-cli，可以用 npx i18n-cli 直接运行。

### @gravity-ui/i18n-cli 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @gravity-ui/i18n-cli 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @gravity-ui/i18n-cli 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>= 18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @gravity-ui/i18n-cli 可以商用吗？

@gravity-ui/i18n-cli 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @gravity-ui/i18n-cli 的下载量有多少？

根据 npm 官方下载统计，@gravity-ui/i18n-cli 在 2026/10/17 – 2026/11/15 这 30 天内被下载 17,614 次，日均约 587 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @gravity-ui/i18n-cli 还在维护吗？

最新版本 1\.6\.0 发布于 2026/11/03（13 天前）；至今共发布 15 个版本，其中过去 12 个月发布了 13 个；首次发布于 2025/10/16。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

