# @getbigger-io/prisma-fixtures-cli 中文文档

规范地址：https://npmcn.com/package/%40getbigger-io/prisma-fixtures-cli/

版本：2\.0\.1
npm 元数据更新时间：2022-07-25T18:58:22.861Z
中文译文更新时间：2026-11-16T05:56:54.412Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40getbigger-io/prisma-fixtures-cli
原文对照：https://npmcn.com/package/%40getbigger-io/prisma-fixtures-cli/?lang=original
项目主页：https://github.com/getbigger-io/prisma-fixtures#readme
源码仓库：https://github.com/getbigger-io/prisma-fixtures

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

- 包体积（解压后）：80.2 kB，82 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：17 个
- peer 依赖：@prisma/client ^2\.13\.1
- 首次发布：2021-01-01T09:12:19.423Z
- 最新版本发布：2022-07-25T18:58:22.749Z
- 近 30 天下载量：3225（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 0 个）

## 中文简介

Prisma2 Fixtures 加载器(由打字机-fixtures-cli所改编)

## 安装

```sh
npm install @getbigger-io/prisma-fixtures-cli
```

也可以使用：`pnpm add @getbigger-io/prisma-fixtures-cli`、`yarn add @getbigger-io/prisma-fixtures-cli`、`bun add @getbigger-io/prisma-fixtures-cli`

## README

# Prisma 固定装置 cli

