@ graphql- markdown/ diff
图表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%的自由和开源软件,在 麻省理工学院许可证。 。 。 .
这个软件包是 树件如果你把它用于生产,那么我们要求你 给世界买一棵树 感谢我们的工作。 通过为"树地"森林做贡献,你们将为当地家庭创造就业机会并恢复野生动物栖息地.