@graphql-markdown/diff

中文文档
1.1.24发布于 2026/11/15MITTypeScriptESM + CJS构建来源已验证近 30 天下载 1.1万

检测 GraphQL 计划变化, 因此 GraphQL- Markdown 只能重生已改变的文件 .

中文使用文档
文档目录5 节
  1. 安装
  2. 使用量
  3. 比较方法
  4. 文档
  5. 许可证

@ graphql- markdown/ diff

Latest Version JSR GitHub License Technical Debt Coverage Mutation Score

图表QL- Markdown 的Schema 比较工具 。 检测是否 图QL 方案 自上一个文档生成以来, 已经发生了变化, 因此工具如 @graphql-markdown/core 可以在没有任何变化时跳过再生.

安装

npm install @graphql-markdown/diff

使用量

import { GraphQLFileLoader } from "@graphql-tools/graphql-file-loader";
import { checkSchemaChanges, CompareMethod } from "@graphql-markdown/diff";
import { loadSchema } from "@graphql-markdown/graphql";

const schema = await loadSchema("./schema.graphql", {
  loaders: [new GraphQLFileLoader()],
});

const hasChanged = await checkSchemaChanges(
  schema,
  "./docs",
  CompareMethod.DIFF,
);

if (!hasChanged) {
  console.log("Schema is unchanged, skipping documentation generation.");
}

比较方法

  • CompareMethod.DIFF 将打印的图案与保存的图案进行对比 schema.graphql 引用文件( 默认) .
  • CompareMethod.HASH 将SHA-256散列的印刷图案与节省的图案相比较 .schema 文档.
  • CompareMethod.FORCE ——总是报告变化,强迫再生.
  • CompareMethod.NONE ——总是报告没有变化,跳出再生.

文档

许可证

GraphQL-Markdown 软件包是100%的自由和开源软件,在 麻省理工学院许可证。 。 。 .

这个软件包是 树件如果你把它用于生产,那么我们要求你 给世界买一棵树 感谢我们的工作。 通过为"树地"森林做贡献,你们将为当地家庭创造就业机会并恢复野生动物栖息地.

版本与发布记录

@graphql-markdown/diff 共发布 41 个版本,首次发布于 2022/10/23;过去 12 个月发布了 11 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.1.24latest2026/11/151 天前
1.1.232026/10/3018 天前
1.1.222026/10/131 个月前
1.1.212026/10/101 个月前
1.1.202026/10/091 个月前
1.1.192026/09/181 个月前

关于 @graphql-markdown/diff 的常见问题

@graphql-markdown/diff 是什么?

检测 GraphQL 计划变化, 因此 GraphQL- Markdown 只能重生已改变的文件 .

如何安装 @graphql-markdown/diff?

在项目目录运行 npm install @graphql-markdown/diff,或使用 pnpm add / yarn add / bun add。

@graphql-markdown/diff 支持 TypeScript 吗?

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

@graphql-markdown/diff 支持 ESM 还是 CommonJS?

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

@graphql-markdown/diff 需要什么版本的 Node.js?

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

@graphql-markdown/diff 可以商用吗?

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

@graphql-markdown/diff 的下载量有多少?

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

@graphql-markdown/diff 还在维护吗?

最新版本 1.1.24 发布于 2026/11/15(1 天前);至今共发布 41 个版本,其中过去 12 个月发布了 11 个;首次发布于 2022/10/23。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。