# @email-lint/react-email 中文文档

规范地址：https://npmcn.com/package/%40email-lint/react-email/

版本：0\.3\.0
npm 元数据更新时间：2026-09-09T18:08:00.030Z
中文译文更新时间：2026-11-13T14:32:02.784Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40email-lint/react-email
原文对照：https://npmcn.com/package/%40email-lint/react-email/?lang=original
项目主页：https://github.com/stewartjarod/email-lint/tree/main/packages/react-email#readme
源码仓库：https://github.com/stewartjarod/email-lint

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

- 包体积（解压后）：8.4 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：1 个
- peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0，@react-email/render \>=1\.0\.0
- 首次发布：2026-04-13T18:37:48.988Z
- 最新版本发布：2026-09-09T18:07:59.782Z
- 近 30 天下载量：14982（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

Lint 反应-电子邮件组件,用于使用电子邮件-lint实现客户端兼容性.

## 安装

```sh
npm install @email-lint/react-email
```

也可以使用：`pnpm add @email-lint/react-email`、`yarn add @email-lint/react-email`、`bun add @email-lint/react-email`

## README

# @ email-lint/ react- 电子邮件

林特 [反应电子邮件](https://react.email/) 用于客户兼容的组件。 将您的组件渲染到 HTML 并对照 [邮件](https://www.caniemail.com/) 使用数据 [@ email-lint/ core (韩语)](https://www.npmjs.com/package/@email-lint/core)。 。 。 .

```ts
import { lintComponent } from '@email-lint/react-email';
import { Welcome } from './emails/welcome';

const result = await lintComponent(<Welcome name="Jane" />);

console.log(result.success);      // true
console.log(result.errorCount);   // 0
console.log(result.diagnostics);  // LintDiagnostic[]
```

## 安装

```sh
npm install @email-lint/react-email
```

同伴依赖性 : `react` 财务报告和审定财务报表 `@react-email/render`。 。 。 .

## API 密码

### `lintComponent(element, config?)`

通过 HTML 将反应元素渲染到 HTML `@react-email/render`,然后将其涂入 `email-lint`。 。 。 .

默认情况下启用了框架感知过滤 —— React Email 内部导致的诊断(审查文本块,预装图像标记,强制) `target="_blank"`)自动被压制. 过 `framework: undefined` 选择退出.

```ts
// Lint against specific clients
const result = await lintComponent(<Welcome />, { preset: 'gmail' });

// Disable framework filtering
const result = await lintComponent(<Welcome />, { framework: undefined });

// Keep suppressed diagnostics visible
const result = await lintComponent(<Welcome />, { showIgnored: true });
```

返回同样的 `LintResult` 类型为 `@email-lint/core` 看到了吗 [@ email-lint/ 核心文档](https://www.npmjs.com/package/@email-lint/core) 用于完整类型参考.

## 用于测试

```ts
import { describe, it, expect } from 'vitest';
import { lintComponent } from '@email-lint/react-email';
import { Welcome } from './emails/welcome';

describe('email compatibility', () => {
  it('Welcome has no errors', async () => {
    const result = await lintComponent(<Welcome name="Jane" />);
    expect(result.errorCount).toBe(0);
  });

  it('Welcome passes Gmail checks', async () => {
    const result = await lintComponent(<Welcome name="Jane" />, { preset: 'gmail' });
    expect(result.success).toBe(true);
  });
});
```

## 许可证

麻省理工学院

## 常见问题

### @email-lint/react-email 是什么？

Lint 反应-电子邮件组件,用于使用电子邮件-lint实现客户端兼容性\.

### 如何安装 @email-lint/react-email？

在项目目录运行 npm install @email-lint/react-email，或使用 pnpm add / yarn add / bun add。

### @email-lint/react-email 支持 TypeScript 吗？

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

### @email-lint/react-email 支持 ESM 还是 CommonJS？

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

### @email-lint/react-email 需要什么版本的 Node\.js？

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

### @email-lint/react-email 可以商用吗？

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

### @email-lint/react-email 的下载量有多少？

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

### @email-lint/react-email 还在维护吗？

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