bananareporter 0.1.0 → 0.1.2

package/README.md

@@ -1,13 +1,17 @@
-Banana Reporter
-=================
 
-Create a report in CSV, JSON/L from multiple sources (e.g. GitLab, GitHub, todo.txt etc.)
+<p align="center">
+<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>
 
-[![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)
+<p align="center">
+  <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://github.com/nya1/bananareporter/blob/main/package.json"><img src="https://img.shields.io/npm/l/bananareporter.svg" alt="License"/></a>
+</p>
 
 <!-- toc -->
 * [Features](#features)
@@ -21,7 +25,16 @@ Create a report in CSV, JSON/L from multiple sources (e.g. GitLab, GitHub, todo.
 - **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_
+- **Sources Supported**
+  - GitLab: commits
+  - GitHub: commits
+  - todo.txt: tasks
+  - **[Request a new source](https://github.com/nya1/bananareporter/issues/new?assignees=&labels=enhancement&template=new-source-request.md&title=)**
+
+## Use cases
+
+- create a PDF work report based on commits and tasks
+- get insights on your activity 
 
 # Quickstart
 
@@ -48,13 +61,13 @@ sources:
   #   file: './todo.txt'
 ```
 
-2. Run the reporter with a date range
+2. Run the reporter with a date range (ISO8601 date)
 
 ```sh
 bananareporter --from 2023-01-01 --to 2023-03-01 -c bananareporter.yaml
 ```
 
-In the current directory you can find the `bananareporter.json` output
+In the current directory you will find the output as `bananareporter_$FROM__$TO.json`, can be changed with `--out`
 
 
 # Usage
@@ -64,7 +77,7 @@ $ npm install -g bananareporter
 $ bananareporter COMMAND
 running command...
 $ bananareporter (--version)
-bananareporter/0.1.0 linux-x64 node-v18.14.2
+bananareporter/0.1.2 linux-x64 node-v18.14.2
 $ bananareporter --help [COMMAND]
 USAGE
   $ bananareporter COMMAND
@@ -107,7 +120,7 @@ USAGE
 
 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
+  -o, --out=<value>     (required) [default: ./bananareporter_$FROM__$TO.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>
@@ -123,5 +136,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.0/dist/commands/run/index.ts)_
+_See code: [dist/commands/run/index.ts](https://github.com/nya1/bananareporter/blob/v0.1.2/dist/commands/run/index.ts)_
 <!-- commandsstop -->

package/dist/commands/run/index.js

@@ -96,7 +96,10 @@ class Run extends core_1.Command {
         // add file extension
         if (!outFile.endsWith(fileExt)) {
             if (outFile === Run.flags.out.default) {
-                outFile = outFile.replace(`.${Run.flags.format.default}`, fileExt);
+                outFile = outFile
+                    .replace(`.${Run.flags.format.default}`, fileExt)
+                    .replace('$FROM', validatedConfig.from)
+                    .replace('$TO', validatedConfig.to);
             }
             else {
                 outFile += fileExt;
@@ -138,7 +141,7 @@ Run.flags = {
         aliases: ['output'],
         description: 'file path to save the output',
         required: true,
-        default: './bananareporter.json',
+        default: './bananareporter_$FROM__$TO.json',
     }),
     format: core_1.Flags.string({
         description: 'output file format',

package/dist/integrations/gitlab.js

@@ -8,6 +8,7 @@ const zod_1 = require("zod");
 const axios_1 = require("axios");
 const dayjs = require("dayjs");
 const logger_1 = require("../util/logger");
+const objectPath = require("object-path");
 exports.GitlabConfig = zod_1.z.object({
     committerUsername: zod_1.z.string().min(1),
     userId: zod_1.z.number().optional(),
@@ -120,7 +121,13 @@ class GitlabIntegration extends base_1.IntegrationBase {
         });
         // format data to common obj
         let filteredData = eventList
-            .filter(e => e.action_name.startsWith('pushed'));
+            .filter(e => {
+            var _a;
+            return (e.action_name
+                .startsWith('pushed') &&
+                ((_a = e === null || e === void 0 ? void 0 : e.push_data) === null || _a === void 0 ? void 0 : _a.commit_title) &&
+                !e.push_data.commit_title.startsWith('Merge branch'));
+        });
         const projectsToRemove = new Set();
         for (const filter of this.config.filters || []) {
             const targetKey = filter.on;
@@ -148,12 +155,13 @@ class GitlabIntegration extends base_1.IntegrationBase {
                     return true;
                 }
                 const regex = new RegExp(filter.regex);
-                if (!(targetKey in e)) {
+                const value = objectPath.get(e, targetKey);
+                if (typeof value === 'undefined') {
                     const errorMsg = `while filtering event id ${e.id} unable to find the key ${targetKey} in the event's object (available keys: ${Object.keys(e).join(',')})`;
                     logger_1.logger.error(errorMsg);
                     throw new Error(errorMsg);
                 }
-                return regex.test(e[targetKey]);
+                return regex.test(value);
             });
         }
         if (projectsToRemove.size > 0) {

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.1.0",
+  "version": "0.1.2",
   "commands": {
     "run": {
       "id": "run",
@@ -47,7 +47,7 @@
           "description": "file path to save the output",
           "required": true,
           "multiple": false,
-          "default": "./bananareporter.json",
+          "default": "./bananareporter_$FROM__$TO.json",
           "aliases": [
             "output"
           ]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bananareporter",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Easily generate a report from multiple sources",
   "author": "nya1",
   "bin": {