feat: move log task to separate task builder

Author: steveukx

src/git.js

@@ -24,7 +24,6 @@ const {cleanWithOptionsTask, isCleanOptionsArray} = require('./lib/tasks/clean')
 const {commitTask} = require('./lib/tasks/commit');
 const {diffSummaryTask} = require('./lib/tasks/diff');
 const {fetchTask} = require('./lib/tasks/fetch');
-const {logTask, parseLogOptions} = require('./lib/tasks/log');
 const {moveTask} = require("./lib/tasks/move");
 const {pullTask} = require('./lib/tasks/pull');
 const {pushTagsTask} = require('./lib/tasks/push');
@@ -667,38 +666,6 @@ Git.prototype.exec = function (then) {
    return this._runTask(task);
 };
 
-/**
- * Show commit logs from `HEAD` to the first commit.
- * If provided between `options.from` and `options.to` tags or branch.
- *
- * Additionally you can provide options.file, which is the path to a file in your repository. Then only this file will be considered.
- *
- * To use a custom splitter in the log format, set `options.splitter` to be the string the log should be split on.
- *
- * Options can also be supplied as a standard options object for adding custom properties supported by the git log command.
- * For any other set of options, supply options as an array of strings to be appended to the git log command.
- */
-Git.prototype.log = function (options) {
-   const next = trailingFunctionArgument(arguments);
-
-   if (filterString(arguments[0]) && filterString(arguments[1])) {
-      return this._runTask(
-         configurationErrorTask(`git.log(string, string) should be replaced with git.log({ from: string, to: string })`),
-         next
-      );
-   }
-
-   const parsedOptions = parseLogOptions(
-      trailingOptionsArgument(arguments) || {},
-      filterArray(options) && options || []
-   );
-
-   return this._runTask(
-      logTask(parsedOptions.splitter, parsedOptions.fields, parsedOptions.commands),
-      next,
-   )
-};
-
 /**
  * Clears the queue of pending commands and returns the wrapper instance for chaining.
  *

src/lib/simple-git-api.ts

@@ -4,6 +4,7 @@ import { changeWorkingDirectoryTask } from './tasks/change-working-directory';
 import config from './tasks/config';
 import { hashObjectTask } from './tasks/hash-object';
 import { initTask } from './tasks/init';
+import log from './tasks/log';
 import { mergeTask } from './tasks/merge';
 import { pushTask } from './tasks/push';
 import { statusTask } from './tasks/status';
@@ -121,4 +122,4 @@ export class SimpleGitApi implements SimpleGitBase {
    }
 }
 
-Object.assign(SimpleGitApi.prototype, config());
+Object.assign(SimpleGitApi.prototype, config(), log());

src/lib/tasks/log.ts

@@ -1,12 +1,21 @@
 import { Options, StringTask } from '../types';
-import { LogResult } from '../../../typings';
+import { LogResult, SimpleGit } from '../../../typings';
 import {
    COMMIT_BOUNDARY,
    createListLogSummaryParser,
    SPLITTER,
    START_BOUNDARY
 } from '../parsers/parse-list-log-summary';
-import { appendTaskOptions } from '../utils';
+import {
+   appendTaskOptions,
+   filterArray,
+   filterString,
+   filterType,
+   trailingFunctionArgument,
+   trailingOptionsArgument
+} from '../utils';
+import { SimpleGitApi } from '../simple-git-api';
+import { configurationErrorTask } from './task';
 
 enum excludeOptions {
    '--pretty',
@@ -45,7 +54,13 @@ export type LogOptions<T = DefaultLogFields> = {
    to?: string;
 };
 
-function prettyFormat(format: {[key: string]: string | unknown}, splitter: string): [string[], string] {
+interface ParsedLogOptions {
+   fields: string[];
+   splitter: string;
+   commands: string[]
+}
+
+function prettyFormat(format: { [key: string]: string | unknown }, splitter: string): [string[], string] {
    const fields: string[] = [];
    const formatStr: string[] = [];
 
@@ -69,7 +84,7 @@ function userOptions<T>(input: T): Exclude<Omit<T, keyof typeof excludeOptions>,
    return output;
 }
 
-export function parseLogOptions<T extends Options>(opt: LogOptions<T> = {}, customArgs: string[] = []) {
+export function parseLogOptions<T extends Options>(opt: LogOptions<T> = {}, customArgs: string[] = []): ParsedLogOptions {
    const splitter = opt.splitter || SPLITTER;
    const format = opt.format || {
       hash: '%H',
@@ -91,7 +106,7 @@ export function parseLogOptions<T extends Options>(opt: LogOptions<T> = {}, cust
 
    const maxCount: number | undefined = (opt as any).n || (opt as any)['max-count'] || opt.maxCount;
    if (maxCount) {
-      command.push(`--max-count=${ maxCount }`);
+      command.push(`--max-count=${maxCount}`);
    }
 
    if (opt.from && opt.to) {
@@ -122,3 +137,27 @@ export function logTask<T>(splitter: string, fields: string[], customArgs: strin
       parser: createListLogSummaryParser(splitter, fields),
    };
 }
+
+export default function (): Pick<SimpleGit, 'log'> {
+   return {
+      log<T extends Options>(this: SimpleGitApi, ...rest: unknown[]) {
+         const next = trailingFunctionArgument(arguments);
+         const task = rejectDeprecatedSignatures(...rest) ||
+            createLogTask(parseLogOptions<T>(trailingOptionsArgument(arguments), filterType(arguments[0], filterArray)))
+
+         return this._runTask(task, next);
+      }
+   }
+
+   function createLogTask(options: ParsedLogOptions) {
+      return logTask(options.splitter, options.fields, options.commands);
+   }
+
+   function rejectDeprecatedSignatures(from?: unknown, to?: unknown) {
+      return (
+         filterString(from) &&
+         filterString(to) &&
+         configurationErrorTask(`git.log(string, string) should be replaced with git.log({ from: string, to: string })`)
+      );
+   }
+}

test/unit/log.spec.ts

@@ -1,11 +1,15 @@
+import { promiseError } from '@kwsites/promise-result';
 import { LogResult, SimpleGit } from 'typings';
 import {
    assertExecutedCommands,
    assertExecutedCommandsContains,
+   assertGitError,
+   assertNoExecutedTasks,
    closeWithSuccess,
    like,
    newSimpleGit
 } from './__fixtures__';
+import { TaskConfigurationError } from '../..'
 import {
    COMMIT_BOUNDARY,
    createListLogSummaryParser,
@@ -522,6 +526,12 @@ ${START_BOUNDARY}207601debebc170830f2921acf2b6b27034c3b1f::2016-01-03 15:50:58 +
    });
 
    describe('deprecations', () => {
+      it('rejects from and to as strings', async () => {
+         const queue = promiseError((git.log as any)('FROM', 'TO'));
+         assertGitError(await queue, 'should be replaced with', TaskConfigurationError);
+         assertNoExecutedTasks();
+      });
+
       it('supports ListLogSummary without generic type', async () => {
          const summary: Promise<LogResult> = git.log({from: 'from', to: 'to'});
          await closeWithSuccess();