chore(ci): check that docs are up to date in ci

When we accidentally edit the auto-generated portions of the docs, this
will catch the error and cause CI to fail.

Later phase automated safety check that the early-stage human commenting
in the last commit also addresses.

Re: #3654
Re: #3630

PR-URL: https://github.com/npm/cli/pull/3655
Credit: @isaacs
Close: #3655
Reviewed-by: @nlf

1 files changed, 16 insertions, 0 deletions

diff --git a/scripts/git-dirty.js b/scripts/git-dirty.js
new file mode 100644
index 000000000..4199768de
--- /dev/null
+++ b/scripts/git-dirty.js
@@ -0,0 +1,16 @@
+#!/usr/bin/env node
+const { spawnSync } = require('child_process')
+const changes = spawnSync('git', ['status', '--porcelain', '-uno'])
+const stdout = changes.stdout.toString('utf8')
+const stderr = changes.stderr.toString('utf8')
+const { status, signal } = changes
+console.log(stdout)
+console.error(stderr)
+if (status || signal) {
+  console.error({ status, signal })
+  process.exitCode = status || 1
+}
+if (stdout.trim() !== '')
+  throw new Error('git dirty')
+else
+  console.log('git clean')