# @dozerg/require-module 中文文档

规范地址：https://npmcn.com/package/%40dozerg/require-module/

版本：0\.0\.10
npm 元数据更新时间：2025-07-31T21:56:04.210Z
中文译文更新时间：2026-11-12T18:13:00.108Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：6.3 kB，5 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2022-04-08T21:45:48.548Z
- 最新版本发布：2025-07-31T21:56:04.017Z
- 近 30 天下载量：17514（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 0 个）

## 中文简介

搜索并需要一个不会被网络包装的模块.

## 安装

```sh
npm install @dozerg/require-module
```

也可以使用：`pnpm add @dozerg/require-module`、`yarn add @dozerg/require-module`、`bun add @dozerg/require-module`

## README

# 需要模块

[![npm](https://img.shields.io/npm/v/@dozerg/require-module.svg)](https://www.npmjs.com/package/@dozerg/require-module) ![Downloads](https://img.shields.io/npm/dm/@dozerg/require-module.svg) [![Build Status](https://github.com/daidodo/require-module/actions/workflows/node.js.yml/badge.svg)](https://github.com/daidodo/require-module/actions)

搜索并需要一个不会被网络包装的模块.

# 使用量

```sh
npm i @dozerg/require-module
```

# APIs 密码

## `requireModule(moduleName: string, fromPath: string)`

从给定路径搜索并加载一个模块 .

如果没有找到, `undefined` 将返回.

```ts
import requireModule from '@dozerg/require-module';

const filePath = '/path/to/a/file.ts';

// Search and find Prettier for given source file.
const pt = requireModule('prettier', filePath);

if(pt === undefined) {
  console.log('Cannot find Prettier from given path.');
} else {
  // Resolve Prettier config for given source file.
  const config = await pt.resolveConfig(filePath);

  //...
}
```

当你用网络包装上面的代码时, `prettier` 其依附者,将不被集合.

运行时,上面的代码会尝试 `require('prettier')` 从 `filePath` 及其父目录, 其中 `node_modules/prettier` 可见.

## `requireModule(moduleName: string, fromPath: string, defaultModule: any)`

从给定路径搜索并加载一个模块 .

如果没有找到, `defaultModule` 将返回.

```ts
import prettier from 'prettier';
import requireModule from '@dozerg/require-module';

const filePath = '/path/to/a/file.ts';

// Search and find Prettier for given source file.
// If not found, use 'prettier' instead.
const pt = requireModule('prettier', filePath, prettier);

// Resolve Prettier config for given source file.
const config = await pt.resolveConfig(filePath);

//...
```

当你用网络包装上面的代码时, `prettier` 和它的依附者将被包装.

运行时,上面的代码会尝试 `require('prettier')` 从 `filePath` 及其父目录, 其中 `node_modules/prettier` 可见.

如果找不到, 包装 `prettier` 将被使用.

# 许可证

麻省理工学院 [达伊多多@gmail.com](mailto:daidodo@gmail.com)

## 常见问题

### @dozerg/require-module 是什么？

搜索并需要一个不会被网络包装的模块\.

### 如何安装 @dozerg/require-module？

在项目目录运行 npm install @dozerg/require-module，或使用 pnpm add / yarn add / bun add。

### @dozerg/require-module 支持 TypeScript 吗？

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

### @dozerg/require-module 支持 ESM 还是 CommonJS？

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

### @dozerg/require-module 可以商用吗？

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

### @dozerg/require-module 的下载量有多少？

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

### @dozerg/require-module 还在维护吗？

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