bananareporter 0.2.1 → 0.3.1

package/README.md

@@ -9,7 +9,7 @@
   <a href="https://oclif.io"><img src="https://img.shields.io/badge/cli-oclif-brightgreen.svg" alt="oclif"/></a>
   <a href="https://npmjs.org/package/bananareporter"><img src="https://img.shields.io/npm/v/bananareporter.svg" alt="Version"/></a>
   <a href="https://github.com/nya1/bananareporter/actions/workflows/test.yml"><img src="https://github.com/nya1/bananareporter/actions/workflows/test.yml/badge.svg" alt="Github"/></a>
-  <a href="https://npmjs.org/package/bananareporter"><img src="https://img.shields.io/npm/dw/bananareporter.svg" alt="Downloads/week"/></a>
+  <a href="https://npmjs.org/package/bananareporter"><img src="https://img.shields.io/npm/dt/bananareporter.svg" alt="Total Downloads"/></a>
   <a href="https://github.com/nya1/bananareporter/blob/main/package.json"><img src="https://img.shields.io/npm/l/bananareporter.svg" alt="License"/></a>
 </p>
 
@@ -74,6 +74,7 @@ Example of output (json) with gitlab and github sources:
 ```json
 [
   {
+    "id": "c12ba180bfecf45fcdcc40d6104d1f1b7ad409dc",
     "date": "2023-01-13T07:51:21.730Z",
     "username": "johndoe",
     "description": "chore: update changelog and swagger branch:work git:aa33b04",
@@ -82,8 +83,9 @@ Example of output (json) with gitlab and github sources:
     "type": "gitlab"
   },
   {
+    "id": "6e1b66a1dea89e957d8c44943f942be4874c0641",
     "date": "2023-01-14T10:50:10.230Z",
-    "username": "johndoe2",
+    "username": "johndoe",
     "description": "refactor: compare date function branch:work git:ia1f241",
     "projectId": "928544",
     "projectName": "awesome-backend",
@@ -100,7 +102,7 @@ $ npm install -g bananareporter
 $ bananareporter COMMAND
 running command...
 $ bananareporter (--version)
-bananareporter/0.2.1 linux-x64 node-v18.14.2
+bananareporter/0.3.1 linux-x64 node-v18.15.0
 $ bananareporter --help [COMMAND]
 USAGE
   $ bananareporter COMMAND
@@ -143,7 +145,7 @@ USAGE
 
 FLAGS
   -c, --config=<value>  config file location, by default ~/.config/bananareporter/config.yaml
-  -o, --out=<value>     (required) [default: ./bananareporter_$FROM__$TO.json] file path to save the output
+  -o, --out=<value>     (required) [default: ./bananareporter_$FROM__$TO.json] file path or directory to save the output
   --delay=<value>       [default: 300] global delay in millisecons between http requests
   --format=<option>     (required) [default: json] output file format
                         <options: json|jsonl|csv>
@@ -159,5 +161,5 @@ EXAMPLES
   report with 138 entries saved to ./bananareporter.json
 ```
 
