feat: add support for stdin JSON input (#135)

Co-authored-by: Jacob Smith <3012099+JakobJingleheimer@users.noreply.github.com>

Author: aduh95

bin/cmd.js

@@ -65,15 +65,21 @@ if (parsed.version) {
 if (!parsed.help && !args.length) { args.push('HEAD') }
 
 function load (sha, cb) {
-  try {
-    const parsed = new URL(sha)
-    return loadPatch(parsed, cb)
-  } catch (_) {
-    exec(`git show --quiet --format=medium ${sha}`, (err, stdout, stderr) => {
-      if (err) return cb(err)
-      cb(null, stdout.trim())
+  // Handle pre-parsed commit objects from stdin
+  if (typeof sha === 'object') {
+    return process.nextTick(() => {
+      cb(null, sha)
     })
   }
+
+  const parsed = URL.parse(sha)
+  if (parsed != null) {
+    return loadPatch(parsed, cb)
+  }
+  exec(`git show --quiet --format=medium ${sha}`, (err, stdout, stderr) => {
+    if (err) return cb(err)
+    cb(null, stdout.trim())
+  })
 }
 
 function loadPatch (uri, cb) {
@@ -121,7 +127,48 @@ if (parsed.list) {
   process.exit(0)
 }
 
-if (parsed.tap) {
+// Don't start processing if reading from stdin (handled in stdin.on('end'))
+if (args.length === 1 && args[0] === '-') {
+  const chunks = []
+  process.stdin.on('data', (chunk) => chunks.push(chunk))
+  process.stdin.on('end', () => {
+    try {
+      const input = Buffer.concat(chunks).toString('utf8')
+      const commits = JSON.parse(input)
+
+      if (!Array.isArray(commits)) {
+        throw new Error('Input must be an array')
+      }
+
+      // Replace args with the commit data directly
+      for (let i = 0; i < commits.length; i++) {
+        const commit = commits[i]
+        if (!commit.id || !commit.message) {
+          throw new Error('Each commit must have "id" and "message" properties')
+        }
+        args[i] = { sha: commit.id, ...commit }
+      }
+      run()
+    } catch (err) {
+      console.error('Error parsing JSON input:', err.message)
+      process.exit(1)
+    }
+  })
+  process.stdin.resume()
+} else {
+  run()
+}
+
+function run () {
+  if (!parsed.tap) {
+    v.on('commit', (c) => {
+      pretty(c.commit, c.messages, v)
+      commitRun()
+    })
+
+    commitRun()
+    return
+  }
   const tap = new Tap()
   tap.pipe(process.stdout)
   if (parsed.out) tap.pipe(fs.createWriteStream(parsed.out))
@@ -141,13 +188,6 @@ if (parsed.tap) {
   })
 
   tapRun()
-} else {
-  v.on('commit', (c) => {
-    pretty(c.commit, c.messages, v)
-    commitRun()
-  })
-
-  commitRun()
 }
 
 function tapRun () {

bin/usage.txt

@@ -1,6 +1,6 @@
 core-validate-commit - Validate the commit message for a particular commit in node core
 
-  usage: core-validate-commit [options] [sha[, sha]]
+  usage: core-validate-commit [options] [sha[, sha] | -]
 
   options:
     -h, --help                    show help and usage
@@ -26,3 +26,7 @@ core-validate-commit - Validate the commit message for a particular commit in no
     Passing a url to a specific sha on github:
 
     $ core-validate-commit https://api.github.com/repos/nodejs/node/git/commits/9e9d499b8be8ffc6050db25129b042507d7b4b02
+
+    Passing JSON from stdin (no git required):
+
+    $ echo '[{"id":"287bdab","message":"doc: update README"}]' | core-validate-commit -

test/cli-test.js

@@ -152,5 +152,211 @@ test('Test cli flags', (t) => {
     })
   })
 
+  t.test('test stdin with valid JSON', (tt) => {
+    const validCommit = {
+      id: '2b98d02b52',
+      message: 'stream: make null an invalid chunk to write in object mode\n\nthis harmonizes behavior between readable, writable, and transform\nstreams so that they all handle nulls in object mode the same way by\nconsidering them invalid chunks.\n\nPR-URL: https://github.com/nodejs/node/pull/6170\nReviewed-By: James M Snell <jasnell@gmail.com>\nReviewed-By: Matteo Collina <matteo.collina@gmail.com>'
+    }
+    const input = JSON.stringify([validCommit])
+
+    const ls = spawn('./bin/cmd.js', ['-'])
+    let compiledData = ''
+    let errorData = ''
+
+    ls.stdout.on('data', (data) => {
+      compiledData += data
+    })
+
+    ls.stderr.on('data', (data) => {
+      errorData += data
+    })
+
+    ls.stdin.write(input)
+    ls.stdin.end()
+
+    ls.on('close', (code) => {
+      tt.equal(code, 0, 'CLI exits with zero code on success')
+      tt.match(compiledData, /[^0-9a-f]2b98d02b52[^0-9a-f]/, 'output contains commit id')
+      tt.equal(errorData, '', 'no error output')
+      tt.end()
+    })
+  })
+
+  t.test('test stdin with invalid commit (missing subsystem)', (tt) => {
+    const invalidCommit = {
+      id: 'def456',
+      message: 'this is a bad commit message without subsystem\n\nPR-URL: https://github.com/nodejs/node/pull/1234\nReviewed-By: Someone <someone@example.com>'
+    }
+    const input = JSON.stringify([invalidCommit])
+
+    const ls = spawn('./bin/cmd.js', ['-'])
+    let compiledData = ''
+
+    ls.stdout.on('data', (data) => {
+      compiledData += data
+    })
+
+    ls.stdin.write(input)
+    ls.stdin.end()
+
+    ls.on('close', (code) => {
+      tt.notEqual(code, 0, 'CLI exits with non-zero code on failure')
+      tt.match(compiledData, /def456/, 'output contains commit id')
+      tt.match(compiledData, /title-format/, 'output mentions the rule violation')
+      tt.end()
+    })
+  })
+
+  t.test('test stdin with multiple commits', (tt) => {
+    const commits = [
+      {
+        id: 'commit1',
+        message: 'doc: update README\n\nPR-URL: https://github.com/nodejs/node/pull/1111\nReviewed-By: Someone <someone@example.com>'
+      },
+      {
+        id: 'commit2',
+        message: 'test: add new test case\n\nPR-URL: https://github.com/nodejs/node/pull/2222\nReviewed-By: Someone <someone@example.com>'
+      }
+    ]
+    const input = JSON.stringify(commits)
+
+    const ls = spawn('./bin/cmd.js', ['-'])
+    let compiledData = ''
+
+    ls.stdout.on('data', (data) => {
+      compiledData += data
+    })
+
+    ls.stdin.write(input)
+    ls.stdin.end()
+
+    ls.on('close', (code) => {
+      tt.equal(code, 0, 'CLI exits with zero code on success')
+      tt.match(compiledData, /commit1/, 'output contains first commit id')
+      tt.match(compiledData, /commit2/, 'output contains second commit id')
+      tt.end()
+    })
+  })
+
+  t.test('test stdin with TAP output', (tt) => {
+    const validCommit = {
+      id: '69435db261',
+      message: 'chore: update tested node release lines (#94)'
+    }
+    const input = JSON.stringify([validCommit])
+
+    const ls = spawn('./bin/cmd.js', ['--no-validate-metadata', '--tap', '-'])
+    let compiledData = ''
+
+    ls.stdout.on('data', (data) => {
+      compiledData += data
+    })
+
+    ls.stdin.write(input)
+    ls.stdin.end()
+
+    ls.on('close', (code) => {
+      const output = compiledData.trim()
+      tt.match(output,
+        /# 69435db261/,
+        'TAP output contains the sha of the commit being linted')
+      tt.match(output,
+        /not ok \d+ subsystem: Invalid subsystem: "chore" \(chore: update tested node release lines \(#94\)\)/,
+        'TAP output contains failure for subsystem')
+      tt.match(output,
+        /# fail\s+\d+/,
+        'TAP output contains total failures')
+      tt.match(output,
+        /# Please review the commit message guidelines:\s# https:\/\/github.com\/nodejs\/node\/blob\/HEAD\/doc\/contributing\/pull-requests.md#commit-message-guidelines/,
+        'TAP output contains pointer to commit message guidelines')
+      tt.equal(code, 1, 'CLI exits with non-zero code on failure')
+      tt.end()
+    })
+  })
+
+  t.test('test stdin with invalid JSON', (tt) => {
+    const input = 'this is not valid JSON'
+
+    const ls = spawn('./bin/cmd.js', ['-'])
+    let errorData = ''
+
+    ls.stderr.on('data', (data) => {
+      errorData += data
+    })
+
+    ls.stdin.write(input)
+    ls.stdin.end()
+
+    ls.on('close', (code) => {
+      tt.equal(code, 1, 'CLI exits with non-zero code on error')
+      tt.match(errorData, /Error parsing JSON input/, 'error message is shown')
+      tt.end()
+    })
+  })
+
+  t.test('test stdin with non-array JSON', (tt) => {
+    const input = JSON.stringify({ id: 'test', message: 'test' })
+
+    const ls = spawn('./bin/cmd.js', ['-'])
+    let errorData = ''
+
+    ls.stderr.on('data', (data) => {
+      errorData += data
+    })
+
+    ls.stdin.write(input)
+    ls.stdin.end()
+
+    ls.on('close', (code) => {
+      tt.equal(code, 1, 'CLI exits with non-zero code on error')
+      tt.match(errorData, /Input must be an array/, 'error message is shown')
+      tt.end()
+    })
+  })
+
+  t.test('test stdin with missing properties', (tt) => {
+    const input = JSON.stringify([{ id: 'test' }]) // missing 'message'
+
+    const ls = spawn('./bin/cmd.js', ['-'])
+    let errorData = ''
+
+    ls.stderr.on('data', (data) => {
+      errorData += data
+    })
+
+    ls.stdin.write(input)
+    ls.stdin.end()
+
+    ls.on('close', (code) => {
+      tt.equal(code, 1, 'CLI exits with non-zero code on error')
+      tt.match(errorData, /must have "id" and "message" properties/, 'error message is shown')
+      tt.end()
+    })
+  })
+
+  t.test('test stdin with --no-validate-metadata', (tt) => {
+    const commit = {
+      id: 'novalidate',
+      message: 'doc: update README\n\nThis commit has no PR-URL or reviewers'
+    }
+    const input = JSON.stringify([commit])
+
+    const ls = spawn('./bin/cmd.js', ['--no-validate-metadata', '-'])
+    let compiledData = ''
+
+    ls.stdout.on('data', (data) => {
+      compiledData += data
+    })
+
+    ls.stdin.write(input)
+    ls.stdin.end()
+
+    ls.on('close', (code) => {
+      tt.equal(code, 0, 'CLI exits with zero code when metadata validation is disabled')
+      tt.match(compiledData, /novalidate/, 'output contains commit id')
+      tt.end()
+    })
+  })
+
   t.end()
 })