# @develar/schema-utils 中文文档

规范地址：https://npmcn.com/package/%40develar/schema-utils/

版本：2\.6\.5
npm 元数据更新时间：2022-04-05T04:04:30.420Z
中文译文更新时间：2026-11-12T02:39:47.055Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40develar/schema-utils
原文对照：https://npmcn.com/package/%40develar/schema-utils/?lang=original
项目主页：https://github.com/webpack/schema-utils
源码仓库：https://github.com/webpack/schema-utils

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

- 包体积（解压后）：72.2 kB，14 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>= 8\.9\.0
- 运行依赖：2 个
- 首次发布：2019-07-24T07:28:01.728Z
- 最新版本发布：2020-03-11T10:33:05.126Z
- 近 30 天下载量：7731375（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 0 个）

## 中文简介

网络包验证工具

## 安装

```sh
npm install @develar/schema-utils
```

也可以使用：`pnpm add @develar/schema-utils`、`yarn add @develar/schema-utils`、`bun add @develar/schema-utils`

## README

 [![](https://raw.githubusercontent.com/webpack-contrib/schema-utils/master/.github/assets/logo.png)](http://json-schema.org/)[![](https://webpack.js.org/assets/icon-square-big.svg)](https://github.com/webpack/webpack)

[![npm](https://img.shields.io/npm/v/schema-utils.svg)](https://npmjs.com/package/schema-utils) [![node](https://img.shields.io/node/v/schema-utils.svg)](https://nodejs.org/) [![deps](https://david-dm.org/webpack/schema-utils.svg)](https://david-dm.org/webpack/schema-utils) [![tests](https://dev.azure.com/webpack/schema-utils/_apis/build/status/webpack.schema-utils?branchName=master)](https://dev.azure.com/webpack/schema-utils/_build/latest?definitionId=9&branchName=master) [![coverage](https://codecov.io/gh/webpack/schema-utils/branch/master/graph/badge.svg)](https://codecov.io/gh/webpack/schema-utils) [![chat](https://badges.gitter.im/webpack/webpack.svg)](https://gitter.im/webpack/webpack) [![size](https://packagephobia.now.sh/badge?p=schema-utils)](https://packagephobia.now.sh/result?p=schema-utils)

# 计划图

用于加载器和插件中验证选项的软件包 .

## 开始

开始,你需要安装 `schema-utils`数字 :

```console
npm install schema-utils
```

## API 密码

**计划.json**

```json
{
  "type": "object",
  "properties": {
    "option": {
      "type": ["boolean"]
    }
  },
  "additionalProperties": false
}
```

```js
import schema from './path/to/schema.json';
import validate from 'schema-utils';

const options = { option: true };
const configuration = { name: 'Loader Name/Plugin Name/Name' };

validate(schema, options, configuration);
```

### `schema`

类型 : `String`

JSON计划.

简单的计划示例 :

```json
{
  "type": "object",
  "properties": {
    "name": {
      "description": "This is description of option.",
      "type": "string"
    }
  },
  "additionalProperties": false
}
```

### `options`

类型 : `Object`

带有选项的对象 .

```js
validate(
  schema,
  {
    name: 123,
  },
  { name: 'MyPlugin' }
);
```

### `configuration`

允许配置验证符 .

配置 `name` 财务报告和审定财务报表`baseDataPath` 通过 `title` 财产在计划. 例如:

```json
{
  "title": "My Loader options",
  "type": "object",
  "properties": {
    "name": {
      "description": "This is description of option.",
      "type": "string"
    }
  },
  "additionalProperties": false
}
```

用于 `baseDataPath` 选项,用于 `name` 选项. 根据上文的例子 `name` 选项等于 `My Loader`,则 `baseDataPath` 选项等于 `options`。 。 。 .

#### `name`

类型 : `Object` 默认 : `"Object"`

允许在验证错误中设置名称 .

```js
validate(schema, options, { name: 'MyPlugin' });
```

```shell
Invalid configuration object. MyPlugin has been initialised using a configuration object that does not match the API schema.
 - configuration.optionName should be a integer.
```

#### `baseDataPath`

类型 : `String` 默认 : `"configuration"`

允许在验证错误中设置基础数据路径.

```js
validate(schema, options, { name: 'MyPlugin', baseDataPath: 'options' });
```

```shell
Invalid options object. MyPlugin has been initialised using an options object that does not match the API schema.
 - options.optionName should be a integer.
```

#### `postFormatter`

类型 : `Function` 默认 : `undefined`

允许重塑错误 .

```js
validate(schema, options, {
  name: 'MyPlugin',
  postFormatter: (formattedError, error) => {
    if (error.keyword === 'type') {
      return `${formattedError}\nAdditional Information.`;
    }

    return formattedError;
  },
});
```

```shell
Invalid options object. MyPlugin has been initialized using an options object that does not match the API schema.
 - options.optionName should be a integer.
   Additional Information.
```

## 实例

**计划.json**

```json
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "test": {
      "anyOf": [
        { "type": "array" },
        { "type": "string" },
        { "instanceof": "RegExp" }
      ]
    },
    "transform": {
      "instanceof": "Function"
    },
    "sourceMap": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}
```

### `Loader`

```js
import { getOptions } from 'loader-utils';
import validateOptions from 'schema-utils';

import schema from 'path/to/schema.json';

function loader(src, map) {
  const options = getOptions(this) || {};

  validateOptions(schema, options, {
    name: 'Loader Name',
    baseDataPath: 'options',
  });

  // Code...
}

export default loader;
```

### `Plugin`

```js
import validateOptions from 'schema-utils';

import schema from 'path/to/schema.json';

class Plugin {
  constructor(options) {
    validateOptions(schema, options, {
      name: 'Plugin Name',
      baseDataPath: 'options',
    });

    this.options = options;
  }

  apply(compiler) {
    // Code...
  }
}

export default Plugin;
```

## 捐款

请花点时间来读一下我们的贡献准则 如果你还没有这样做.

[捐款](https://npmcn.com/package/%40develar/schema-utils/.github/CONTRIBUTING.md)

## 许可证

[麻省理工学院](https://npmcn.com/package/%40develar/schema-utils/LICENSE)

## 常见问题

### @develar/schema-utils 是什么？

网络包验证工具

### 如何安装 @develar/schema-utils？

在项目目录运行 npm install @develar/schema-utils，或使用 pnpm add / yarn add / bun add。

### @develar/schema-utils 支持 TypeScript 吗？

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

### @develar/schema-utils 支持 ESM 还是 CommonJS？

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

### @develar/schema-utils 需要什么版本的 Node\.js？

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

### @develar/schema-utils 可以商用吗？

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

### @develar/schema-utils 的下载量有多少？

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

### @develar/schema-utils 还在维护吗？

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