@graphql-markdown/diff

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

Detects GraphQL schema changes so GraphQL-Markdown only regenerates documentation that changed.

原始使用文档
文档目录5 节
  1. Installation
  2. Usage
  3. Comparison methods
  4. Documentation
  5. License

@graphql-markdown/diff

Latest Version JSR GitHub License Technical Debt Coverage Mutation Score

Schema comparison utilities for GraphQL-Markdown. Detects whether a GraphQL schema has changed since the last documentation generation, so tools like @graphql-markdown/core can skip regeneration when nothing changed.

Installation

npm install @graphql-markdown/diff

Usage

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.");
}

Comparison methods

  • CompareMethod.DIFF — diffs the printed schema against a saved schema.graphql reference file (default).
  • CompareMethod.HASH — compares a SHA-256 hash of the printed schema against a saved .schema file.
  • CompareMethod.FORCE — always reports a change, forcing regeneration.
  • CompareMethod.NONE — always reports no change, skipping regeneration.

Documentation

License

GraphQL-Markdown packages are 100% free and open-source, under the MIT license.

This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest, you'll be creating employment for local families and restoring wildlife habitats.

版本与发布记录

@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 是什么?

Detects GraphQL schema changes so GraphQL-Markdown only regenerates documentation that changed.

如何安装 @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 和提交记录判断。