-_See code: [dist/commands/run/index.ts](https://github.com/nya1/bananareporter/blob/v0.2.1/dist/commands/run/index.ts)_
+_See code: [dist/commands/run/index.ts](https://github.com/nya1/bananareporter/blob/v0.3.1/dist/commands/run/index.ts)_
 <!-- commandsstop -->

package/dist/commands/run/index.js

@@ -14,6 +14,7 @@ const logger_1 = require("../../util/logger");
 const github_1 = require("../../integrations/github");
 const todotxt_1 = require("../../integrations/todotxt");
 const zod_1 = require("zod");
+const node_path_1 = require("node:path");
 class Run extends core_1.Command {
     static dateStringValidation(input) {
         if (!dayjs(input).isValid()) {
@@ -69,6 +70,8 @@ class Run extends core_1.Command {
             // eslint-disable-next-line unicorn/prefer-spread
             reportList = reportList.concat(res);
         }
+        // remove any duplicates (based on "id")
+        reportList = [...new Map(reportList.map(v => [v.id, v])).values()];
         if (reportList.length === 0) {
             this.warn('no entries found, make sure the date range provided and the sources are correct');
             return;
@@ -98,18 +101,35 @@ class Run extends core_1.Command {
         }
         const fileExt = `.${validatedConfig.format}`;
         let outFile = validatedConfig.out;
+        logger_1.logger.debug(`Run.flags.out.default ${Run.flags.out.default}`);
+        logger_1.logger.debug(`fileExt ${fileExt}`);
+        logger_1.logger.debug(`outFile ${outFile}`);
+        // if --out was provided and it's a directory
+        // use the default file name
+        try {
+            if ((0, node_fs_1.statSync)(outFile).isDirectory()) {
+                outFile = (0, node_path_1.resolve)(outFile, Run.flags.out.default);
+                logger_1.logger.debug(`outFile is a directory, updated to ${outFile}`);
+            }
+        }
+        catch (error) {
+            logger_1.logger.debug('statSync error', error);
+        }
         // add file extension
         if (!outFile.endsWith(fileExt)) {
             if (outFile === Run.flags.out.default) {
                 outFile = outFile
-                    .replace(`.${Run.flags.format.default}`, fileExt)
-                    .replace('$FROM', validatedConfig.from)
-                    .replace('$TO', validatedConfig.to);
+                    .replace(`.${Run.flags.format.default}`, fileExt);
             }
             else {
                 outFile += fileExt;
             }
         }
+        if (outFile.includes('$FROM') || outFile.includes('$TO')) {
+            outFile = outFile
+                .replace('$FROM', validatedConfig.from)
+                .replace('$TO', validatedConfig.to);
+        }
         logger_1.logger.debug(`run saving to ${outFile} with file content of size ${outputStr.length}`);
         (0, node_fs_1.writeFileSync)(outFile, outputStr);
         this.log(`report with ${reportList.length} entries saved to ${outFile}`);
@@ -151,7 +171,7 @@ Run.flags = {
     out: core_1.Flags.file({
         char: 'o',
         aliases: ['output'],
-        description: 'file path to save the output',
+        description: 'file path or directory to save the output',
         required: true,
         default: './bananareporter_$FROM__$TO.json',
     }),

package/dist/integrations/base.d.ts

@@ -3,13 +3,18 @@ import { BananaConfig } from '../core';
 export declare const SourceType: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
 export type SourceType = z.infer<typeof SourceType>;
 export interface CommonBananaReporterObj {
+    id: string;
     date: string;
     description: string;
     username?: string;
     projectId?: string;
     projectName?: string;
     type: SourceType;
-    __raw: any;
+    /**
+     * the raw source object,
+     * included only when --include-raw-object is provided
+     */
+    __raw?: any;
 }
 export declare abstract class IntegrationBase {
     static type: SourceType;

package/dist/integrations/github.js

@@ -126,6 +126,7 @@ class GithubIntegration extends base_1.IntegrationBase {
         const projectName = rawData.repository.name;
         const description = `${rawData.commit.message} git:${rawData.sha.slice(0, 7)}`;
         return {
+            id: rawData.sha,
             date: rawData.commit.committer.date,
             username: rawData.commit.committer.name,
             description,

package/dist/integrations/gitlab.js

@@ -101,11 +101,11 @@ class GitlabIntegration extends base_1.IntegrationBase {
                 logger_1.logger.debug('gitlab integration no more events to process');
                 break;
             }
+            // eslint-disable-next-line unicorn/prefer-spread
+            eventList = eventList.concat(events);
             for (const e of events) {
                 projectIds.add(e.project_id);
             }
-            // eslint-disable-next-line unicorn/prefer-spread
-            eventList = eventList.concat(events);
             logger_1.logger.debug(`gitlab integration eventList ${eventList.length} (added ${events.length} events)`);
             page += 1;
             await (0, common_1.delay)(this.delayToUse);
@@ -240,6 +240,7 @@ class GitlabIntegration extends base_1.IntegrationBase {
         const projectName = projectDetails === null || projectDetails === void 0 ? void 0 : projectDetails.path;
         const description = `${rawData.push_data.commit_title} branch:${rawData.push_data.ref} git:${rawData.push_data.commit_to.slice(0, 7)}`;
         return {
+            id: `${String(rawData.push_data.commit_to)}`,
             date: rawData.created_at,
             username: rawData.author_username,
             description,

package/dist/integrations/todotxt.d.ts

@@ -47,5 +47,5 @@ export declare class TodoTxtIntegration extends IntegrationBase {
     private bananaReporterConfig;
     constructor(_rawConfig: unknown, bananaReporterConfig: BananaConfig);
     fetchData(): Promise<CommonBananaReporterObj[]>;
-    toBananaReporterObj(rawData: Task): CommonBananaReporterObj;
+    toBananaReporterObj(rawData: Task, index?: number): CommonBananaReporterObj;
 }

package/dist/integrations/todotxt.js

@@ -73,14 +73,15 @@ class TodoTxtIntegration extends base_1.IntegrationBase {
                 return regex.test(value);
             });
         }
-        const formattedData = filteredTasks.map(e => this.toBananaReporterObj(e));
+        const formattedData = filteredTasks.map((e, i) => this.toBananaReporterObj(e, i));
         return formattedData;
     }
-    toBananaReporterObj(rawData) {
+    toBananaReporterObj(rawData, index) {
         var _a;
         const projectName = (_a = rawData.projects) === null || _a === void 0 ? void 0 : _a.map(p => p.replace('+', '')).join(',');
         const description = `${rawData.description}`;
         return {
+            id: `${this.config.file}_${index}`,
             date: rawData.completion || rawData.creation || '',
             description,
             projectName,

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.2.1",
+  "version": "0.3.1",
   "commands": {
     "run": {
       "id": "run",
@@ -44,7 +44,7 @@
           "name": "out",
           "type": "option",
           "char": "o",
-          "description": "file path to save the output",
+          "description": "file path or directory to save the output",
           "required": true,
           "multiple": false,
           "default": "./bananareporter_$FROM__$TO.json",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bananareporter",
-  "version": "0.2.1",
+  "version": "0.3.1",
   "description": "Easily generate a report from multiple sources",
   "author": "nya1",
   "bin": {
@@ -34,7 +34,7 @@
     "@types/chai": "^4",
     "@types/js-yaml": "^4.0.5",
     "@types/mocha": "^9.1.1",
-    "@types/node": "^18.15.0",
+    "@types/node": "^18.15.3",
     "@types/node-fetch": "^2.6.2",
     "@types/object-path": "^0.11.1",
     "@types/papaparse": "^5.3.7",