bananareporter 0.3.3 → 0.4.3

package/README.md

@@ -3,7 +3,7 @@
 <img src="docs/assets/banana-reporter-logo.png" alt="Banana Reporter Logo" height="70px"/>
 </p>
 <h1 align="center">Banana Reporter</h1>
-<p align="center">Create a report in CSV, JSON and JSONL from multiple sources (e.g. GitLab, GitHub, todo.txt etc.)</p>
+<p align="center">Create a report in CSV, JSON and JSONL from multiple sources (GitLab, GitHub, Git local repository and todo.txt)</p>
 
 <p align="center">
   <a href="https://oclif.io"><img src="https://img.shields.io/badge/cli-oclif-brightgreen.svg" alt="oclif"/></a>
@@ -28,6 +28,7 @@
 - **Sources Supported**
   - [GitLab](./docs/sources/gitlab.md): commits
   - [GitHub](./docs/sources/github.md): commits
+  - [Git CLI (local repository)](./docs/sources/git-cli.md): commits
   - todo.txt: tasks
   - **[Request a new source](https://github.com/nya1/bananareporter/issues/new?assignees=&labels=enhancement&template=new-source-request.md&title=)**
 
@@ -102,7 +103,7 @@ $ npm install -g bananareporter
 $ bananareporter COMMAND
 running command...
 $ bananareporter (--version)
-bananareporter/0.3.3 linux-x64 node-v18.15.0
+bananareporter/0.4.3 linux-x64 node-v18.16.0
 $ bananareporter --help [COMMAND]
 USAGE
   $ bananareporter COMMAND
@@ -149,9 +150,9 @@ FLAGS
   --delay=<value>       [default: 300] global delay in millisecons between http requests
   --format=<option>     (required) [default: json] output file format
                         <options: json|jsonl|csv>
-  --from=2023-03-01     from date (ISO8601)
+  --from=2023-06-01     from date (ISO8601)
   --include-raw-object  include raw object in json/jsonl reporter output
-  --to=2023-03-31       to date (ISO8601)
+  --to=2023-06-30       to date (ISO8601)
 
 DESCRIPTION
   Run report
@@ -161,5 +162,5 @@ EXAMPLES
   report with 138 entries saved to ./bananareporter.json
 ```
 
-_See code: [dist/commands/run/index.ts](https://github.com/nya1/bananareporter/blob/v0.3.3/dist/commands/run/index.ts)_
+_See code: [dist/commands/run/index.ts](https://github.com/nya1/bananareporter/blob/v0.4.3/dist/commands/run/index.ts)_
 <!-- commandsstop -->

package/dist/commands/run/index.js

@@ -15,6 +15,7 @@ const github_1 = require("../../integrations/github");
 const todotxt_1 = require("../../integrations/todotxt");
 const zod_1 = require("zod");
 const node_path_1 = require("node:path");
+const git_cli_1 = require("../../integrations/git-cli");
 class Run extends core_1.Command {
     static dateStringValidation(input) {
         if (!dayjs(input).isValid()) {
@@ -56,6 +57,12 @@ class Run extends core_1.Command {
                     res = await integrationLoaded.fetchData();
                     break;
                 }
+                case base_1.SourceType.Enum['git-cli']: {
+                    const integrationLoaded = new git_cli_1.GitCliIntegration(s, validatedConfig);
+                    // eslint-disable-next-line no-await-in-loop
+                    res = await integrationLoaded.fetchData();
+                    break;
+                }
                 case base_1.SourceType.Enum['todo.txt']: {
                     const integrationLoaded = new todotxt_1.TodoTxtIntegration(s, validatedConfig);
                     // eslint-disable-next-line no-await-in-loop

package/dist/core/index.d.ts

@@ -23,11 +23,11 @@ export declare const BananaConfig: z.ZodEffects<z.ZodEffects<z.ZodObject<{
        * where to fetch data
        */
     sources: z.ZodArray<z.ZodObject<{
-        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+        type: z.ZodEnum<["gitlab", "github", "todo.txt", "git-cli"]>;
     }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+        type: z.ZodEnum<["gitlab", "github", "todo.txt", "git-cli"]>;
     }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+        type: z.ZodEnum<["gitlab", "github", "todo.txt", "git-cli"]>;
     }, z.ZodTypeAny, "passthrough">>, "atleastone">;
 }, "strip", z.ZodTypeAny, {
     format: "json" | "csv" | "jsonl";
@@ -38,9 +38,9 @@ export declare const BananaConfig: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     configFileLocation: string;
     delay: number;
     sources: [z.objectOutputType<{
-        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+        type: z.ZodEnum<["gitlab", "github", "todo.txt", "git-cli"]>;
     }, z.ZodTypeAny, "passthrough">, ...z.objectOutputType<{
-        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+        type: z.ZodEnum<["gitlab", "github", "todo.txt", "git-cli"]>;
     }, z.ZodTypeAny, "passthrough">[]];
 }, {
     format: "json" | "csv" | "jsonl";
@@ -49,9 +49,9 @@ export declare const BananaConfig: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     to: string;
     configFileLocation: string;
     sources: [z.objectInputType<{
-        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+        type: z.ZodEnum<["gitlab", "github", "todo.txt", "git-cli"]>;
     }, z.ZodTypeAny, "passthrough">, ...z.objectInputType<{
-        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+        type: z.ZodEnum<["gitlab", "github", "todo.txt", "git-cli"]>;
     }, z.ZodTypeAny, "passthrough">[]];
     includeRawObject?: boolean | undefined;
     delay?: number | undefined;
@@ -64,9 +64,9 @@ export declare const BananaConfig: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     configFileLocation: string;
     delay: number;
     sources: [z.objectOutputType<{
-        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+        type: z.ZodEnum<["gitlab", "github", "todo.txt", "git-cli"]>;
     }, z.ZodTypeAny, "passthrough">, ...z.objectOutputType<{
-        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+        type: z.ZodEnum<["gitlab", "github", "todo.txt", "git-cli"]>;
     }, z.ZodTypeAny, "passthrough">[]];
 }, {
     format: "json" | "csv" | "jsonl";
@@ -75,9 +75,9 @@ export declare const BananaConfig: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     to: string;
     configFileLocation: string;
     sources: [z.objectInputType<{
-        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+        type: z.ZodEnum<["gitlab", "github", "todo.txt", "git-cli"]>;
     }, z.ZodTypeAny, "passthrough">, ...z.objectInputType<{
-        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+        type: z.ZodEnum<["gitlab", "github", "todo.txt", "git-cli"]>;
     }, z.ZodTypeAny, "passthrough">[]];
     includeRawObject?: boolean | undefined;
     delay?: number | undefined;
@@ -90,9 +90,9 @@ export declare const BananaConfig: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     configFileLocation: string;
     delay: number;
     sources: [z.objectOutputType<{
-        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+        type: z.ZodEnum<["gitlab", "github", "todo.txt", "git-cli"]>;
     }, z.ZodTypeAny, "passthrough">, ...z.objectOutputType<{
-        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+        type: z.ZodEnum<["gitlab", "github", "todo.txt", "git-cli"]>;
     }, z.ZodTypeAny, "passthrough">[]];
 }, {
     format: "json" | "csv" | "jsonl";
@@ -101,9 +101,9 @@ export declare const BananaConfig: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     to: string;
     configFileLocation: string;
     sources: [z.objectInputType<{
-        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+        type: z.ZodEnum<["gitlab", "github", "todo.txt", "git-cli"]>;
     }, z.ZodTypeAny, "passthrough">, ...z.objectInputType<{
-        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+        type: z.ZodEnum<["gitlab", "github", "todo.txt", "git-cli"]>;
     }, z.ZodTypeAny, "passthrough">[]];
     includeRawObject?: boolean | undefined;
     delay?: number | undefined;

package/dist/integrations/base.d.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 import { BananaConfig } from '../core';
-export declare const SourceType: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+export declare const SourceType: z.ZodEnum<["gitlab", "github", "todo.txt", "git-cli"]>;
 export type SourceType = z.infer<typeof SourceType>;
 export interface CommonBananaReporterObj {
     id: string;

package/dist/integrations/base.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IntegrationBase = exports.SourceType = void 0;
 const zod_1 = require("zod");
-exports.SourceType = zod_1.z.enum(['gitlab', 'github', 'todo.txt']);
+exports.SourceType = zod_1.z.enum(['gitlab', 'github', 'todo.txt', 'git-cli']);
 // TODO improve base integration
 class IntegrationBase {
     // eslint-disable-next-line no-useless-constructor, @typescript-eslint/no-empty-function

package/dist/integrations/git-cli.d.ts

@@ -0,0 +1,38 @@
+import { CommonBananaReporterObj, IntegrationBase } from './base';
+import { BananaConfig } from '../core';
+import { z } from 'zod';
+export type GitCliConfig = z.infer<typeof GitCliConfig>;
+export declare const GitCliConfig: z.ZodObject<{
+    path: z.ZodEffects<z.ZodString, string, string>;
+    authorUsername: z.ZodString;
+    from: z.ZodOptional<z.ZodString>;
+    to: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    path: string;
+    authorUsername: string;
+    from?: string | undefined;
+    to?: string | undefined;
+}, {
+    path: string;
+    authorUsername: string;
+    from?: string | undefined;
+    to?: string | undefined;
+}>;
+interface GitCliLog {
+    commit: string;
+    commitMessage: string;
+    author: string;
+    dateUnix: number;
+    projectName?: string;
+    branch: string;
+}
+export declare class GitCliIntegration extends IntegrationBase {
+    static type: "git-cli";
+    private config;
+    private dateRange;
+    private bananaReporterConfig;
+    constructor(_rawConfig: unknown, bananaReporterConfig: BananaConfig);
+    fetchData(): Promise<CommonBananaReporterObj[]>;
+    toBananaReporterObj(rawData: GitCliLog, _index?: number): CommonBananaReporterObj;
+}
+export {};

package/dist/integrations/git-cli.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GitCliIntegration = exports.GitCliConfig = void 0;
+const base_1 = require("./base");
+// import {Axios} from 'axios'
+const common_1 = require("../util/common");
+const zod_1 = require("zod");
+const dayjs = require("dayjs");
+const logger_1 = require("../util/logger");
+const path = require("path");
+const node_fs_1 = require("node:fs");
+const shell = require("shelljs");
+exports.GitCliConfig = zod_1.z.object({
+    // TODO support wildcard
+    path: zod_1.z
+        .string()
+        .min(1)
+        .refine(s => {
+        return path.resolve(s);
+    }),
+    authorUsername: zod_1.z.string().min(1),
+    from: common_1.zIsoString.optional(),
+    to: common_1.zIsoString.optional(),
+});
+class GitCliIntegration extends base_1.IntegrationBase {
+    constructor(_rawConfig, bananaReporterConfig) {
+        var _a, _b, _c;
+        super(_rawConfig, bananaReporterConfig);
+        logger_1.logger.debug('git-cli integration');
+        this.config = exports.GitCliConfig.parse(_rawConfig);
+        logger_1.logger.debug('git-cli integration config', this.config);
+        this.bananaReporterConfig = bananaReporterConfig;
+        this.dateRange = {
+            from: (_a = this.config.from) !== null && _a !== void 0 ? _a : this.bananaReporterConfig.from,
+            to: (_b = this.config.to) !== null && _b !== void 0 ? _b : this.bananaReporterConfig.to,
+        };
+        logger_1.logger.debug('git-cli integration dateRange', this.dateRange);
+        if (!((_c = (0, node_fs_1.lstatSync)(this.config.path)) === null || _c === void 0 ? void 0 : _c.isDirectory())) {
+            const errorMsg = `Unable to find path ${this.config.path} or not a valid directory`;
+            logger_1.logger.error(errorMsg);
+            throw new Error(errorMsg);
+        }
+        logger_1.logger.debug(`git-cli path ${this.config.path} exists`);
+        if (!shell.which('git')) {
+            throw new Error('git CLI required for git-cli source');
+        }
+    }
+    async fetchData() {
+        const fromDate = dayjs(this.dateRange.from).startOf('day');
+        const toDate = dayjs(this.dateRange.to).endOf('day');
+        // extract project name from directory
+        const directory = path.basename(this.config.path);
+        // execute git log
+        const gitLogCommand = shell.exec(`git -C ${this.config.path} --no-pager log --branches="*" --author="${this.config.authorUsername
+        // hash - author - date unix - commit message - branch
+        }" --reverse --no-merges --source --format='%H~~~~~%an~~~~~%at~~~~~%s~~~~~%S>%n%n' --after="${fromDate.toISOString()}" --before="${toDate.toISOString()}"`, {
+            silent: true,
+        });
+        if (gitLogCommand.code !== 0) {
+            throw new Error(`unable to execute git log to ${this.config.path}, output: ${gitLogCommand.stderr}`);
+        }
+        const gitLogJson = [];
+        if (gitLogCommand.stdout) {
+            for (const line of gitLogCommand.stdout.split('>\n\n')) {
+                const splitGit = line.split('~~~~~');
+                logger_1.logger.debug('git log', { splitGit });
+                if (splitGit.length !== 5) {
+                    continue;
+                }
+                gitLogJson.push({
+                    commit: splitGit[0].replace(/\n/g, ''),
+                    author: splitGit[1],
+                    dateUnix: Number(splitGit[2]),
+                    commitMessage: splitGit[3],
+                    branch: splitGit[4],
+                });
+            }
+        }
+        return gitLogJson.map((e, i) => {
+            // add project name
+            e.projectName = directory;
+            return this.toBananaReporterObj(e, i);
+        });
+    }
+    toBananaReporterObj(rawData, _index) {
+        return {
+            id: rawData.commit,
+            date: dayjs.unix(rawData.dateUnix).toISOString(),
+            description: rawData.commitMessage,
+            projectName: rawData.projectName,
+            type: GitCliIntegration.type,
+            __raw: this.bananaReporterConfig.includeRawObject ? rawData : undefined,
+        };
+    }
+}
+exports.GitCliIntegration = GitCliIntegration;
+GitCliIntegration.type = base_1.SourceType.Enum['git-cli'];

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.3.3",
+  "version": "0.4.3",
   "commands": {
     "run": {
       "id": "run",
@@ -26,7 +26,7 @@
           "type": "option",
           "description": "from date (ISO8601)",
           "required": false,
-          "helpValue": "2023-03-01",
+          "helpValue": "2023-06-01",
           "multiple": false
         },
         "to": {
@@ -34,7 +34,7 @@
           "type": "option",
           "description": "to date (ISO8601)",
           "required": false,
-          "helpValue": "2023-03-31",
+          "helpValue": "2023-06-30",
           "multiple": false,
           "dependsOn": [
             "from"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bananareporter",
-  "version": "0.3.3",
+  "version": "0.4.3",
   "description": "Easily generate a report from multiple sources",
   "author": "nya1",
   "bin": {
@@ -26,6 +26,7 @@
     "lodash": "^4.17.21",
     "object-path": "^0.11.8",
     "papaparse": "^5.4.1",
+    "shelljs": "^0.8.5",
     "winston": "^3.8.2",
     "zod": "^3.21.4"
   },
@@ -38,6 +39,7 @@
     "@types/node-fetch": "^2.6.2",
     "@types/object-path": "^0.11.1",
     "@types/papaparse": "^5.3.7",
+    "@types/shelljs": "^0.8.12",
     "chai": "^4",
     "eslint": "^7.32.0",
     "eslint-config-oclif": "^4",