# @flatfile/plugin-validate-string 中文文档

规范地址：https://npmcn.com/package/%40flatfile/plugin-validate-string/

版本：0\.3\.1
npm 元数据更新时间：2026-04-23T23:54:47.931Z
中文译文更新时间：2026-11-14T22:36:08.745Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40flatfile/plugin-validate-string
原文对照：https://npmcn.com/package/%40flatfile/plugin-validate-string/?lang=original
项目主页：https://github.com/FlatFilers/flatfile-plugins#readme
源码仓库：https://github.com/FlatFilers/flatfile-plugins

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

- 包体积（解压后）：42.6 kB，12 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>= 18
- 运行依赖：1 个
- peer 依赖：@flatfile/listener ^1\.1\.0
- 首次发布：2024-10-09T19:53:45.163Z
- 最新版本发布：2025-01-10T15:27:22.282Z
- 近 30 天下载量：2798（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 0 个）

## 中文简介

用于字符串配置和验证的平面文件插件

## 安装

```sh
npm install @flatfile/plugin-validate-string
```

也可以使用：`pnpm add @flatfile/plugin-validate-string`、`yarn add @flatfile/plugin-validate-string`、`bun add @flatfile/plugin-validate-string`

## README

这个 `@flatfile/plugin-validate-string` 用于字符串配置和验证的插件。 这个插件将多个字符串验证组合在一个单一的配置中,包括regex模式匹配,长度验证,大小写灵敏度,裁剪选项,以及自定义转换等.

**事件类型 :** `listener.on('commit:created')`

## 特征

-   正则表达式模式匹配
-   长度验证( 最小、 最大、 准确)
-   案件类型强制执行(小写、大写、标题)
-   白空间修剪( 领跑, 跟踪)
-   自定义转换函数
-   可配置错误消息
-   电子邮件、电话和 URL 验证常见的正则图案
-   空字符串处理

## 安装

要安装插件, 请使用 npm :

```bash
npm install @flatfile/plugin-validate-string
```

## 示例使用

```typescript
import { FlatfileListener } from '@flatfile/listener';
import { validateString } from '@flatfile/plugin-validate-string';

const listener = new FlatfileListener();

const stringConfig = {
  fields: ['name'],
  minLength: 2,
  maxLength: 50,
  caseType: 'titlecase',
  errorMessages: {
    length: 'Name must be between 2 and 50 characters',
    case: 'Name must be in Title Case',
  },
  
};

listener.use(validateString(stringConfig));
```

**模式用法 :**

```typescript
const config = {
  fields: ['email'],
  pattern: 'email' // Uses predefined email pattern
};

// Or with a custom pattern:
const customConfig = {
  fields: ['customField'],
  pattern: /^[A-Z]{3}-\d{2}$/ // Custom pattern for format like 'ABC-12'
};
```

## 配置

这个 `validateString` 接受一个 `StringValidationConfig` 具有下列属性的对象:

-   `fields`: 字符串\[\] - 要验证的字段
-   `sheetSlug`: 字符串 - 要验证的工作表 sattle (默认为“ \*\*” 所有工作表)
-   `pattern`: RegExp - 匹配的正则表达式模式
-   `pattern`: keyof type of common RegexPatterns QQ RegExp - 一个正则表达式模式相匹配. 您可以使用一个预定义的模式( “ 电子邮件 ” 、 “ 电话 ” 、 “ URL ” ) 或提供自定义 RegExp 。 预定义的模式有:
    -   `email`: 验证电子邮件地址
    -   `phone`: 验证电话号码( 10-14个数字, 可选“ +” 前缀)
    -   `url`: 验证 URL( 有无协议)
-   `minLength`: 数字 - 字符串最小长度
-   `maxLength`: 数字 - 字符串的最大长度
-   `exactLength`: 数字 - 精确要求字符串长度
-   `caseType`: “ 小写” QQ“ 上写” QQ“ 标题” - 执行特定大小写类型
-   `trim`:{领导? :布尔, 跟踪? :布尔} - Trims whitespace
-   `emptyStringAllowed`: 布尔 - 是否允许空字符串
-   `errorMessages`: 具有自定义错误消息的用于不同校验对象

## 行为

插件在 Flatfile 导入中处理每个记录, 将配置的验证应用到指定的字段 。 如果验证失败,该字段的记录会增加一个错误。 如果指定了自定义的转换并全部验证通过,则为字段设定了转换值.

该插件使用 `recordHook` 处理单个记录,允许在导入过程中对字符串字段进行有效而灵活的验证和转换.

## 常见问题

### @flatfile/plugin-validate-string 是什么？

用于字符串配置和验证的平面文件插件

### 如何安装 @flatfile/plugin-validate-string？

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

### @flatfile/plugin-validate-string 支持 TypeScript 吗？

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

### @flatfile/plugin-validate-string 支持 ESM 还是 CommonJS？

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

### @flatfile/plugin-validate-string 需要什么版本的 Node\.js？

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

### @flatfile/plugin-validate-string 可以商用吗？

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

### @flatfile/plugin-validate-string 的下载量有多少？

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

### @flatfile/plugin-validate-string 还在维护吗？

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