git-raw-commits 3.0.0 → 4.0.0

package/README.md

@@ -59,9 +59,9 @@ A function to get debug information.
 
 ##### gitOpts.path
 
-Type: `string`
+Type: `string` or `array`
 
-Filter commits to the path provided.
+Filter commits to the path(s) provided.
 
 ##### execOpts
 

package/{cli.js → cli.mjs}

@@ -1,18 +1,19 @@
 #!/usr/bin/env node
-'use strict'
-const meow = require('meow')
-const gitRawCommits = require('./')
+import meow from 'meow'
+import gitRawCommits from './index.js'
 
 const cli = meow(`
   Usage
     git-raw-commits [<git-log(1)-options>]
 
   Example
-    git-raw-commits --from HEAD~2 --to HEAD^`
-)
+    git-raw-commits --from HEAD~2 --to HEAD^
+`, {
+  importMeta: import.meta
+})
 
 gitRawCommits(cli.flags)
-  .on('error', function (err) {
+  .on('error', (err) => {
     process.stderr.write(err)
     process.exit(1)
   })

package/index.js

@@ -1,15 +1,14 @@
-'use strict'
 
-const dargs = require('dargs')
-const execFile = require('child_process').execFile
-const split = require('split2')
 const { Readable, Transform } = require('stream')
+const { execFile } = require('child_process')
+const split = require('split2')
 
 const DELIMITER = '------------------------ >8 ------------------------'
 
 function normalizeExecOpts (execOpts) {
   execOpts = execOpts || {}
   execOpts.cwd = execOpts.cwd || process.cwd()
+
   return execOpts
 }
 
@@ -18,22 +17,23 @@ function normalizeGitOpts (gitOpts) {
   gitOpts.format = gitOpts.format || '%B'
   gitOpts.from = gitOpts.from || ''
   gitOpts.to = gitOpts.to || 'HEAD'
+
   return gitOpts
 }
 
-function getGitArgs (gitOpts) {
+async function getGitArgs (gitOpts) {
+  const { default: dargs } = await import('dargs')
   const gitFormat = `--format=${gitOpts.format || ''}%n${DELIMITER}`
   const gitFromTo = [gitOpts.from, gitOpts.to].filter(Boolean).join('..')
-
   const gitArgs = ['log', gitFormat, gitFromTo]
     .concat(dargs(gitOpts, {
-      excludes: ['debug', 'from', 'to', 'format', 'path']
+      excludes: ['debug', 'from', 'to', 'format', 'path', 'ignore']
     }))
 
-  // allow commits to focus on a single directory
+  // allow commits to focus on specific directories.
   // this is useful for monorepos.
   if (gitOpts.path) {
-    gitArgs.push('--', gitOpts.path)
+    gitArgs.push('--', ...Array.isArray(gitOpts.path) ? gitOpts.path : [gitOpts.path])
   }
 
   return gitArgs
@@ -41,59 +41,69 @@ function getGitArgs (gitOpts) {
 
 function gitRawCommits (rawGitOpts, rawExecOpts) {
   const readable = new Readable()
-  readable._read = function () {}
+  readable._read = () => {}
 
   const gitOpts = normalizeGitOpts(rawGitOpts)
   const execOpts = normalizeExecOpts(rawExecOpts)
-  const args = getGitArgs(gitOpts)
-
-  if (gitOpts.debug) {
-    gitOpts.debug('Your git-log command is:\ngit ' + args.join(' '))
-  }
-
   let isError = false
 
-  const child = execFile('git', args, {
-    cwd: execOpts.cwd,
-    maxBuffer: Infinity
+  getGitArgs(gitOpts).then((args) => {
+    if (gitOpts.debug) {
+      gitOpts.debug('Your git-log command is:\ngit ' + args.join(' '))
+    }
+
+    const ignoreRegex = typeof gitOpts.ignore === 'string'
+      ? new RegExp(gitOpts.ignore)
+      : gitOpts.ignore
+    const shouldNotIgnore = ignoreRegex
+      ? chunk => !ignoreRegex.test(chunk.toString())
+      : () => true
+
+    const child = execFile('git', args, {
+      cwd: execOpts.cwd,
+      maxBuffer: Infinity
+    })
+
+    child.stdout
+      .pipe(split(DELIMITER + '\n'))
+      .pipe(
+        new Transform({
+          transform (chunk, enc, cb) {
+            isError = false
+            setImmediate(() => {
+              if (shouldNotIgnore(chunk)) {
+                readable.push(chunk)
+              }
+              cb()
+            })
+          },
+          flush (cb) {
+            setImmediate(() => {
+              if (!isError) {
+                readable.push(null)
+                readable.emit('close')
+              }
+
+              cb()
+            })
+          }
+        })
+      )
+
+    child.stderr
+      .pipe(
+        new Transform({
+          objectMode: true,
+          highWaterMark: 16,
+          transform (chunk) {
+            isError = true
+            readable.emit('error', new Error(chunk))
+            readable.emit('close')
+          }
+        })
+      )
   })
 
-  child.stdout
-    .pipe(split(DELIMITER + '\n'))
-    .pipe(
-      new Transform({
-        transform (chunk, enc, cb) {
-          readable.push(chunk)
-          isError = false
-
-          cb()
-        },
-        flush (cb) {
-          setImmediate(function () {
-            if (!isError) {
-              readable.push(null)
-              readable.emit('close')
-            }
-
-            cb()
-          })
-        }
-      })
-    )
-
-  child.stderr
-    .pipe(
-      new Transform({
-        objectMode: true,
-        highWaterMark: 16,
-        transform (chunk) {
-          isError = true
-          readable.emit('error', new Error(chunk))
-          readable.emit('close')
-        }
-      })
-    )
-
   return readable
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "git-raw-commits",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "Get raw git commits out of your repository using git-log(1)",
   "bugs": {
     "url": "https://github.com/conventional-changelog/conventional-changelog/issues"
@@ -17,11 +17,11 @@
   },
   "license": "MIT",
   "engines": {
-    "node": ">=14"
+    "node": ">=16"
   },
   "files": [
     "index.js",
-    "cli.js"
+    "cli.mjs"
   ],
   "keywords": [
     "git-raw-commits",
@@ -33,14 +33,11 @@
     "git-log"
   ],
   "dependencies": {
-    "dargs": "^7.0.0",
-    "meow": "^8.1.2",
-    "split2": "^3.2.2"
+    "dargs": "^8.0.0",
+    "meow": "^12.0.1",
+    "split2": "^4.0.0"
   },
   "bin": {
-    "git-raw-commits": "cli.js"
-  },
-  "scripts": {
-    "test-windows": "mocha --timeout 30000"
+    "git-raw-commits": "cli.mjs"
   }
 }