# @dittowords/text-extract 中文文档

规范地址：https://npmcn.com/package/%40dittowords/text-extract/

版本：0\.5\.0
npm 元数据更新时间：2026-10-22T12:04:30.777Z
中文译文更新时间：2026-11-12T11:39:19.209Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：298 kB，81 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：5 个
- peer 依赖：zod ^4\.0\.0
- 首次发布：2026-08-11T14:53:26.155Z
- 最新版本发布：2026-10-22T12:04:30.491Z
- 近 30 天下载量：8323（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 7 个）

## 中文简介

从一个代码库中断然取出候选用户界面字符串 .

## 安装

```sh
npm install @dittowords/text-extract
```

也可以使用：`pnpm add @dittowords/text-extract`、`yarn add @dittowords/text-extract`、`bun add @dittowords/text-extract`

## README

# @ dittowords/ text- extract( 缩写)

在潜在的用户界面编码库中查找字符串 .

## 使用量

**整个目录 :**

```ts
import { runExtract } from "@dittowords/text-extract";

const { candidates, summary } = await runExtract({ inputPath: "/path/to/repo" });
```

跳过销售、建造和测试树木和荣誉 `.gitignore`。 。 。 .

**一个文件 :**

```ts
import { extractFile } from "@dittowords/text-extract";

const { candidates, skipped } = await extractFile({
  relPath: "src/Button.tsx", // used verbatim as `location.file`
  source: fileContents,
  framework: ["react", "next"], // optional
});
```

扫描它给出的任何路径——没有应用排除. `framework` 这是 相同的符号列表 `runExtract` 来源 `package.json` 文档和本地 项目标记; 省略只花费分类提示.

`skipped` 当文件完全没有扫描时设置( u)`unsupported_language`, (中文(简体) ), `unconfirmed_i18n_file`, (中文(简体) ), `minified`)——与扫描和查找不同 没什么.

两个入境点在同一档案上作出相同判决.

### 页:1

-   候选人顺序在跑步之间可能不稳定,因为Globby的文件迭代 顺序不同。 套装是稳定的;作相应的比较.
-   `summary.filesFailed` 计数文件 一个提取器扔。 他们从 结果,所以一个非零数意味着字符串缺失.
-   `summary.linesStoppedEarly` 数行因是 长于 `MAX_LINE_LENGTH` 或慢于 `LINE_TIME_LIMIT_MS` 以示纪念. 跳过一行没有候选人. `summary.stoppedEarlyLines` 清单最多20份 他们的文件跳过行 . `extractFile` 返回其所有已跳过行 文件输入 `stoppedEarlyLines`。 。 。 .

## 发展

```sh
yarn test
yarn typecheck
yarn build
```

| 测试 |  |
| --- | --- |
| `lang/extractors/*.test.ts` | 人间建筑分类法. 准确行并列. |
| `golden.test.ts` | 现实的固定装置来自 `testing/golden/`和手写的期望。 固定装置在a下试验 `relPath` 由于路径形状驱动 i18n 输入和本地化检测. |
| `extract-file.test.ts` | 两个入境点同意每个文件. |
| `extract-failures.test.ts` | 扔取出物被计算,而不是被吞噬. |
| `extract-performance.test.ts` | 语法提取器不会在大量输入上 出现灾难性的倒退. |
| `line-time-limit.test.ts` | 长行或慢行会被跳过并报告每个文件,跳过行后的状态是正确的. |

## 常见问题

### @dittowords/text-extract 是什么？

从一个代码库中断然取出候选用户界面字符串 \.

### 如何安装 @dittowords/text-extract？

在项目目录运行 npm install @dittowords/text-extract，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：zod（^4\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @dittowords/text-extract 支持 TypeScript 吗？

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

### @dittowords/text-extract 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @dittowords/text-extract 需要什么版本的 Node\.js？

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

### @dittowords/text-extract 可以商用吗？

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

### @dittowords/text-extract 的下载量有多少？

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

### @dittowords/text-extract 还在维护吗？

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