bananareporter 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 nya1
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,127 @@
+Banana Reporter
+=================
+
+Create a report in CSV, JSON/L from multiple sources (e.g. GitLab, GitHub, todo.txt etc.)
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/bananareporter.svg)](https://npmjs.org/package/bananareporter)
+[![CircleCI](https://circleci.com/gh/oclif/hello-world/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/hello-world/tree/main)
+[![Downloads/week](https://img.shields.io/npm/dw/bananareporter.svg)](https://npmjs.org/package/bananareporter)
+[![License](https://img.shields.io/npm/l/bananareporter.svg)](https://github.com/oclif/hello-world/blob/main/package.json)
+
+<!-- toc -->
+* [Features](#features)
+* [Quickstart](#quickstart)
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+
+# Features
+
+- **Easy to use**: provide a `--from` and `--to` date range and a config file, all data will be fetched automatically
+- **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, GitHub and todo.txt files, _more coming soon_
+
+# Quickstart
+
+0. Install banana reporter CLI `npm i -g bananareporter`
+
+1. Create a config file `bananareporter.yaml` with the sources that you want to fetch
+
+```yaml
+sources:
+  - type: 'gitlab'
+    committerUsername: usernameOnGitlab
+    token: glpat-personalaccesstoken
+    # filters:
+    #   - on: '$project.path_with_namespace'
+    #     regex: '(namespace|anotherone)'
+  - type: 'github'
+    committerUsername: usernameOnGithub
+    # optional, needed for commits on private repositories
+    token: personalaccesstoken
+    # filters:
+    #   - on: 'repository.full_name'
+    #     regex: '(namespace|anotherone)'
+  # - type: 'todo.txt'
+  #   file: './todo.txt'
+```
+
+2. Run the reporter with a date range
+
+```sh
+bananareporter --from 2023-01-01 --to 2023-03-01 -c bananareporter.yaml
+```
+
+In the current directory you can find the `bananareporter.json` output
+
+
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g bananareporter
+$ bananareporter COMMAND
+running command...
+$ bananareporter (--version)
+bananareporter/0.1.0 linux-x64 node-v18.14.2
+$ bananareporter --help [COMMAND]
+USAGE
+  $ bananareporter COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`bananareporter help [COMMANDS]`](#bananareporter-help-commands)
+* [`bananareporter run`](#bananareporter-run)
+
+## `bananareporter help [COMMANDS]`
+
+Display help for bananareporter.
+
+```
+USAGE
+  $ bananareporter help [COMMANDS] [-n]
+
+ARGUMENTS
+  COMMANDS  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for bananareporter.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.7/src/commands/help.ts)_
+
+## `bananareporter run`
+
+Run report
+
+```
+USAGE
+  $ bananareporter run -o <value> --format json|jsonl|csv [-c <value>] [--to <value> --from <value>]
+    [--delay <value>] [--include-raw-object]
+
+FLAGS
+  -c, --config=<value>  config file location, by default ~/.config/bananareporter/config.yaml
+  -o, --out=<value>     (required) [default: ./bananareporter.json] file path 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>
+  --from=2023-03-01     from date (ISO8601)
+  --include-raw-object  include raw object in json/jsonl reporter output
+  --to=2023-03-31       to date (ISO8601)
+
+DESCRIPTION
+  Run report
+
+EXAMPLES
+  $ banana-reporter run --from 2023-01-01 --to 2023-01-31
+  report with 138 entries saved to ./bananareporter.json
+```
+
+_See code: [dist/commands/run/index.ts](https://github.com/nya1/bananareporter/blob/v0.1.0/dist/commands/run/index.ts)_
+<!-- commandsstop -->

package/bin/dev

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+const path = require('path')
+const project = path.join(__dirname, '..', 'tsconfig.json')
+
+// In dev mode -> use ts-node and dev plugins
+process.env.NODE_ENV = 'development'
+
+require('ts-node').register({project})
+
+// In dev mode, always show stack traces
+oclif.settings.debug = true;
+
+// Start the CLI
+oclif.run().then(oclif.flush).catch(oclif.Errors.handle)

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

package/bin/run

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle'))

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

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

@@ -0,0 +1,17 @@
+import { Command } from '@oclif/core';
+export default class Run extends Command {
+    static description: string;
+    static dateStringValidation(input: string): string;
+    static examples: string[];
+    static flags: {
+        config: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        from: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        to: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        out: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        format: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        delay: import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        'include-raw-object': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        'disable-welcome-emoji': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/run/index.js

@@ -0,0 +1,162 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const yaml = require("js-yaml");
+const node_fs_1 = require("node:fs");
+const path = require("node:path");
+const dayjs = require("dayjs");
+const core_2 = require("../../core");
+const base_1 = require("../../integrations/base");
+const gitlab_1 = require("../../integrations/gitlab");
+const papaparse_1 = require("papaparse");
+const lodash_1 = require("lodash");
+const logger_1 = require("../../util/logger");
+const github_1 = require("../../integrations/github");
+const todotxt_1 = require("../../integrations/todotxt");
+class Run extends core_1.Command {
+    static dateStringValidation(input) {
+        if (!dayjs(input).isValid()) {
+            throw new Error(`provided date "${input}" is not valid, make sure it's valid ISO8601 string`);
+        }
+        return input;
+    }
+    async run() {
+        // this.log('🍌 Banana Reporter')
+        const { flags } = await this.parse(Run);
+        logger_1.logger.debug('run CLI flags', flags);
+        const configFileLocation = flags.config || path.join(this.config.configDir, 'config.yaml');
+        logger_1.logger.debug(`run configFileLocation: ${configFileLocation}`);
+        const configContent = yaml.load((0, node_fs_1.readFileSync)(configFileLocation).toString());
+        logger_1.logger.debug('run configContent', configContent);
+        const validatedConfig = (0, core_2.loadAndValidateConfig)({
+            ...configContent,
+            configFileLocation,
+            ...(0, lodash_1.omit)(flags, ['include-raw-object', 'config']),
+            includeRawObject: flags['include-raw-object'],
+        });
+        logger_1.logger.debug('run validatedConfig', validatedConfig);
+        // TODO the sources with different hosts / types can be called in parallel
+        let reportList = [];
+        for (const [i, s] of validatedConfig.sources.entries()) {
+            logger_1.logger.debug(`run source loop ${i}`, s);
+            this.log(`working on ${s.type} (${i + 1}) source`);
+            let res = [];
+            switch (s.type) {
+                case base_1.SourceType.Enum.gitlab: {
+                    const integrationLoaded = new gitlab_1.GitlabIntegration(s, validatedConfig);
+                    // eslint-disable-next-line no-await-in-loop
+                    res = await integrationLoaded.fetchData();
+                    break;
+                }
+                case base_1.SourceType.Enum.github: {
+                    const integrationLoaded = new github_1.GithubIntegration(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
+                    res = await integrationLoaded.fetchData();
+                    break;
+                }
+                default: {
+                    this.error(`unknown source provided ${s.type}`);
+                }
+            }
+            logger_1.logger.debug(`run source loop integration res length ${res.length}`);
+            // eslint-disable-next-line unicorn/prefer-spread
+            reportList = reportList.concat(res);
+        }
+        if (reportList.length === 0) {
+            this.warn('no entries found, make sure the date range provided and the sources are correct');
+            return;
+        }
+        // output
+        let outputStr = '';
+        // eslint-disable-next-line unicorn/prefer-switch
+        if (validatedConfig.format === core_2.BananaOutputFileFormat.Enum.csv) {
+            const fieldsColumns = ['date', 'type', 'username', 'projectName', 'description'];
+            logger_1.logger.debug('run converting json to csv');
+            const csvOutput = (0, papaparse_1.unparse)({
+                fields: fieldsColumns,
+                data: reportList,
+            });
+            outputStr = csvOutput;
+        }
+        else if (validatedConfig.format === core_2.BananaOutputFileFormat.Enum.json) {
+            outputStr = JSON.stringify(reportList, null, 2);
+        }
+        else if (validatedConfig.format === core_2.BananaOutputFileFormat.Enum.jsonl) {
+            logger_1.logger.debug('run converting json to jsonl');
+            outputStr = reportList.map(r => JSON.stringify(r)).join('\n');
+        }
+        const fileExt = `.${validatedConfig.format}`;
+        let outFile = validatedConfig.out;
+        // add file extension
+        if (!outFile.endsWith(fileExt)) {
+            if (outFile === Run.flags.out.default) {
+                outFile = outFile.replace(`.${Run.flags.format.default}`, fileExt);
+            }
+            else {
+                outFile += fileExt;
+            }
+        }
+        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}`);
+        // this.log(`run! ${flags.config} ${JSON.stringify(configContent)}`)
+    }
+}
+exports.default = Run;
+Run.description = 'Run report';
+Run.examples = [
+    `$ banana-reporter run --from 2023-01-01 --to 2023-01-31
+report with 138 entries saved to ./bananareporter.json
+`,
+];
+Run.flags = {
+    config: core_1.Flags.string({
+        char: 'c',
+        description: 'config file location, by default ~/.config/bananareporter/config.yaml',
+        required: false,
+        env: 'BANANAREPORTER_CONFIG_PATH',
+    }),
+    from: core_1.Flags.string({
+        description: 'from date (ISO8601)',
+        helpValue: `${dayjs().startOf('month').format('YYYY-MM-DD')}`,
+        required: false,
+    }),
+    to: core_1.Flags.string({
+        description: 'to date (ISO8601)',
+        helpValue: `${dayjs().endOf('month').format('YYYY-MM-DD')}`,
+        required: false,
+        dependsOn: ['from'],
+    }),
+    out: core_1.Flags.file({
+        char: 'o',
+        aliases: ['output'],
+        description: 'file path to save the output',
+        required: true,
+        default: './bananareporter.json',
+    }),
+    format: core_1.Flags.string({
+        description: 'output file format',
+        options: Object.values(core_2.BananaOutputFileFormat.Values),
+        required: true,
+        default: core_2.BananaOutputFileFormat.Enum.json,
+    }),
+    delay: core_1.Flags.integer({
+        description: 'global delay in millisecons between http requests',
+        default: 300,
+    }),
+    'include-raw-object': core_1.Flags.boolean({
+        description: 'include raw object in json/jsonl reporter output',
+        default: false,
+    }),
+    'disable-welcome-emoji': core_1.Flags.boolean({
+        description: 'disable banana welcome emoji',
+        default: false,
+        hidden: true,
+    }),
+};

package/dist/core/index.d.ts

@@ -0,0 +1,140 @@
+import { z } from 'zod';
+export declare const BananaOutputFileFormat: z.ZodEnum<["json", "jsonl", "csv"]>;
+export type BananaOutputFileFormat = z.infer<typeof BananaOutputFileFormat>;
+export declare const BananaConfig: z.ZodEffects<z.ZodEffects<z.ZodObject<{
+    includeRawObject: z.ZodDefault<z.ZodBoolean>;
+    format: z.ZodEnum<["json", "jsonl", "csv"]>;
+    out: z.ZodString;
+    /**
+       * ISO8601 date range for all the sources,
+       * can be overridden per source
+       */
+    from: z.ZodString;
+    to: z.ZodString;
+    /**
+       * banana reporter configuration file path
+       */
+    configFileLocation: z.ZodString;
+    /**
+       * delay in seconds between every HTTP requests (sources)
+       */
+    delay: z.ZodDefault<z.ZodNumber>;
+    /**
+       * where to fetch data
+       */
+    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">;
+}, "strip", z.ZodTypeAny, {
+    format: "json" | "csv" | "jsonl";
+    from: string;
+    out: string;
+    includeRawObject: boolean;
+    to: string;
+    configFileLocation: string;
+    delay: number;
+    sources: [{
+        type: "gitlab" | "github" | "todo.txt";
+    } & {
+        [k: string]: unknown;
+    }, ...({
+        type: "gitlab" | "github" | "todo.txt";
+    } & {
+        [k: string]: unknown;
+    })[]];
+}, {
+    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;
+    })[]];
+}>, {
+    format: "json" | "csv" | "jsonl";
+    from: string;
+    out: string;
+    includeRawObject: boolean;
+    to: string;
+    configFileLocation: string;
+    delay: number;
+    sources: [{
+        type: "gitlab" | "github" | "todo.txt";
+    } & {
+        [k: string]: unknown;
+    }, ...({
+        type: "gitlab" | "github" | "todo.txt";
+    } & {
+        [k: string]: unknown;
+    })[]];
+}, {
+    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;
+    })[]];
+}>, {
+    format: "json" | "csv" | "jsonl";
+    from: string;
+    out: string;
+    includeRawObject: boolean;
+    to: string;
+    configFileLocation: string;
+    delay: number;
+    sources: [{
+        type: "gitlab" | "github" | "todo.txt";
+    } & {
+        [k: string]: unknown;
+    }, ...({
+        type: "gitlab" | "github" | "todo.txt";
+    } & {
+        [k: string]: unknown;
+    })[]];
+}, {
+    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;
+    })[]];
+}>;
+export type BananaConfig = z.infer<typeof BananaConfig>;
+export declare function loadAndValidateConfig(input: unknown): BananaConfig;

package/dist/core/index.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadAndValidateConfig = exports.BananaConfig = exports.BananaOutputFileFormat = void 0;
+const dayjs = require("dayjs");
+const zod_1 = require("zod");
+const base_1 = require("../integrations/base");
+const common_1 = require("../util/common");
+const logger_1 = require("../util/logger");
+exports.BananaOutputFileFormat = zod_1.z.enum(['json', 'jsonl', 'csv']);
+exports.BananaConfig = zod_1.z.object({
+    includeRawObject: zod_1.z.boolean().default(false),
+    format: exports.BananaOutputFileFormat,
+    out: zod_1.z.string().min(1),
+    /**
+       * ISO8601 date range for all the sources,
+       * can be overridden per source
+       */
+    from: common_1.zIsoString,
+    to: common_1.zIsoString,
+    /**
+       * banana reporter configuration file path
+       */
+    configFileLocation: zod_1.z.string().min(1),
+    /**
+       * delay in seconds between every HTTP requests (sources)
+       */
+    delay: zod_1.z.number().min(0).max(5000).default(300),
+    /**
+       * where to fetch data
+       */
+    sources: zod_1.z.array(zod_1.z.object({
+        type: base_1.SourceType,
+    }).passthrough()).nonempty(),
+}).refine(schema => {
+    const dateFrom = dayjs(schema.from);
+    const dateTo = dayjs(schema.to);
+    return dateFrom.isSame(dateTo) || dateFrom.isBefore(dateTo);
+}, "'from' date must be before 'to' date")
+    .refine(schema => {
+    return !(schema.includeRawObject && (schema.format !== exports.BananaOutputFileFormat.Enum.json && schema.format !== exports.BananaOutputFileFormat.Enum.jsonl));
+}, "'include-raw-object' can only be used with json or jsonl format");
+function loadAndValidateConfig(input) {
+    logger_1.logger.debug('loadAndValidateConfig input', input);
+    const validated = exports.BananaConfig.parse(input);
+    return validated;
+}
+exports.loadAndValidateConfig = loadAndValidateConfig;

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { run } from '@oclif/core';

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = void 0;
+var core_1 = require("@oclif/core");
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return core_1.run; } });

package/dist/integrations/base.d.ts

@@ -0,0 +1,19 @@
+import { z } from 'zod';
+import { BananaConfig } from '../core';
+export declare const SourceType: z.ZodEnum<["gitlab", "github", "todo.txt"]>;
+export type SourceType = z.infer<typeof SourceType>;
+export interface CommonBananaReporterObj {
+    date: string;
+    description: string;
+    username?: string;
+    projectId?: string;
+    projectName?: string;
+    type: SourceType;
+    __raw: any;
+}
+export declare abstract class IntegrationBase {
+    static type: SourceType;
+    constructor(_rawConfig: unknown, _bananaConfig: BananaConfig);
+    toBananaReporterObj(_rawData: any): Promise<CommonBananaReporterObj> | CommonBananaReporterObj;
+    fetchData(): Promise<CommonBananaReporterObj[]>;
+}

package/dist/integrations/base.js

@@ -0,0 +1,18 @@
+"use strict";
+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']);
+// TODO improve base integration
+class IntegrationBase {
+    // eslint-disable-next-line no-useless-constructor, @typescript-eslint/no-empty-function
+    constructor(_rawConfig, _bananaConfig) { }
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+    toBananaReporterObj(_rawData) {
+        throw new Error('implement toBananaReporterObj method');
+    }
+    async fetchData() {
+        throw new Error('implement fetchData method');
+    }
+}
+exports.IntegrationBase = IntegrationBase;