@beauraines/toggl-cli 0.10.12 → 0.10.13

package/.eslintrc.json

@@ -4,7 +4,7 @@
         "es2021": true,
         "node": true
     },
-    "extends": "standard",
+    "extends": "eslint:recommended",
     "overrides": [
     ],
     "parserOptions": {

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.10.13](https://github.com/beauraines/toggl-cli/compare/v0.10.12...v0.10.13) (2023-04-01)
+
+
+### Features
+
+* Improve table layout ([4652fc3](https://github.com/beauraines/toggl-cli/commit/4652fc3f5e54ca6f0031dfcc035746147b028a5d)), closes [#56](https://github.com/beauraines/toggl-cli/issues/56)
+
 ### [0.10.12](https://github.com/beauraines/toggl-cli/compare/v0.10.11...v0.10.12) (2023-03-23)
 
 ### [0.10.11](https://github.com/beauraines/toggl-cli/compare/v0.10.10...v0.10.11) (2023-03-19)

package/cmds/ls.mjs

@@ -40,11 +40,23 @@ export const handler = async function (argv) {
   })
 
   const table = new Table({
-    head: ['description', 'start', 'stop', 'duration']
+    head: ['Description', 'Start', 'Stop', 'Duration'],
+    chars: { mid: '', 'left-mid': '', 'mid-mid': '', 'right-mid': '' }
   })
-  for (const entry of report) {
-    table.push([entry.description, entry.start, entry.stop, entry.duration])
+  for (let i = 0; i < report.length; i++) {
+    // First row chars
+    const chars = {
+      midMid: '┼',
+      mid: '─',
+      leftMid: '├',
+      rightMid: '┤'
+    }
+    const entry = report[i]
+    if (i === 0) {
+      table.push([entry.description, entry.start, entry.stop, entry.duration].map((content) => ({ content, chars })))
+    } else {
+      table.push([entry.description, entry.start, entry.stop, entry.duration])
+    }
   }
   console.log(table.toString())
-  // console.table(report, ['description', 'start', 'stop', 'duration'])
 }

package/cmds/today.mjs

@@ -1,4 +1,5 @@
 import Client from '../client.js'
+import chalk from 'chalk'
 import dayjs from 'dayjs'
 import { getWorkspace, getProjects, formatDuration, formatDurationAsTime } from '../utils.js'
 import dur from 'dayjs/plugin/duration.js'
@@ -79,10 +80,25 @@ function displayDailyReport (report, format) {
     case 'table':
     default:
       const table = new Table({
-        head: ['Project', 'Duration']
+        head: ['Project', 'Duration'],
+        chars: { mid: '', 'left-mid': '', 'mid-mid': '', 'right-mid': '' }
       })
-      for (const project of report) {
-        table.push([project.project_name, project.duration_formatted])
+      for (let i = 0; i < report.length; i++) {
+        // First row chars
+        const chars = {
+          midMid: '┼',
+          mid: '─',
+          leftMid: '├',
+          rightMid: '┤'
+        }
+        const project = report[i]
+        if (i == 0) {
+          table.push([project.project_name, project.duration_formatted].map((content) => ({ content: chalk.grey(content), chars })))
+        } else if ( i == report.length - 1) {
+          table.push([project.project_name, project.duration_formatted].map((content) => ( {content: chalk.bold(content), chars })))
+        } else {
+          table.push([chalk.grey(project.project_name), chalk.grey(project.duration_formatted)])
+        }
       }
       console.log(table.toString())
       break

package/cmds/weekly.mjs

@@ -1,4 +1,5 @@
 import Client from '../client.js'
+import chalk from 'chalk'
 import { getWorkspace, formatDuration, getProjectById } from '../utils.js'
 import dayjs from 'dayjs'
 import dur from 'dayjs/plugin/duration.js'
@@ -58,10 +59,25 @@ export const handler = async function (argv) {
 
   const head = Object.keys(reportData[0])
   const table = new Table({
-    head
+    head,
+    chars: { mid: '', 'left-mid': '', 'mid-mid': '', 'right-mid': '' }
   })
-  for (const project of reportData) {
-    table.push(Object.values(project))
+  for (let i = 0; i < reportData.length; i++) {
+    // First row chars
+    const chars = {
+      midMid: '┼',
+      mid: '─',
+      leftMid: '├',
+      rightMid: '┤'
+    }
+    const project = reportData[i]
+    if (i == 0 ) {
+      table.push(Object.values(project).map((content) => ({ content: chalk.grey(content), chars })))
+    } else if ( i == reportData.length - 1) {
+      table.push(Object.values(project).map((content) => ( {content: chalk.bold(content), chars })))
+    } else {
+      table.push(Object.values(project).map((content) => ({ content: chalk.grey(content) })))
+    }
   }
   console.log(table.toString())
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beauraines/toggl-cli",
-  "version": "0.10.12",
+  "version": "0.10.13",
   "description": "",
   "main": "cli.js",
   "bin": {
@@ -8,7 +8,7 @@
   },
   "scripts": {
     "test": "jest",
-    "lint": "eslint . ./**/*.js ./**/*.js",
+    "lint": "eslint . ./**/*.js ./**/*.mjs",
     "lint:fix": "eslint . ./**/*.js ./**/*.mjs --fix",
     "release": "standard-version",
     "should-release": "should-release"
@@ -30,6 +30,7 @@
   },
   "license": "MIT",
   "dependencies": {
+    "chalk": "^4.0.0",
     "cli-table3": "^0.6.3",
     "dayjs": "^1.11.6",
     "debug": "^4.3.4",

package/.env.foo

@@ -1,3 +0,0 @@
-TOGGL_API_TOKEN=1d0ef68975e582dae8d132190821e3a5
-TOGGL_DEFAULT_WORKSPACE_ID=403916
-TOGGL_TIMEZONE=America/Los_Angeles

package/database.js

@@ -1,70 +0,0 @@
-const homedir = require('os').homedir();
-const sqlite = require('sqlite');
-const sqlite3 = require('sqlite3');
-const {fileExists} = require('./helpers');
-
-/**
- * Opens the BurnDownStatus SQLite3 Database
- * @param file file name of the SQLite3 DB. If not provided, defaults to ${homedir}/BurnDownStatus.db
- * @returns SQLite database connection
- */
-async function getDBConnection(file) {
-    file = file ? file : `${homedir}/BurnDownStatus.db`;
-    if (!await fileExists(file)){
-        console.error(`${file} not found`);
-        process.exit(1);
-    }
-    const db = await sqlite.open({
-        filename: `${homedir}/BurnDownStatus.db`,
-        driver: sqlite3.Database
-    });
-    return db;
-}
-
-/**
- * 
- * @param {Object} data The burndown data to be inserted into the Burndown database
- * 
- * @returns {Object} The result of the database running the provided query
- */
-async function writeToDb(data) {
-    // TODO should take db, query and values as parameters
-    let db = await getDBConnection();
-    let query = `insert into qa_burndown (date, qa_review_count, qa_validated_count) values (?,?,?) on conflict do update set qa_review_count = excluded.qa_review_count, qa_validated_count = excluded.qa_validated_count`;
-
-    let values = [data.date, data.qa_review_count, data.qa_validated_count];
-    let result = await db.run(query, values);
-    await db.close();
-    return result;
-
-}
-
-
-async function insert(database,table,data) {
-    let db = await getDBConnection(database);
-
-    let fields = Object.keys(data[0]).toString();
-    let fieldsCount = Object.keys(data[0]).length;
-    let valueSubstitution = Array(fieldsCount).fill('?').toString();
-
-    //TODO figure out how to build upsert
-    // on conflict do update set qa_review_count = excluded.qa_review_count, qa_validated_count = excluded.qa_validated_count`;
-    let query = `insert into ${table}  (${fields}) values (${valueSubstitution});`
-    let result = []
-    data.forEach(async (row) => {
-        // TODO add try/catch for SQL error errno and code
-        // TODO switch to db.exec() for more meaningful response
-        let response = await db.run(query,Object.values(row));
-        result.push(response);
-    });
-    await db.close();
-    // TODO clean up result
-    return result;
-}
-
-
-module.exports = {
-    getDBConnection,
-    writeToDb,
-    insert
-}

package/helpers.js

@@ -1,72 +0,0 @@
-const fs = require('fs');
-
-/**
- * Converts a string to Title Case, using whitespace as the delimiter
- * @param {String} str String to convert
- * @returns The string converted to title case
- */
-function toTitleCase(str) {
-    return str.replace(
-      /\w\S*/g,
-      function(txt) {
-        return txt.charAt(0).toUpperCase() + txt.substring(1).toLowerCase();
-      }
-    );
-}
-
-/**
- * Removes newline characters \r and/or \n from a string
- * @param {string} string to remove newlines from
- * @returns string
- */
-function stripNewLines(string) {
-  return string.replace(/\r|\n/g, '');
-}
-
-/**
- * Checks to see if the specified file exists
- * @param {string} filePath fully qualified path and filename 
- * @returns Boolean
- */
-async function fileExists(filePath) {
-    return fs.existsSync(filePath);
-}
-
-/**
- * Asynchronously reads the entire file contents and returns it.
- * @param {string} filePath fully qualified path and filename
- * @returns any
- */
-async function readFile(filePath) {
-  return fs.readFileSync(filePath,{ encoding: 'utf8', flag: 'r' });
-}
-
-/**
- * Groups an array by specified properties and sums other specified properties
- * 
- * https://stackoverflow.com/questions/46794232/group-objects-by-multiple-properties-in-array-then-sum-up-their-values
- * 
- * @param {Array} arr Array of Objects to aggregate
- * @param {Array} groupKeys keys to group by
- * @param {Array} sumKeys keys of properties to sum by
- * @returns Array of Objects
- */
- function groupAndSum(arr, groupKeys, sumKeys){
-  return Object.values(
-    arr.reduce((acc,curr)=>{
-      const group = groupKeys.map(k => curr[k]).join('-');
-      acc[group] = acc[group] || Object.fromEntries(
-         groupKeys.map(k => [k, curr[k]]).concat(sumKeys.map(k => [k, 0])));
-      sumKeys.forEach(k => acc[group][k] += curr[k]);
-      return acc;
-    }, {})
-  );
-}
-
-module.exports = {
-    groupAndSum,
-    toTitleCase,
-    fileExists,
-    stripNewLines,
-    readFile
-}

package/toggl.credentials

@@ -1,5 +0,0 @@
-{
-    "token": "1d0ef68975e582dae8d132190821e3a5",
-    "defaultWorkspaceId": "403916",
-    "timezone": "America/Los_Angeles"
-}