git-raw-commits 4.0.0 → 5.0.0

package/README.md

@@ -1,101 +1,60 @@
-#  [![NPM version][npm-image]][npm-url] [![Build Status: Linux][travis-image]][travis-url] [![Build Status: Windows][appveyor-image]][appveyor-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage Status][coverage-image]][coverage-url]
+# git-raw-commits
 
-> Get raw git commits out of your repository using git-log(1)
+[![ESM-only package][package]][package-url]
+[![NPM version][npm]][npm-url]
+[![Node version][node]][node-url]
+[![Dependencies status][deps]][deps-url]
+[![Install size][size]][size-url]
+[![Build status][build]][build-url]
+[![Coverage status][coverage]][coverage-url]
 
+[package]: https://img.shields.io/badge/package-ESM--only-ffe536.svg
+[package-url]: https://nodejs.org/api/esm.html
 
-## Install
-
-```sh
-$ npm install --save git-raw-commits
-```
-
-
-## Usage
-
-```js
-var gitRawCommits = require('git-raw-commits');
-
-gitRawCommits(options)
-  .pipe(...);
-```
-
-
-## API
-
-### gitRawCommits(gitOpts, [execOpts])
-
-Returns a readable stream. Stream is split to break on each commit.
-
-#### gitOpts
-
-Type: `object`
-
-Please check the available options at http://git-scm.com/docs/git-log.
-**NOTE:** Single dash arguments are not supported because of https://github.com/sindresorhus/dargs/blob/master/index.js#L5.
-
-*NOTE*: for `<revision range>` we can also use `<from>..<to>` pattern, and this module has the following extra options for shortcut of this pattern:
-
-##### gitOpts.from
-
-Type: `string` Default: `''`
+[npm]: https://img.shields.io/npm/v/git-raw-commits.svg
+[npm-url]: https://npmjs.com/package/git-raw-commits
 
-##### gitOpts.to
+[node]: https://img.shields.io/node/v/git-raw-commits.svg
+[node-url]: https://nodejs.org
 
-Type: `string` Default: `'HEAD'`
+[deps]: https://img.shields.io/librariesio/release/npm/git-raw-commits
+[deps-url]: https://libraries.io/npm/git-raw-commits/tree
 
-This module also have the following additions:
+[size]: https://packagephobia.com/badge?p=git-raw-commits
+[size-url]: https://packagephobia.com/result?p=git-raw-commits
 
-##### gitOpts.format
+[build]: https://img.shields.io/github/actions/workflow/status/conventional-changelog/conventional-changelog/tests.yaml?branch=master
+[build-url]: https://github.com/conventional-changelog/conventional-changelog/actions
 
-Type: `string` Default: `'%B'`
-
-Please check http://git-scm.com/docs/git-log for format options.
-
-##### gitOpts.debug
-
-Type: `function`
-
-A function to get debug information.
-
-##### gitOpts.path
-
-Type: `string` or `array`
-
-Filter commits to the path(s) provided.
-
-##### execOpts
-
-Options to pass to `git` `childProcess`
-
-Type: `object`
-
-##### execOpts.cwd
+[coverage]: https://coveralls.io/repos/github/conventional-changelog/conventional-changelog/badge.svg?branch=master
+[coverage-url]: https://coveralls.io/github/conventional-changelog/conventional-changelog?branch=master
 
-Type: `string`
+Get raw git commits out of your repository using git-log(1).
 
-Current working directory to execute git in
+## Install
 
+```bash
+# pnpm
+pnpm add git-raw-commits
+# yarn
+yarn add git-raw-commits
+# npm
+npm i git-raw-commits
+```
 
 ## CLI
 
