# @domscribe/react 中文文档

规范地址：https://npmcn.com/package/%40domscribe/react/

版本：0\.7\.0
npm 元数据更新时间：2026-10-27T19:41:41.552Z
中文译文更新时间：2026-11-12T15:51:01.142Z
软件包许可：未声明

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

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

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

- 包体积（解压后）：135 kB，61 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：3 个
- peer 依赖：vite ^5\.0\.0 \|\| ^6\.0\.0 \|\| ^7\.0\.0 \|\| ^8\.0\.0，react \>=16\.8\.0，webpack ^5\.0\.0
- 首次发布：2026-03-18T01:16:58.280Z
- 最新版本发布：2026-10-27T19:41:41.176Z
- 近 30 天下载量：140402（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 16 个）

## 中文简介

DOMLICS 的响应适配器

## 安装

```sh
npm install @domscribe/react
```

也可以使用：`pnpm add @domscribe/react`、`yarn add @domscribe/react`、`bun add @domscribe/react`

## README

# @ docritics/ react (英语)

多姆文斯的回放适配器——纤维行走,道具/状态取出,和捆绑插件.

## 安装

```bash
npm install -D @domscribe/react
```

## 维特

```ts
import { defineConfig } from 'vite';
import react from '@vitejs/plugin-react';
import { domscribe } from '@domscribe/react/vite';

export default defineConfig({
  plugins: [react(), domscribe()],
});
```

## 网络软件包

```js
const { DomscribeWebpackPlugin } = require('@domscribe/react/webpack');

// Add to plugins array + add webpack loader rule
// (see @domscribe/transform README for full webpack config)
```

## 插件选项

React 插件扩展了基础变换插件选项 `runtime` 财务报告和审定财务报表 `capture` 命名空间 :

```ts
interface DomscribeReactPluginOptions {
  // Base transform options
  include?: RegExp;
  exclude?: RegExp;
  debug?: boolean;
  relay?: { autoStart?: boolean; port?: number; host?: string };
  overlay?:
    | boolean
    | { initialMode?: 'collapsed' | 'expanded'; debug?: boolean };
  captureStyles?: boolean;

  // React-specific
  runtime?: DomscribeRuntimeOptions;
  capture?: DomscribeReactCaptureOptions;
}
```

### 样式抓取( RFC 0001)

`captureStyles: true` 启用带有一面旗的样式- 抓取级: 构建时间 `styleSource` 列表和运行时间中的归属 `componentStyles` 快照(computed-style limit + CSS自定义属性). 这个权力 造型意识代理工作流程—— `domscribe.query.bySource` 返回时 元素的解析样式,以及 `domscribe.verify.*` MCP 工具可以计算 编辑后,每个财产三角洲。 默认关闭于v.x. `runtime.captureStyles` 独立覆盖运行时间级 .

### 运行时间选项

| 选项 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| `phase` | `1 | 2` | `1` | 地物相门(第1阶段:道具/状态,第2阶段:事件/perf) |
| `redactPII` | `boolean` | `true` | 在捕获的数据中修改敏感值 |
| `blockSelectors` | `string[]` | `[]` | 将 CSS 选择者排除在捕获之外 |
| `serialization` | `SerializationConstraints` | `undefined` | 串行界限(最大深度、最大箭头、最大TotalBytes等) — 见 `@domscribe/runtime` 读取 |
| `captureStyles` | `boolean` | `false` | 运行时级别样式抓取( 设置时覆盖顶级旗帜) |
| `styleOptions` | `StyleCaptureOptions` | `undefined` | 样式抓取器调制( allowlist, maxCustomPropertys, maxBytes) |

### 抓取选项

| 选项 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| `strategy` | `'devtools' | 'fiber' | 'best-effort'` | `'best-effort'` | 捕捉策略. `devtools` 使用 React DevTools 钩(最可靠), `fiber` 直接进入纤维树(快), `best-effort` 尝试多种策略 |
| `maxTreeDepth` | `number` | `50` | 最大成份树深到穿行 |
| `includeWrappers` | `boolean` | `true` | 包含 HOC/memo/forward 组件 |
| `hookNameResolvers` | `Record<string, Record<number, string>>` | `undefined` | 将组件名称映射为钩索引为语义名称映射. 键是组件名称,值映射钩索引为名称. 已转换为 `Map<string, Map<number, string>>` 在运行时间. |

### 胡克州采掘业

反应适配器通过检查每个钩的结构来分类钩子 `memoizedState` 并应用智能提取:

-   **效果钩** (单位:千美元)`useEffect`, (中文(简体) ), `useLayoutEffect`已经 **不包括** 从捕获状态——它们只包含内部调度数据(`{tag, create, destroy, deps}`),而不是应用程序状态.
-   **备忘录/召回钩** (单位:千美元)`useMemo`, (中文(简体) ), `useCallback`仅返回 **缓存值** ——依赖数组被丢弃.
-   **参考钩** (单位:千美元)`useRef`)作为 `{current: value}`。 。 。 .
-   **国家/减少的钩子** (单位:千美元)`useState`, (中文(简体) ), `useReducer`)被俘虏为-s.

Hooks根据推断类型使用语义名称: `state_0`, (中文(简体) ), `ref_0`, (中文(简体) ), `memo_0`, (中文(简体) ), `unknown_0`。 。 。 .

## 子路径导出

-   `@domscribe/react/vite` ——带有回放适配器的Vite插件
-   `@domscribe/react/webpack` ——带回放适配器的Webpack插件
-   `@domscribe/react/auto-init` 自动启动模块

* * *

部分 [多写](https://github.com/patchorbit/domscribe) 单相机 驾照:麻省理工.

## 常见问题

### @domscribe/react 是什么？

DOMLICS 的响应适配器

### 如何安装 @domscribe/react？

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

### @domscribe/react 支持 TypeScript 吗？

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

### @domscribe/react 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

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

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

### @domscribe/react 可以商用吗？

@domscribe/react 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @domscribe/react 的下载量有多少？

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

### @domscribe/react 还在维护吗？

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