Pr/1047 (#1049)

* Allow passing repeated flags to git commands

* Add changeset

* Add options as array example to README

* Filter options as array with `filterPrimitives`

* Simplify with a for-of

* Fix log.ts

* Format

* Update `@types/node`, remove the `typescript` resolution override, target es2018 to cater for new regexp format.
Update numstat and abort integration tests to be more robust

---------

Co-authored-by: Felipe Santos <[email protected]>

Author: steveukx

.changeset/tame-zoos-search.md

@@ -0,0 +1,5 @@
+---
+'simple-git': minor
+---
+
+Allow repeating git options like `{'--opt': ['value1', 'value2']}`

package.json

@@ -7,7 +7,6 @@
     "simple-git"
   ],
   "resolutions": {
-    "typescript": "4.7.4",
     "jest": "29.7.0"
   },
   "scripts": {

packages/test-typescript-consumer/package.json

@@ -25,6 +25,7 @@
     "directory": "packages/test-typescript-consumer"
   },
   "devDependencies": {
-    "jest": "^29.7.0"
+    "jest": "^29.7.0",
+    "typescript": "^5.7.3"
   }
 }

simple-git/package.json

@@ -23,7 +23,7 @@
     "@simple-git/babel-config": "^1.0.0",
     "@types/debug": "^4.1.12",
     "@types/jest": "^29.2.2",
-    "@types/node": "^22.13.5",
+    "@types/node": "^22.15.30",
     "esbuild": "^0.25.0",
     "esbuild-node-externals": "^1.18.0",
     "jest": "^29.7.0",

simple-git/readme.md

@@ -436,6 +436,14 @@ git.pull('origin', 'master', { '--no-rebase': null });
 git.pull('origin', 'master', { '--rebase': 'true' });
 ```
 
+When the value of the property is an array of `string`s or `number`s, each element will be 
+included as separate `name=value` pairs:
+
+```javascript
+// results in 'git log --grep=bug --grep=fix --grep=feature'
+git.log({ '--grep': ['bug', 'fix', 'feature'] });
+```
+
 ### Options as an Array
 
 Options can also be supplied as an array of strings to be merged into the task's commands

simple-git/src/lib/tasks/log.ts

@@ -11,7 +11,7 @@ import {
 import {
    appendTaskOptions,
    filterArray,
-   filterPrimitives,
+   filterPlainObject,
    filterString,
    filterType,
    trailingFunctionArgument,
@@ -95,18 +95,17 @@ export function parseLogOptions<T extends Options>(
    customArgs: string[] = []
 ): ParsedLogOptions {
    const splitter = filterType(opt.splitter, filterString, SPLITTER);
-   const format =
-      !filterPrimitives(opt.format) && opt.format
-         ? opt.format
-         : {
-              hash: '%H',
-              date: opt.strictDate === false ? '%ai' : '%aI',
-              message: '%s',
-              refs: '%D',
-              body: opt.multiLine ? '%B' : '%b',
-              author_name: opt.mailMap !== false ? '%aN' : '%an',
-              author_email: opt.mailMap !== false ? '%aE' : '%ae',
-           };
+   const format = filterPlainObject(opt.format)
+      ? opt.format
+      : {
+           hash: '%H',
+           date: opt.strictDate === false ? '%ai' : '%aI',
+           message: '%s',
+           refs: '%D',
+           body: opt.multiLine ? '%B' : '%b',
+           author_name: opt.mailMap !== false ? '%aN' : '%an',
+           author_email: opt.mailMap !== false ? '%aE' : '%ae',
+        };
 
    const [fields, formatStr] = prettyFormat(format, splitter);
 

simple-git/src/lib/types/index.ts

@@ -17,7 +17,7 @@ export type TaskOptions<O extends Options = Options> = string[] | O;
 /**
  * Options supplied in most tasks as an optional trailing object
  */
-export type OptionsValues = null | string | number;
+export type OptionsValues = null | string | number | (string | number)[];
 export type Options = Record<string, OptionsValues>;
 
 export type OptionFlags<FLAGS extends string, VALUE = null> = Partial<Record<FLAGS, VALUE>>;

simple-git/src/lib/utils/task-options.ts

@@ -6,7 +6,7 @@ import {
    filterType,
 } from './argument-filters';
 import { asFunction, isUserFunction, last } from './util';
-import { Maybe, Options, OptionsValues } from '../types';
+import { Maybe, Options } from '../types';
 import { isPathSpec } from '../args/pathspec';
 
 export function appendTaskOptions<T extends Options = Options>(
@@ -18,12 +18,18 @@ export function appendTaskOptions<T extends Options = Options>(
    }
 
    return Object.keys(options).reduce((commands: string[], key: string) => {
-      const value: OptionsValues = options[key];
+      const value = options[key];
 
       if (isPathSpec(value)) {
          commands.push(value);
       } else if (filterPrimitives(value, ['boolean'])) {
          commands.push(key + '=' + value);
+      } else if (Array.isArray(value)) {
+         for (const v of value) {
+            if (!filterPrimitives(v, ['string', 'number'])) {
+               commands.push(key + '=' + v);
+            }
+         }
       } else {
          commands.push(key);
       }

simple-git/src/lib/utils/util.ts

@@ -1,16 +1,22 @@
+import { Buffer } from 'node:buffer';
 import { exists, FOLDER } from '@kwsites/file-exists';
 import { Maybe } from '../types';
 
+type Callable = (...args: unknown[]) => unknown;
+
 export const NULL = '\0';
 
-export const NOOP: (...args: any[]) => void = () => {};
+export const NOOP: Callable = () => {};
 
 /**
  * Returns either the source argument when it is a `Function`, or the default
  * `NOOP` function constant
  */
-export function asFunction<T extends () => any>(source: T | any): T {
-   return typeof source === 'function' ? source : NOOP;
+export function asFunction<T>(source: T | unknown): Callable {
+   if (typeof source !== 'function') {
+      return NOOP;
+   }
+   return source as Callable;
 }
 
 /**

simple-git/test/integration/log-numstat.spec.ts

@@ -20,7 +20,7 @@ describe('log-numstat', function () {
             ae: '%ae',
          },
          '--all': null,
-         '--since': '2024-02-04',
+         '--since': '2025-01-01',
          '--numstat': null,
       });