-```sh
-$ npm install --global git-raw-commits
-$ git-raw-commits --help # for more details
+```bash
+# Example
+git-raw-commits --from HEAD~2 --to HEAD^
+# For more details
+git-raw-commits --help
 ```
 
+## API
+
+For JS API see [@conventional-changelog/git-client](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/git-client).
 
 ## License
 
 MIT © [Steve Mao](https://github.com/stevemao)
-
-
-[npm-image]: https://badge.fury.io/js/git-raw-commits.svg
-[npm-url]: https://npmjs.org/package/git-raw-commits
-[travis-image]: https://travis-ci.org/conventional-changelog/git-raw-commits.svg?branch=master
-[travis-url]: https://travis-ci.org/conventional-changelog/git-raw-commits
-[appveyor-image]: https://ci.appveyor.com/api/projects/status/4qm3bjmg41k3dsbv/branch/master?svg=true
-[appveyor-url]: https://ci.appveyor.com/project/stevemao/git-raw-commits/branch/master
-[daviddm-image]: https://david-dm.org/conventional-changelog/git-raw-commits.svg?theme=shields.io
-[daviddm-url]: https://david-dm.org/conventional-changelog/git-raw-commits
-[coverage-image]: https://coveralls.io/repos/github/conventional-changelog/conventional-changelog/badge.svg?branch=master
-[coverage-url]: https://coveralls.io/github/conventional-changelog/conventional-changelog?branch=master

package/package.json

@@ -1,28 +1,23 @@
 {
   "name": "git-raw-commits",
-  "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"
-  },
-  "homepage": "https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/git-raw-commits#readme",
+  "type": "module",
+  "version": "5.0.0",
+  "description": "Get raw git commits out of your repository using git-log(1).",
   "author": {
     "name": "Steve Mao",
     "email": "maochenyan@gmail.com",
     "url": "https://github.com/stevemao"
   },
+  "license": "MIT",
+  "homepage": "https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/git-raw-commits#readme",
   "repository": {
     "type": "git",
-    "url": "https://github.com/conventional-changelog/conventional-changelog.git"
+    "url": "https://github.com/conventional-changelog/conventional-changelog.git",
+    "directory": "packages/git-raw-commits"
   },
-  "license": "MIT",
-  "engines": {
-    "node": ">=16"
+  "bugs": {
+    "url": "https://github.com/conventional-changelog/conventional-changelog/issues"
   },
-  "files": [
-    "index.js",
-    "cli.mjs"
-  ],
   "keywords": [
     "git-raw-commits",
     "raw",
@@ -32,12 +27,18 @@
     "log",
     "git-log"
   ],
-  "dependencies": {
-    "dargs": "^8.0.0",
-    "meow": "^12.0.1",
-    "split2": "^4.0.0"
+  "engines": {
+    "node": ">=18"
   },
   "bin": {
-    "git-raw-commits": "cli.mjs"
+    "git-raw-commits": "./src/cli.js"
+  },
+  "exports": "./src/index.js",
+  "files": [
+    "src"
+  ],
+  "dependencies": {
+    "meow": "^13.0.0",
+    "@conventional-changelog/git-client": "^1.0.0"
   }
 }

package/src/cli.js

@@ -0,0 +1,37 @@
+#!/usr/bin/env node
+import { pipeline } from 'stream/promises'
+import meow from 'meow'
+import { getRawCommits } from './index.js'
+
+const cli = meow(`
+  Usage
+    git-raw-commits [<git-log(1)-options>]
+
+  Example
+    git-raw-commits --from HEAD~2 --to HEAD^
+`, {
+  importMeta: import.meta,
+  flags: {
+    ignore: {
+      type: 'string'
+    },
+    path: {
+      type: 'string',
+      isMultiple: true
+    },
+    from: {
+      type: 'string'
+    },
+    to: {
+      type: 'string'
+    },
+    format: {
+      type: 'string'
+    }
+  }
+})
+
+await pipeline(
+  getRawCommits(cli.flags),
+  process.stdout
+)

package/src/index.js

@@ -0,0 +1,59 @@
+import { Readable } from 'stream'
+import { GitClient } from '@conventional-changelog/git-client'
+
+function getFinalOptions (options = {}) {
+  const finalOptions = {
+    cwd: process.cwd(),
+    ...options
+  }
+
+  if (options.debug) {
+    finalOptions.debug = (args) => {
+      options.debug('Your git-log command is:\ngit ' + args.join(' '))
+    }
+  }
+
+  return finalOptions
+}
+
+/**
+ * Get raw commits from git-log.
+ * @param {*} options
+ * @param {string} [options.cwd=process.cwd()] - Current working directory to run git.
+ * @param {false | ((log: string) => void)} [options.debug=false] - A function to get debug information.
+ * @param {string | RegExp} [options.ignore] - Ignore commits that match provided string or RegExp.
+ * @param {string | string[]} [options.path] - Only commits that are modifying this path.
+ * @param {string} [options.from=''] - Starting commit reference or hash.
+ * @param {string} [options.to='HEAD'] - Ending commit reference or hash.
+ * @param {string} [options.format='%B'] - Format of the commit.
+ * @yields {string} - Raw commit.
+ */
+export async function * getRawCommits (options) {
+  const { cwd, debug, ...finalOptions } = getFinalOptions(options)
+  const client = new GitClient(cwd, debug)
+  let commit
+
+  if (typeof finalOptions.ignore === 'string') {
+    finalOptions.ignore = new RegExp(finalOptions.ignore)
+  }
+
+  for await (commit of client.getRawCommits(finalOptions)) {
+    yield commit
+  }
+}
+
+/**
+ * Get raw commits stream from git-log.
+ * @param {*} options
+ * @param {string} [options.cwd=process.cwd()] - Current working directory to run git.
+ * @param {false | ((log: string) => void)} [options.debug=false] - A function to get debug information.
+ * @param {string | RegExp} [options.ignore] - Ignore commits that match provided string or RegExp.
+ * @param {string | string[]} [options.path] - Only commits that are modifying this path.
+ * @param {string} [options.from=''] - Starting commit reference or hash.
+ * @param {string} [options.to='HEAD'] - Ending commit reference or hash.
+ * @param {string} [options.format='%B'] - Format of the commit.
+ * @returns {Readable} - Raw commits stream.
+ */
+export function getRawCommitsStream (options) {
+  return Readable.from(getRawCommits(options))
+}

package/cli.mjs

@@ -1,20 +0,0 @@
-#!/usr/bin/env node
-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^
-`, {
-  importMeta: import.meta
-})
-
-gitRawCommits(cli.flags)
-  .on('error', (err) => {
-    process.stderr.write(err)
-    process.exit(1)
-  })
-  .pipe(process.stdout)

package/index.js

@@ -1,110 +0,0 @@
-
-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
-}
-
-function normalizeGitOpts (gitOpts) {
-  gitOpts = gitOpts || {}
-  gitOpts.format = gitOpts.format || '%B'
-  gitOpts.from = gitOpts.from || ''
-  gitOpts.to = gitOpts.to || 'HEAD'
-
-  return 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', 'ignore']
-    }))
-
-  // allow commits to focus on specific directories.
-  // this is useful for monorepos.
-  if (gitOpts.path) {
-    gitArgs.push('--', ...Array.isArray(gitOpts.path) ? gitOpts.path : [gitOpts.path])
-  }
-
-  return gitArgs
-}
-
-function gitRawCommits (rawGitOpts, rawExecOpts) {
-  const readable = new Readable()
-  readable._read = () => {}
-
-  const gitOpts = normalizeGitOpts(rawGitOpts)
-  const execOpts = normalizeExecOpts(rawExecOpts)
-  let isError = false
-
-  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')
-          }
-        })
-      )
-  })
-
-  return readable
-}
-
-module.exports = gitRawCommits