bananareporter 0.1.2 → 0.2.1

package/README.md

@@ -26,8 +26,8 @@
 - **Multiple output formats**: output file can be a JSON, JSONL or CSV (via `--format`) _more coming soon_
 - **Configurable**: data to be imported can be filtered using the configuration file and each option can be overridden per source
 - **Sources Supported**
-  - GitLab: commits
-  - GitHub: commits
+  - [GitLab](./docs/sources/gitlab.md): commits
+  - [GitHub](./docs/sources/github.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=)**
 
@@ -67,7 +67,30 @@ sources:
 bananareporter --from 2023-01-01 --to 2023-03-01 -c bananareporter.yaml
 ```
 
-In the current directory you will find the output as `bananareporter_$FROM__$TO.json`, can be changed with `--out`
+In the current directory you will find the output as `bananareporter_$FROM__$TO.json` (can be changed with `--out`)
+
+Example of output (json) with gitlab and github sources:
+
+```json
+[
+  {
+    "date": "2023-01-13T07:51:21.730Z",
+    "username": "johndoe",
+    "description": "chore: update changelog and swagger branch:work git:aa33b04",
+    "projectId": "3318214",
+    "projectName": "awesome-frontend",
+    "type": "gitlab"
+  },
+  {
+    "date": "2023-01-14T10:50:10.230Z",
+    "username": "johndoe2",
+    "description": "refactor: compare date function branch:work git:ia1f241",
+    "projectId": "928544",
+    "projectName": "awesome-backend",
+    "type": "github"
+  }
+]
+```
 
 
 # Usage
@@ -77,7 +100,7 @@ $ npm install -g bananareporter
 $ bananareporter COMMAND
 running command...
 $ bananareporter (--version)
-bananareporter/0.1.2 linux-x64 node-v18.14.2
+bananareporter/0.2.1 linux-x64 node-v18.14.2
 $ bananareporter --help [COMMAND]
 USAGE
   $ bananareporter COMMAND
@@ -107,7 +130,7 @@ DESCRIPTION
   Display help for bananareporter.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.7/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.8/src/commands/help.ts)_
 
 ## `bananareporter run`
 
@@ -136,5 +159,5 @@ EXAMPLES
   report with 138 entries saved to ./bananareporter.json
 ```
 
