git-raw-commits
Advanced tools
git-raw-commits - npm Package Compare versions
Comparing version
114
index.js
@@ -1,7 +0,5 @@ | ||
| 'use strict' | ||
| const dargs = require('dargs') | ||
| const execFile = require('child_process').execFile | ||
| const { Readable, Transform } = require('stream') | ||
| const { execFile } = require('child_process') | ||
| const split = require('split2') | ||
| const { Readable, Transform } = require('stream') | ||
@@ -13,2 +11,3 @@ const DELIMITER = '------------------------ >8 ------------------------' | ||
| execOpts.cwd = execOpts.cwd || process.cwd() | ||
| return execOpts | ||
@@ -22,18 +21,19 @@ } | ||
| 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]) | ||
| } | ||
@@ -46,55 +46,65 @@ | ||
| const readable = new Readable() | ||
| readable._read = function () {} | ||
| readable._read = () => {} | ||
| const gitOpts = normalizeGitOpts(rawGitOpts) | ||
| const execOpts = normalizeExecOpts(rawExecOpts) | ||
| const args = getGitArgs(gitOpts) | ||
| let isError = false | ||
| if (gitOpts.debug) { | ||
| gitOpts.debug('Your git-log command is:\ngit ' + args.join(' ')) | ||
| } | ||
| getGitArgs(gitOpts).then((args) => { | ||
| if (gitOpts.debug) { | ||
| gitOpts.debug('Your git-log command is:\ngit ' + args.join(' ')) | ||
| } | ||
| let isError = false | ||
| 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 | ||
| }) | ||
| const child = execFile('git', args, { | ||
| cwd: execOpts.cwd, | ||
| maxBuffer: Infinity | ||
| }) | ||
| child.stdout | ||
| .pipe(split(DELIMITER + '\n')) | ||
| .pipe( | ||
| new Transform({ | ||
| transform (chunk, enc, cb) { | ||
| readable.push(chunk) | ||
| isError = false | ||
| 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() | ||
| }, | ||
| flush (cb) { | ||
| setImmediate(function () { | ||
| if (!isError) { | ||
| readable.push(null) | ||
| readable.emit('close') | ||
| } | ||
| cb() | ||
| }) | ||
| } | ||
| }) | ||
| ) | ||
| cb() | ||
| }) | ||
| } | ||
| }) | ||
| ) | ||
| child.stderr | ||
| .pipe( | ||
| new Transform({ | ||
| objectMode: true, | ||
| highWaterMark: 16, | ||
| transform (chunk) { | ||
| isError = true | ||
| readable.emit('error', new Error(chunk)) | ||
| readable.emit('close') | ||
| } | ||
| }) | ||
| ) | ||
| }) | ||
| child.stderr | ||
| .pipe( | ||
| new Transform({ | ||
| objectMode: true, | ||
| highWaterMark: 16, | ||
| transform (chunk) { | ||
| isError = true | ||
| readable.emit('error', new Error(chunk)) | ||
| readable.emit('close') | ||
| } | ||
| }) | ||
| ) | ||
| return readable | ||
@@ -101,0 +111,0 @@ } |
| { | ||
| "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)", | ||
@@ -20,7 +20,7 @@ "bugs": { | ||
| "engines": { | ||
| "node": ">=14" | ||
| "node": ">=16" | ||
| }, | ||
| "files": [ | ||
| "index.js", | ||
| "cli.js" | ||
| "cli.mjs" | ||
| ], | ||
@@ -37,12 +37,9 @@ "keywords": [ | ||
| "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" | ||
| } | ||
| } |
@@ -62,5 +62,5 @@ # [![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] | ||
| Type: `string` | ||
| Type: `string` or `array` | ||
| Filter commits to the path provided. | ||
| Filter commits to the path(s) provided. | ||
@@ -67,0 +67,0 @@ ##### execOpts |
Improved metrics
- Total package byte prevSize
7859
6.1%- Lines of code
108
11.34%Dependency changes
+ Added
dargs@8.1.0(transitive)+ Added
meow@12.1.1(transitive)+ Added
split2@4.2.0(transitive)- Removed
@babel/code-frame@7.27.1(transitive)- Removed
@babel/helper-validator-identifier@7.27.1(transitive)- Removed
@types/minimist@1.2.5(transitive)- Removed
@types/normalize-package-data@2.4.4(transitive)- Removed
arrify@1.0.1(transitive)- Removed
camelcase@5.3.1(transitive)- Removed
camelcase-keys@6.2.2(transitive)- Removed
dargs@7.0.0(transitive)- Removed
decamelize@1.2.0(transitive)- Removed
decamelize-keys@1.1.1(transitive)- Removed
error-ex@1.3.2(transitive)- Removed
find-up@4.1.0(transitive)- Removed
function-bind@1.1.2(transitive)- Removed
hard-rejection@2.1.0(transitive)- Removed
hasown@2.0.2(transitive)- Removed
hosted-git-info@2.8.94.1.0(transitive)- Removed
indent-string@4.0.0(transitive)- Removed
inherits@2.0.4(transitive)- Removed
is-arrayish@0.2.1(transitive)- Removed
is-core-module@2.16.1(transitive)- Removed
is-plain-obj@1.1.0(transitive)- Removed
js-tokens@4.0.0(transitive)- Removed
json-parse-even-better-errors@2.3.1(transitive)- Removed
kind-of@6.0.3(transitive)- Removed
lines-and-columns@1.2.4(transitive)- Removed
locate-path@5.0.0(transitive)- Removed
lru-cache@6.0.0(transitive)- Removed
map-obj@1.0.14.3.0(transitive)- Removed
meow@8.1.2(transitive)- Removed
min-indent@1.0.1(transitive)- Removed
minimist-options@4.1.0(transitive)- Removed
normalize-package-data@2.5.03.0.3(transitive)- Removed
p-limit@2.3.0(transitive)- Removed
p-locate@4.1.0(transitive)- Removed
p-try@2.2.0(transitive)- Removed
parse-json@5.2.0(transitive)- Removed
path-exists@4.0.0(transitive)- Removed
path-parse@1.0.7(transitive)- Removed
picocolors@1.1.1(transitive)- Removed
quick-lru@4.0.1(transitive)- Removed
read-pkg@5.2.0(transitive)- Removed
read-pkg-up@7.0.1(transitive)- Removed
readable-stream@3.6.2(transitive)- Removed
redent@3.0.0(transitive)- Removed
resolve@1.22.10(transitive)- Removed
safe-buffer@5.2.1(transitive)- Removed
semver@5.7.27.7.2(transitive)- Removed
spdx-correct@3.2.0(transitive)- Removed
spdx-exceptions@2.5.0(transitive)- Removed
spdx-expression-parse@3.0.1(transitive)- Removed
spdx-license-ids@3.0.21(transitive)- Removed
split2@3.2.2(transitive)- Removed
string_decoder@1.3.0(transitive)- Removed
strip-indent@3.0.0(transitive)- Removed
supports-preserve-symlinks-flag@1.0.0(transitive)- Removed
trim-newlines@3.0.1(transitive)- Removed
type-fest@0.18.10.6.00.8.1(transitive)- Removed
util-deprecate@1.0.2(transitive)- Removed
validate-npm-package-license@3.0.4(transitive)- Removed
yallist@4.0.0(transitive)- Removed
yargs-parser@20.2.9(transitive)Updated
dargs@^8.0.0Updated
meow@^12.0.1Updated
split2@^4.0.0