[![CircleCI](https://circleci.com/gh/getbigger-io/prisma-fixtures.svg?style=svg)](https://circleci.com/gh/getbigger-io/prisma-fixtures) [![Version](https://img.shields.io/npm/v/prisma-fixtures-cli.svg?style=flat-square)](https://www.npmjs.com/package/prisma-fixtures-cli) [![License](https://img.shields.io/npm/l/prisma-fixtures-cli.svg?style=flat-square)](https://github.com/getbigger-io/prisma-fixtures/blob/master/LICENSE)

依赖 [伪造者.js](https://github.com/marak/Faker.js/),棱镜-固定-cli允许您在开发时创建一吨固定/假数据供使用 或测试您的项目。 它为你们提供了一些基本工具,使得在可读和易于编辑的条件下收集复杂数据变得非常容易 以便你们团队中的每一个人 在需要时可以调整固定装置.

这个软件包是从 [TypeorM 定型器 CLI](https://github.com/RobinCK/typeorm-fixtures) b. 致谢 作者 [罗宾克](https://github.com/RobinCK)。 。 。 .

## 目录

-   [安装](https://npmcn.com/package/%40getbigger-io/prisma-fixtures-cli/#readme-install)
-   [开发设置](https://npmcn.com/package/%40getbigger-io/prisma-fixtures-cli/#readme-development-setup)
-   [示例](https://npmcn.com/package/%40getbigger-io/prisma-fixtures-cli/#readme-example)
-   [创建固定线](https://npmcn.com/package/%40getbigger-io/prisma-fixtures-cli/#readme-creating-fixtures)
    -   [固定范围](https://npmcn.com/package/%40getbigger-io/prisma-fixtures-cli/#readme-fixture-ranges)
    -   [定点参考](https://npmcn.com/package/%40getbigger-io/prisma-fixtures-cli/#readme-fixture-reference)
    -   [固定列表](https://npmcn.com/package/%40getbigger-io/prisma-fixtures-cli/#readme-fixture-lists)
-   [处理关系](https://npmcn.com/package/%40getbigger-io/prisma-fixtures-cli/#readme-handling-relations)
-   [高级指南](https://npmcn.com/package/%40getbigger-io/prisma-fixtures-cli/#readme-advanced-guide)
    -   [参数](https://npmcn.com/package/%40getbigger-io/prisma-fixtures-cli/#readme-parameters)
    -   [Faker 数据](https://npmcn.com/package/%40getbigger-io/prisma-fixtures-cli/#readme-faker-data)
    -   [EJS 调制](https://npmcn.com/package/%40getbigger-io/prisma-fixtures-cli/#readme-ejs-templating)
    -   [装入处理器](https://npmcn.com/package/%40getbigger-io/prisma-fixtures-cli/#readme-load-processor)
-   [样本](https://npmcn.com/package/%40getbigger-io/prisma-fixtures-cli/#readme-samples)
-   [使用量](https://npmcn.com/package/%40getbigger-io/prisma-fixtures-cli/#readme-usage)

## 安装

#### 国家预防机制

```bash
npm install @getbigger-io/prisma-fixtures-cli --save-dev
```

#### 雅伦

```bash
yarn add @getbigger-io/prisma-fixtures-cli --dev
```

## 开发设置

```bash
# install dependencies
npm install

# build dist files
npm run build
```

## 示例

`fixtures/Comment.yml`

```yaml
entity: comment
items:
  comment{1..10}:
    fullName: '{{name.firstName}} {{name.lastName}}'
    email: '{{internet.email}}'
    text: '{{lorem.paragraphs}}'
    post: '@post*'
```

**说明**: 您的实体必须被命名为 Prisma 客户端中的相同名称, 例如: `client.<entityname>.create`.

`fixtures/Post.yml`

```yaml
entity: post
connectedFields: ['user'] # Use this to connect the user when creating the post
items:
  post1:
    title: '{{name.title}}'
    description: '{{lorem.paragraphs}}'
    user: '@user($current)'
  post2:
    title: '{{name.title}}'
    description: '{{lorem.paragraphs}}'
    user: '@user($current)'
```

`fixtures/User.yml`

```yaml
entity: User
connectedFields: ['profile'] # Use this to connect the user when creating the post
items:
  user1:
    firstName: '{{name.firstName}}'
    lastName: '{{name.lastName}}'
    email: '{{internet.email}}'
    profile: '@profile1'
  user2:
    firstName: '{{name.firstName}}'
    lastName: '{{name.lastName}}'
    email: '{{internet.email}}'
    profile: '@profile2'
```

`fixtures/Profile.yml`

```yaml
entity: profile
items:
  profile1:
    aboutMe: <%= ['about string', 'about string 2', 'about string 3'].join(", ") %>
    skype: skype-account>
    language: english
  profile2:
    aboutMe: <%= ['about string', 'about string 2', 'about string 3'].join(", ") %>
    skype: skype-account
    language: english
```

## 创建固定线

这个库最基本的功能是将平面的 Yaml 文件变成对象

```yaml
entity: user
items:
  user0:
    username: bob
    fullname: Bob
    birthDate: 1980-10-10
    email: bob@example.org
    favoriteNumber: 42

  user1:
    username: alice
    fullname: Alice
    birthDate: 1978-07-12
    email: alice@example.org
    favoriteNumber: 27
```

### 固定范围

第一步是让您创建许多对象的副本,以便去除 Yaml 文件的复制.

您可以在固定名称中定义一个范围:

```yaml
entity: user
items:
  user{1..10}:
    username: bob
    fullname: Bob
    birthDate: 1980-10-10
    email: bob@example.org
    favoriteNumber: 42
```

现在它将收集10个用户,其中ID用户1到用户10. 不错 但我们只有10个 名字、用户名和电子邮件 还不怎么漂亮.

### 定点参考

也可以指定一个参考,指以前创建的固定装置列表:

```yaml
entity: post
connectedFields: ['user'] # Use this to connect the user when creating the post
items:
  post1:
    title: 'Post title'
    description: 'Post description'
    user: '@user1'
```

### 固定列表

也可以指定一个数值列表,而不是一个范围:

```yaml
entity: post
connectedFields: ['user']
items:
  post{1..10}:
    title: 'Post title'
    description: 'Post description'
    user: '@user($current)'
```

如果是范围(例如用户{1.10}), `($current)` 将返回 1 用户, 2 用户等.

当前迭代可以作为字符串值 :

```yaml
entity: post
items:
  post{1..10}:
    title: 'Post($current)'
    description: 'Post description'
```

`Post($current)` 将返回员额1,员额2等.

您可以使用基本的数学操作符来突变此输出 :

```yaml
entity: post
items:
  post{1..10}:
    title: 'Post($current*100)'
    description: 'Post description'
```

`Post($current*100)` 将返回 Post 100 用于员额 1, Post 200 用于员额 2等.

## 处理关系

```yaml
entity: user
items:
  user1:
    # ...

entity: group
connectedFields: ['owner', 'members']
items:
  group1:
    name: '<{names.admin}>'
    owner: '@user1'
    members:
      - '@user2'
      - '@user3'

```

如果您想要创建十个用户和十个组, 并且每个用户拥有一个组, 您可以使用 `($current)` 当使用固定区域时,用每个迭代的当前编号替换:

```yaml
entity: user
items:
  user1:
    # ...

entity: group
connectedFields: ['owner', 'members']
items:
  group{1..10}:
    name: 'name'
    owner: '@user($current)'
    members:
      - '@user2'
      - '@user3'

```

如果您想要随机的用户而不是固定的用户,可以使用通配符定义引用:

```yaml
entity: user
items:
  user1:
    # ...

entity: group
connectedFields: ['owner', 'members']
items:
  group{1..10}:
    name: 'name'
    owner: '@user*'
    members:
      - '@user2'
      - '@user3'

```

或者说

```yaml
entity: user
items:
  user1:
    # ...

entity: group
connectedFields: ['owner', 'members']
items:
  group{1..10}:
    name: 'name'
    owner: '@user{1..2}' # @user1 or @user2
    members:
      - '@user2'
      - '@user3'

```

## 高级指南

### 参数

您可以设置全局参数, 这些参数将插入任何地方, 用于帮助可读性 。 例如:

```yaml
entity: group
connectedFields: ['owner', 'members']
parameters:
  names:
    admin: Admin
items:
  group1:
    name: '<{names.admin}>' # <--- set Admin
    owner: '@user1'
    members:
      - '@user2'
      - '@user3'
```

### Faker 数据

此图书馆与 [伪造者.js](https://github.com/marak/Faker.js/) 图书馆。 您可以使用 QQfoo 调用 Faker 数据提供者来收集随机数据 .

让我们把静态的bob用户变成随机的条目:

```yaml
entity: user
items:
  user{1..10}:
    username: '{{internet.userName}}'
    fullname: '{{name.firstName}} {{name.lastName}}'
    birthDate: '{{date.past}}'
    email: '{{internet.email}}'
    favoriteNumber: '{{random.number}}'
```

### EJS 调制

此图书馆与 [EJS (英语)](https://github.com/mde/ejs)

```yaml
entity: Profile
items:
  profile1:
    aboutMe: <%= ['about string', 'about string 2', 'about string 3'].join(", ") %>
    skype: skype-account>
    language: english
```

### 装入处理器

处理器允许您在对象被坚持之前和/或之后处理它们 。 处理者必须执行: `IProcessor`

```typescript
import { IProcessor } from '@getbigger-io/prisma-fixtures-cli';
```

以下是一个例子:

`processor/UserProcessor.ts`

```typescript
import { IProcessor } from '@getbigger-io/prisma-fixtures-cli';
import { User } from '@prisma/client';

export default class UserProcessor implements IProcessor<User> {
  preProcess(name: string, object: any): any {
    return { ...object, firstName: 'foo' };
  }
}
```

固定配置 `fixtures/user.yml`

```yaml
entity: user
processor: ../processor/UserProcessor
items:
  user1:
    firstName: '{{name.firstName}}'
    lastName: '{{name.lastName}}'
    email: '{{internet.email}}'
```

## 使用量

```
Usage: fixtures [options] <path> Fixtures folder/file path

Options:
  -v, --version              output the version number
  --require                  A list of additional modules. e.g. ts-node/register
  -d --debug                 Enable debug
  --databaseUrl              Overrides the DATABASE_URL env variable
  -h, --help                 output usage information
  --no-color                 Disable color
```

##### 需要多个额外的模块

如果一次使用多个模块(如ts-node和tsconfig-paths) 您有能力要求这些模块带有多个需要的旗帜。 例如:

```
fixtures ./fixtures --require=ts-node/register --require=tsconfig-paths/register --databaseUrl=file:./mydb.sqlite
```

### 程序装入固定装置

虽然 @ getbigger- io/ prisma- fixtures- cli 意在用作 CLI, 您仍然可以装入 在您的程序中通过 API 设置 .

例如,下面的代码片段会加载所有已存在于 `./fixtures` 目录 :

```typescript
import * as path from 'path';
import { Builder, fixturesIterator, Loader, Parser, Resolver } from '@getbigger-io/prisma-fixtures-cli';

const loadFixtures = async (fixturesPath: string) => {
  let connection;

  try {
    connection = await PrismaClient();
    await connection.$connect();

    const loader = new Loader();
    loader.load(path.resolve(fixturesPath));

    const resolver = new Resolver();
    const fixtures = resolver.resolve(loader.fixtureConfigs);
    const builder = new Builder(connection, new Parser());

    for (const fixture of fixturesIterator(fixtures)) {
      const entity = await builder.build(fixture);
      // use the entity if you need it
    }
  } catch (err) {
    throw err;
  } finally {
    if (connection) {
      await connection.$disconnect();
    }
  }
};

loadFixtures('./fixtures')
  .then(() => {
    console.log('Fixtures are successfully loaded.');
  })
  .catch(err => console.log(err));
```

## 样本

-   [棱镜固定-样本](https://github.com/getbigger-io/prisma-fixtures-sample)

## 贡献者

### 代码贡献者

这个项目的存在要归功于所有作出贡献的人[贡献](https://npmcn.com/package/%40getbigger-io/prisma-fixtures-cli/CONTRIBUTING.md)\[ \[ \] \[ \] \]. \].

麻省理工学院 [尼古拉斯·迈凯里](https://github.com/getbigger-io)

## 常见问题

### @getbigger-io/prisma-fixtures-cli 是什么？

Prisma2 Fixtures 加载器\(由打字机-fixtures-cli所改编\)

### 如何安装 @getbigger-io/prisma-fixtures-cli？

在项目目录运行 npm install @getbigger-io/prisma-fixtures-cli，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@prisma/client（^2\.13\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 fixtures，可以用 npx fixtures 直接运行。

### @getbigger-io/prisma-fixtures-cli 支持 TypeScript 吗？

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

### @getbigger-io/prisma-fixtures-cli 支持 ESM 还是 CommonJS？

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

### @getbigger-io/prisma-fixtures-cli 可以商用吗？

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

### @getbigger-io/prisma-fixtures-cli 的下载量有多少？

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

### @getbigger-io/prisma-fixtures-cli 还在维护吗？

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

