Rename report committers args to be more clear

herodevs · Aug 20, 2024 · 72a4836 · 72a4836
1 parent 18444a3
commit 72a4836
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 41 deletions.
diff --git a/libs/report/committers/src/lib/committers.spec.ts b/libs/report/committers/src/lib/committers.spec.ts
@@ -11,12 +11,12 @@ jest.mock('./parse-git-log-entries');
 jest.mock('./get-committer-counts');
 
 describe('reportCommittersCommand', () => {
-  let defaultStartDate: string;
-  let defaultEndDate: string;
+  let defaultBeforeDate: string;
+  let defaultAfterDate: string;
 
   beforeEach(() => {
-    defaultStartDate = format(new Date(), 'yyyy-MM-dd');
-    defaultEndDate = format(subMonths(new Date(), 12), 'yyyy-MM-dd');
+    defaultBeforeDate = format(new Date(), 'yyyy-MM-dd');
+    defaultAfterDate = format(subMonths(new Date(), 12), 'yyyy-MM-dd');
   });
 
   describe('metadata', () => {
@@ -37,13 +37,13 @@ describe('reportCommittersCommand', () => {
     it('should set start date as today', () => {
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       const builder = reportCommittersCommand.builder as any;
-      expect(builder.startDate.default).toEqual(defaultStartDate);
+      expect(builder.beforeDate.default).toEqual(defaultBeforeDate);
     });
 
     it('should set end date as 1 year ago', () => {
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       const builder = reportCommittersCommand.builder as any;
-      expect(builder.endDate.default).toEqual(defaultEndDate);
+      expect(builder.afterDate.default).toEqual(defaultAfterDate);
     });
 
     it('should not have a default value for exclude', () => {
@@ -66,36 +66,42 @@ describe('reportCommittersCommand', () => {
 
     it('should run the correct git command', () => {
       const args = {
-        startDate: defaultStartDate,
-        endDate: defaultEndDate,
+        beforeDate: defaultBeforeDate,
+        afterDate: defaultAfterDate,
       };
 
       runCommandMock.mockResolvedValue('');
 
-      const { startDate, endDate } = parseDateFlags(dateFormat, defaultStartDate, defaultEndDate);
+      const { beforeDate, afterDate } = parseDateFlags(
+        dateFormat,
+        defaultBeforeDate,
+        defaultAfterDate
+      );
 
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       reportCommittersCommand.handler(args as any);
 
-      const startDateEndOfDay = formatISO(addHours(addMinutes(addSeconds(startDate, 59), 59), 23));
+      const beforeDateEndOfDay = formatISO(
+        addHours(addMinutes(addSeconds(beforeDate, 59), 59), 23)
+      );
 
       expect(runCommandMock).toHaveBeenCalledWith(
-        `git log --since "${endDate}" --until "${startDateEndOfDay}" --pretty=format:"%hΓΓΓΓ%anΓΓΓΓ%ad" `
+        `git log --since "${afterDate}" --until "${beforeDateEndOfDay}" --pretty=format:"%hΓΓΓΓ%anΓΓΓΓ%ad" `
       );
     });
 
     it('should parse and organize the git committers', async () => {
       const args = {
-        startDate: defaultStartDate,
-        endDate: defaultEndDate,
+        beforeDate: defaultBeforeDate,
+        afterDate: defaultAfterDate,
       };
 
       runCommandMock.mockResolvedValue('a\nb');
       parseGitLogEntriesMock.mockReturnValue([
         {
           commitHash: 'hash',
           committer: 'testy',
-          date: defaultStartDate,
+          date: defaultBeforeDate,
         },
       ]);
       getCommitterCountsMock.mockReturnValue([
@@ -115,7 +121,7 @@ describe('reportCommittersCommand', () => {
         {
           commitHash: 'hash',
           committer: 'testy',
-          date: defaultStartDate,
+          date: defaultBeforeDate,
         },
       ]);
 

diff --git a/libs/report/committers/src/lib/committers.ts b/libs/report/committers/src/lib/committers.ts
@@ -8,8 +8,8 @@ import { ArgumentsCamelCase, CommandBuilder, CommandModule } from 'yargs';
 import { CommitterCount } from './types';
 
 interface Options {
-  startDate: string;
-  endDate: string;
+  beforeDate: string;
+  afterDate: string;
   exclude: string[];
   json: boolean;
   // monthly: boolean;
@@ -20,13 +20,13 @@ export const reportCommittersCommand: CommandModule<object, Options> = {
   describe: 'show git committers',
   aliases: ['git'],
   builder: {
-    startDate: {
+    beforeDate: {
       alias: 's',
       default: format(new Date(), dateFormat),
       describe: `Start Date (format: ${dateFormat})`,
       string: true,
     },
-    endDate: {
+    afterDate: {
       alias: 'e',
       describe: `End Date (format: ${dateFormat})`,
       required: false,
@@ -56,29 +56,20 @@ export const reportCommittersCommand: CommandModule<object, Options> = {
 };
 
 async function run(args: ArgumentsCamelCase<Options>): Promise<void> {
-  const { startDate, endDate } = parseDateFlags(dateFormat, args.startDate, args.endDate);
-  const startDateEndOfDay = formatISO(addHours(addMinutes(addSeconds(startDate, 59), 59), 23));
+  const { beforeDate, afterDate } = parseDateFlags(dateFormat, args.beforeDate, args.afterDate);
+  const beforeDateEndOfDay = formatISO(addHours(addMinutes(addSeconds(beforeDate, 59), 59), 23));
 
   const ignores = args.exclude && args.exclude.length ? `-- . "!(${args.exclude.join('|')})"` : '';
 
-  const gitCommand = `git log --since "${endDate}" --until "${startDateEndOfDay}" --pretty=format:${gitOutputFormat} ${ignores}`;
+  const gitCommand = `git log --since "${afterDate}" --until "${beforeDateEndOfDay}" --pretty=format:${gitOutputFormat} ${ignores}`;
 
   const result = await runCommand(gitCommand);
 
   const rawEntries = (result as string).split('\n');
-
-  // const { committers, monthly } = collapseAndSortCommitterInfo(startDate, endDate, rawEntries);
-  // if( args.monthly ){
-  //   printMonthly(monthly);
-  //   return;
-  // }else{
-  //   printCommitters(committers);
-  //   return;
-  // }
   if (rawEntries.length === 1 && rawEntries[0] === '') {
-    const startDateStr = format(startDate, 'yyyy-MM-dd');
-    const endDateStr = format(endDate, 'yyyy-MM-dd');
-    console.log(`No commits found between ${endDateStr} and ${startDateStr}`);
+    const beforeDateStr = format(beforeDate, 'yyyy-MM-dd');
+    const afterDateStr = format(afterDate, 'yyyy-MM-dd');
+    console.log(`No commits found between ${afterDateStr} and ${beforeDateStr}`);
     return;
   }
   const entries = parseGitLogEntries(rawEntries);

diff --git a/libs/report/committers/src/lib/parse-date-flags.ts b/libs/report/committers/src/lib/parse-date-flags.ts
@@ -1,12 +1,8 @@
 import { parse } from 'date-fns';
 
-export function parseDateFlags(
-  dateFormat: string,
-  startDate: string,
-  endDate: string
-) {
+export function parseDateFlags(dateFormat: string, beforeDate: string, afterDate: string) {
   return {
-    endDate: parse(endDate, dateFormat, new Date()),
-    startDate: parse(startDate, dateFormat, new Date()),
+    afterDate: parse(afterDate, dateFormat, new Date()),
+    beforeDate: parse(beforeDate, dateFormat, new Date()),
   };
 }