-_See code: [dist/commands/run/index.ts](https://github.com/nya1/bananareporter/blob/v0.1.2/dist/commands/run/index.ts)_
+_See code: [dist/commands/run/index.ts](https://github.com/nya1/bananareporter/blob/v0.2.1/dist/commands/run/index.ts)_
 <!-- commandsstop -->

package/dist/commands/run/index.d.ts

@@ -14,4 +14,5 @@ export default class Run extends Command {
         'disable-welcome-emoji': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     };
     run(): Promise<void>;
+    catch(error: Error): Promise<void>;
 }

package/dist/commands/run/index.js

@@ -13,6 +13,7 @@ const lodash_1 = require("lodash");
 const logger_1 = require("../../util/logger");
 const github_1 = require("../../integrations/github");
 const todotxt_1 = require("../../integrations/todotxt");
+const zod_1 = require("zod");
 class Run extends core_1.Command {
     static dateStringValidation(input) {
         if (!dayjs(input).isValid()) {
@@ -72,6 +73,10 @@ class Run extends core_1.Command {
             this.warn('no entries found, make sure the date range provided and the sources are correct');
             return;
         }
+        // re order by date ASC
+        reportList.sort((a, b) => {
+            return dayjs(a.date).diff(b.date);
+        });
         // output
         let outputStr = '';
         // eslint-disable-next-line unicorn/prefer-switch
@@ -110,6 +115,13 @@ class Run extends core_1.Command {
         this.log(`report with ${reportList.length} entries saved to ${outFile}`);
         // this.log(`run! ${flags.config} ${JSON.stringify(configContent)}`)
     }
+    async catch(error) {
+        if (error instanceof zod_1.z.ZodError) {
+            const errMsg = error.issues.map(i => `${i.message}: ${i.path.join(', ')}`).join('\n');
+            throw new TypeError(`validation failed, ${errMsg}`);
+        }
+        throw error;
+    }
 }
 exports.default = Run;
 Run.description = 'Run report';

package/dist/core/index.d.ts

@@ -24,15 +24,11 @@ export declare const BananaConfig: z.ZodEffects<z.ZodEffects<z.ZodObject<{
        */
     sources: z.ZodArray<z.ZodObject<{
         type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
-    }, "passthrough", z.ZodTypeAny, {
-        type: "gitlab" | "github" | "todo.txt";
-    } & {
-        [k: string]: unknown;
-    }, {
-        type: "gitlab" | "github" | "todo.txt";
-    } & {
-        [k: string]: unknown;
-    }>, "atleastone">;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+    }, z.ZodTypeAny, "passthrough">>, "atleastone">;
 }, "strip", z.ZodTypeAny, {
     format: "json" | "csv" | "jsonl";
     from: string;
@@ -41,32 +37,24 @@ export declare const BananaConfig: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     to: string;
     configFileLocation: string;
     delay: number;
-    sources: [{
-        type: "gitlab" | "github" | "todo.txt";
-    } & {
-        [k: string]: unknown;
-    }, ...({
-        type: "gitlab" | "github" | "todo.txt";
-    } & {
-        [k: string]: unknown;
-    })[]];
+    sources: [z.objectOutputType<{
+        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+    }, z.ZodTypeAny, "passthrough">, ...z.objectOutputType<{
+        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+    }, z.ZodTypeAny, "passthrough">[]];
 }, {
-    includeRawObject?: boolean | undefined;
-    delay?: number | undefined;
     format: "json" | "csv" | "jsonl";
     from: string;
     out: string;
     to: string;
     configFileLocation: string;
-    sources: [{
-        type: "gitlab" | "github" | "todo.txt";
-    } & {
-        [k: string]: unknown;
-    }, ...({
-        type: "gitlab" | "github" | "todo.txt";
-    } & {
-        [k: string]: unknown;
-    })[]];
+    sources: [z.objectInputType<{
+        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+    }, z.ZodTypeAny, "passthrough">, ...z.objectInputType<{
+        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+    }, z.ZodTypeAny, "passthrough">[]];
+    includeRawObject?: boolean | undefined;
+    delay?: number | undefined;
 }>, {
     format: "json" | "csv" | "jsonl";
     from: string;
@@ -75,32 +63,24 @@ export declare const BananaConfig: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     to: string;
     configFileLocation: string;
     delay: number;
-    sources: [{
-        type: "gitlab" | "github" | "todo.txt";
-    } & {
-        [k: string]: unknown;
-    }, ...({
-        type: "gitlab" | "github" | "todo.txt";
-    } & {
-        [k: string]: unknown;
-    })[]];
+    sources: [z.objectOutputType<{
+        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+    }, z.ZodTypeAny, "passthrough">, ...z.objectOutputType<{
+        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+    }, z.ZodTypeAny, "passthrough">[]];
 }, {
-    includeRawObject?: boolean | undefined;
-    delay?: number | undefined;
     format: "json" | "csv" | "jsonl";
     from: string;
     out: string;
     to: string;
     configFileLocation: string;
-    sources: [{
-        type: "gitlab" | "github" | "todo.txt";
-    } & {
-        [k: string]: unknown;
-    }, ...({
-        type: "gitlab" | "github" | "todo.txt";
-    } & {
-        [k: string]: unknown;
-    })[]];
+    sources: [z.objectInputType<{
+        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+    }, z.ZodTypeAny, "passthrough">, ...z.objectInputType<{
+        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+    }, z.ZodTypeAny, "passthrough">[]];
+    includeRawObject?: boolean | undefined;
+    delay?: number | undefined;
 }>, {
     format: "json" | "csv" | "jsonl";
     from: string;
@@ -109,32 +89,24 @@ export declare const BananaConfig: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     to: string;
     configFileLocation: string;
     delay: number;
-    sources: [{
-        type: "gitlab" | "github" | "todo.txt";
-    } & {
-        [k: string]: unknown;
-    }, ...({
-        type: "gitlab" | "github" | "todo.txt";
-    } & {
-        [k: string]: unknown;
-    })[]];
+    sources: [z.objectOutputType<{
+        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+    }, z.ZodTypeAny, "passthrough">, ...z.objectOutputType<{
+        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+    }, z.ZodTypeAny, "passthrough">[]];
 }, {
-    includeRawObject?: boolean | undefined;
-    delay?: number | undefined;
     format: "json" | "csv" | "jsonl";
     from: string;
     out: string;
     to: string;
     configFileLocation: string;
-    sources: [{
-        type: "gitlab" | "github" | "todo.txt";
-    } & {
-        [k: string]: unknown;
-    }, ...({
-        type: "gitlab" | "github" | "todo.txt";
-    } & {
-        [k: string]: unknown;
-    })[]];
+    sources: [z.objectInputType<{
+        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+    }, z.ZodTypeAny, "passthrough">, ...z.objectInputType<{
+        type: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+    }, z.ZodTypeAny, "passthrough">[]];
+    includeRawObject?: boolean | undefined;
+    delay?: number | undefined;
 }>;
 export type BananaConfig = z.infer<typeof BananaConfig>;
 export declare function loadAndValidateConfig(input: unknown): BananaConfig;

package/dist/integrations/github.d.ts

@@ -167,9 +167,10 @@ export declare const GithubConfig: z.ZodObject<{
     to: z.ZodOptional<z.ZodString>;
     delay: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
-    from?: string | undefined;
-    to?: string | undefined;
-    delay?: number | undefined;
+    protocol: "http" | "https";
+    committerUsername: string;
+    domain: string;
+    apiVersion: string;
     token?: string | undefined;
     filters?: [{
         on: string;
@@ -178,15 +179,11 @@ export declare const GithubConfig: z.ZodObject<{
         on: string;
         regex: string;
     }[]] | undefined;
-    protocol: "http" | "https";
-    committerUsername: string;
-    domain: string;
-    apiVersion: string;
-}, {
     from?: string | undefined;
-    protocol?: "http" | "https" | undefined;
     to?: string | undefined;
     delay?: number | undefined;
+}, {
+    committerUsername: string;
     token?: string | undefined;
     filters?: [{
         on: string;
@@ -197,7 +194,10 @@ export declare const GithubConfig: z.ZodObject<{
     }[]] | undefined;
     domain?: string | undefined;
     apiVersion?: string | undefined;
-    committerUsername: string;
+    protocol?: "http" | "https" | undefined;
+    from?: string | undefined;
+    to?: string | undefined;
+    delay?: number | undefined;
 }>;
 export declare class GithubIntegration extends IntegrationBase {
     static type: "github";

package/dist/integrations/gitlab.d.ts

@@ -54,9 +54,12 @@ export declare const GitlabConfig: z.ZodObject<{
     to: z.ZodOptional<z.ZodString>;
     delay: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
-    from?: string | undefined;
-    to?: string | undefined;
-    delay?: number | undefined;
+    protocol: "http" | "https";
+    committerUsername: string;
+    token: string;
+    domain: string;
+    apiVersion: string;
+    apiBasePath: string;
     userId?: number | undefined;
     filters?: [{
         on: string;
@@ -65,17 +68,12 @@ export declare const GitlabConfig: z.ZodObject<{
         on: string;
         regex: string;
     }[]] | undefined;
-    protocol: "http" | "https";
-    committerUsername: string;
-    token: string;
-    domain: string;
-    apiVersion: string;
-    apiBasePath: string;
-}, {
     from?: string | undefined;
-    protocol?: "http" | "https" | undefined;
     to?: string | undefined;
     delay?: number | undefined;
+}, {
+    committerUsername: string;
+    token: string;
     userId?: number | undefined;
     filters?: [{
         on: string;
@@ -86,9 +84,11 @@ export declare const GitlabConfig: z.ZodObject<{
     }[]] | undefined;
     domain?: string | undefined;
     apiVersion?: string | undefined;
+    protocol?: "http" | "https" | undefined;
     apiBasePath?: string | undefined;
-    committerUsername: string;
-    token: string;
+    from?: string | undefined;
+    to?: string | undefined;
+    delay?: number | undefined;
 }>;
 export declare class GitlabIntegration extends IntegrationBase {
     static type: "gitlab";

package/dist/integrations/todotxt.d.ts

@@ -18,8 +18,7 @@ export declare const TodoTxtConfig: z.ZodObject<{
     from: z.ZodOptional<z.ZodString>;
     to: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
-    from?: string | undefined;
-    to?: string | undefined;
+    file: string;
     filters?: [{
         on: string;
         regex: string;
@@ -27,11 +26,10 @@ export declare const TodoTxtConfig: z.ZodObject<{
         on: string;
         regex: string;
     }[]] | undefined;
-    file: string;
-}, {
-    file?: string | undefined;
     from?: string | undefined;
     to?: string | undefined;
+}, {
+    file?: string | undefined;
     filters?: [{
         on: string;
         regex: string;
@@ -39,6 +37,8 @@ export declare const TodoTxtConfig: z.ZodObject<{
         on: string;
         regex: string;
     }[]] | undefined;
+    from?: string | undefined;
+    to?: string | undefined;
 }>;
 export declare class TodoTxtIntegration extends IntegrationBase {
     static type: "todo.txt";

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.1.2",
+  "version": "0.2.1",
   "commands": {
     "run": {
       "id": "run",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bananareporter",
-  "version": "0.1.2",
+  "version": "0.2.1",
   "description": "Easily generate a report from multiple sources",
   "author": "nya1",
   "bin": {
@@ -27,14 +27,14 @@
     "object-path": "^0.11.8",
     "papaparse": "^5.4.0",
     "winston": "^3.8.2",
-    "zod": "^3.21.0"
+    "zod": "^3.21.4"
   },
   "devDependencies": {
-    "@oclif/test": "^2.3.8",
+    "@oclif/test": "^2.3.10",
     "@types/chai": "^4",
     "@types/js-yaml": "^4.0.5",
     "@types/mocha": "^9.1.1",
-    "@types/node": "^18.14.6",
+    "@types/node": "^18.15.0",
     "@types/node-fetch": "^2.6.2",
     "@types/object-path": "^0.11.1",
     "@types/papaparse": "^5.3.7",