From 9c3618d66550b7a72cade402b035ecdbcb485625 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Wed, 1 Feb 2023 22:33:15 +0100 Subject: infra(docs): add docs diff script (#1755) --- scripts/diff.ts | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 scripts/diff.ts (limited to 'scripts/diff.ts') diff --git a/scripts/diff.ts b/scripts/diff.ts new file mode 100644 index 00000000..09a07046 --- /dev/null +++ b/scripts/diff.ts @@ -0,0 +1,30 @@ +import { existsSync } from 'node:fs'; +import { argv } from 'node:process'; +import { diff } from './apidoc/diff'; +import { pathDocsDiffIndexFile } from './apidoc/utils'; + +const [target, source] = argv.slice(2); + +if (!source && !existsSync(pathDocsDiffIndexFile)) { + throw new Error( + `Unable to find local diff index file at: ${pathDocsDiffIndexFile}\n + You can run \`pnpm run generate:api-docs\` to generate it.` + ); +} + +diff(target, source) + .then((delta) => { + if (Object.keys(delta).length === 0) { + console.log('No documentation changes detected'); + return; + } + + console.log('Documentation changes detected:'); + for (const [module, methods] of Object.entries(delta)) { + console.log(`- ${module}`); + for (const method of methods) { + console.log(` - ${method}`); + } + } + }) + .catch(console.error); -- cgit v1.2.3