@beauraines/toggl-cli 0.10.22 → 2.0.0

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 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.
 
+## [2.0.0](https://github.com/beauraines/toggl-cli/compare/v0.10.22...v2.0.0) (2023-07-08)
+
+
+### ⚠ BREAKING CHANGES
+
+* ready for version 1.0.0
+Reads configuration (API token, timezone, default workspace and projects) from `.toggl-cli.json` from the users home. Adds a command to create the configuration file.
+
+### Features
+
+* Adds configuration file ([#91](https://github.com/beauraines/toggl-cli/issues/91)) ([b7d70bf](https://github.com/beauraines/toggl-cli/commit/b7d70bfdb60aa9353e4da18f85e8b279ddf8bf34))
+
 ### [0.10.22](https://github.com/beauraines/toggl-cli/compare/v0.10.21...v0.10.22) (2023-07-08)
 
 

package/README.md

@@ -8,65 +8,52 @@ This was made possible because [saintedlama](https://github.com/saintedlama) had
 
 ## Configuration
 
-1. Configure your environment, with environment variables or a `.env` file in the project root. Eventually, these will be read from a config file as an alternative
+### Configuration File
+
+You can create the `.toggl-cli.json` in your home directory manually using the template below or with the `toggl create-config` command. The values can be found in your Toggl [profile](https://track.toggl.com/profile) and from the URL for your account settings. The current workspace id is `https://track.toggl.com/${workspace_id}}/settings/general`. Don't forget to change the permissions `chmod 600` so that only you can read/write the configuration file as it has your API token.
+
+```json
+{
+  "api_token": "",
+  "default_workspace_id": "",
+  "timezone": "",
+  "default_project_id": ""
+}
+```
+### Environment Variables
+
+Configure your environment, with environment variables or a `.env` file in the project root. Environment variables will take precedence over a config file.
+
 1. `TOGGL_API_TOKEN` (required)
 2. `TOGGL_DEFAULT_WORKSPACE_ID` (required)
 3. `TOGGL_DEFAULT_PROJECT_ID` (optional)
 4. `TOGGL_TIMEZONE=America/Los_Angeles` (defaults to `America/New_York`)
-## Dependencies
-
-1. toggl-client - Used from [saintedlama/toggl-client](https://github.com/saintedlama/toggl-client) repository as the latest code hasn't been released to npm
-3. dotenv
-4. yargs
-
 
 
 ## Features
 
-| Feature                              | Available | Comments                                                    |
-| ------------------------------------ | --------- | ----------------------------------------------------------- |
-| Start time entry                     | ✅         |                                                             |
-| Start time entry with description    | ✅         |                                                             |
-| Start time entry with project        | ✅         |                                                             |
-| stop time entry                      | ✅         |                                                             |
-| Continue named time entry            | ✅         |                                                             |
-| Report today by project              | ✅         |                                                             |
-| Report this week by project by day   | ✅         |                                                             |
-| Edit time entry                      | ✅         |                                                             |
-| Use config from file                 |           |                                                             |
-| Save config to file                  |           |                                                             |
-| Refactor: Display and format modules |           |                                                             |
-| Client: reset PAT                    |           |                                                             |
-| Client: other user feature?          |           |                                                             |
-| Client: specify client name          |           |                                                             |
-| Colorize output                      |           |                                                             |
-| Better table output                  | ✅        |                                                             |
-| List recent time entries             | ✅         |                                                             |
-| Command line completion              | ✅         | [#6](https://github.com/beauraines/toggl-cli-node/issues/6) |
-
-## Development Road Map
-
-Priority order... I think.
-
-1. ~today - improve the output~
-2. ~weekly - improve the output format~
-3. ~now - format the display time entry output~
-4. ~toggl continue~
-5. ~duration to display helper function?~
-6. read configuration (token, default workspace) from files (client and utils)
-7. now - update running description, project, start time
-8. now - update start time with overlap detection and adjust prior time entry
-9. project list - format the output, group by client
-10. Add ability to lookup project by name not just id
-11. start - add project name to output, add time started
-12. toggl workspace add - this command is not yet supported.
-13. toggl workspace list - improve output 
-14. colorized output
-15. config - some way to save /me information to a file
-    1.  default workspace?
-    2.  API key?
-    3.  display formats?
-16. toggl project add - this command is not yet supported.
+| Feature                                  | Available | Comments                                                    |
+| ---------------------------------------- | --------- | ----------------------------------------------------------- |
+| Start time entry                         | ✅         |                                                             |
+| Start time entry with description        | ✅         |                                                             |
+| Start time entry with project            | ✅         |                                                             |
+| stop time entry                          | ✅         |                                                             |
+| Continue named time entry                | ✅         |                                                             |
+| Report today by project                  | ✅         |                                                             |
+| Report this week by project by day       | ✅         |                                                             |
+| Edit current time entry                  | ✅         |                                                             |
+| Use config from file                     | ✅         |                                                             |
+| Save config to file                      | ✅         |                                                             |
+| Refactor: Display and format modules     |            |                                                             |
+| Client: reset PAT                        |            | Is this really necessary?                                   |
+| Client: specify client name              | ✅         |                                                             |
+| Colorize output                          | ✅         |                                                             |
+| Better table output                      | ✅         |                                                             |
+| List recent time entries                 | ✅         |                                                             |
+| Command line completion                  | ✅         | [#6](https://github.com/beauraines/toggl-cli-node/issues/6) |
+| Delete time entry by id                  |            |                                                             |
+| Edit other time entries than the current |            |                                                             |
+| Display earlier time entries             |            |                                                             |
 
 
 

package/client.js

@@ -1,29 +1,33 @@
 import dotenv from 'dotenv'
 import togglClient from 'toggl-client'
+import { readConfig } from './config.js'
 dotenv.config()
+import debugClient from 'debug'
+const debug = debugClient('toggl-cli-client')
 
-export default function () {
-  if (!process.env.TOGGL_API_TOKEN) {
-    console.log('TOGGL_API_TOKEN environment variable is not set.')
-    console.log('For development, it can be set in the .env file in the project root')
+
+export default async function () {
+  let  conf
+  try {
+    conf = await readConfig('.toggl-cli.json')
+    debug(conf)
+  } catch (error) {
+    console.error('Using config from environment variables or create one with the create-config command')
   }
 
-  // TODO Try to read rc file
+  const apiToken = process.env.TOGGL_API_TOKEN || conf?.api_token
+  debug(apiToken)
 
-  // FIXME apiToken is not needed
-  const apiToken = process.env.TOGGL_API_TOKEN
-  const client = togglClient()
-  // const client = togglClient({ apiToken });
-  // ? Why doesn't a try/catch block work?
-  // try {
-  //     const client = togglClient({ apiToken });
-  // } catch (error) {
-  //    console.error(error);
-  // }
-  if (!client) {
-    console.error('There was a problem')
-    process.exit(1)
-  }
+  let client
+  try {
+      client = togglClient({ apiToken });
+  } catch (error) {
+     console.error(error.message);
+     console.error('There was a problem')
+     process.exit(1)
+   }
 
   return client
 }
+
+

package/cmds/continue.mjs

@@ -16,7 +16,7 @@ export const builder = {
 }
 
 export const handler = async function (argv) {
-  const client = Client()
+  const client = await Client()
   const timeEntries = await client.timeEntries.list(
     {
       start_date: dayjs().subtract(14, 'days').toISOString(),

package/cmds/create-config.mjs

@@ -0,0 +1,28 @@
+import { createConfig } from '../config.js'
+import debugClient from 'debug';
+
+const debug = debugClient('toggl-cli-create-config');
+
+export const command = 'create-config'
+export const desc = 'Creates a boilerplate .toggl-cli.json configuration file in your home directory.'
+export const builder = {}
+
+export const handler = async function (argv) {
+    const configProps = [ 
+        "api_token",
+        "default_workspace_id",
+        "timezone",
+        "default_project_id"
+    ]
+
+    let configFile
+    try {
+        configFile = await createConfig('.toggl-cli.json',configProps)
+        console.log(`Configuration file written to ${configFile} in your home directory`)
+        console.log(`Edit with your user information from Toggl.`)
+    } catch (error) {
+        console.error(error.message)
+        process.exit(1)
+    }
+
+}

package/cmds/currentTimeEntry.mjs

@@ -9,7 +9,7 @@ export const desc = 'Displays the current running time entry'
 export const builder = {}
 
 export const handler = async function (argv) {
-  const client = new Client()
+  const client = await Client()
   const currentTimeEntry = await client.timeEntries.current()
   if (currentTimeEntry) {
     debug(currentTimeEntry)

package/cmds/edit.mjs

@@ -27,7 +27,7 @@ export const handler = async function (argv) {
     yargs().help()
     yargs().exit(1, new Error('At least one option must be provided, description, project, start or end'))
   }
-  const client = new Client()
+  const client = await Client()
   const currentTimeEntry = await client.timeEntries.current()
   debug(currentTimeEntry)
   const params = {}

package/cmds/index.mjs

@@ -10,6 +10,7 @@ import * as startTimeEntry from './startTimeEntry.mjs'
 import * as stopTimeEntry from './stopTimeEntry.mjs'
 import * as today from './today.mjs'
 import * as weekly from './weekly.mjs'
+import * as createConfig from './create-config.mjs'
 export const commands = [
   continueEntry,
   current,
@@ -22,5 +23,6 @@ export const commands = [
   today,
   web,
   weekly,
-  workspace
+  workspace,
+  createConfig
 ]

package/cmds/ls.mjs

@@ -16,7 +16,7 @@ export const builder = {
 
 export const handler = async function (argv) {
   debug(argv)
-  const client = Client()
+  const client = await Client()
   const days = argv.today ? 0 : argv.days
   let timeEntries = await client.timeEntries.list({
     start_date: dayjs().subtract(days, 'days').startOf('day').toISOString(),

package/cmds/me.mjs

@@ -6,7 +6,7 @@ export const desc = 'Displays the current user'
 export const builder = {}
 
 export const handler = async function (argv) {
-  const client = Client()
+  const client = await Client()
   const currentUser = await client.user.current()
   // console.log(currentUser);
 

package/cmds/projects/list.mjs

@@ -8,7 +8,7 @@ export const builder = {
 }
 
 export const handler = async function (argv) {
-  const client = Client()
+  const client = await Client()
   const workspaces = await client.workspaces.list()
 
   const workspace = workspaces[0]

package/cmds/stopTimeEntry.mjs

@@ -6,7 +6,7 @@ export const desc = 'Stops the current running time entry'
 export const builder = {}
 
 export const handler = async function (argv) {
-  const client = Client()
+  const client = await Client()
   const currentTimeEntry = await client.timeEntries.current()
   if (currentTimeEntry) {
     const stopped = await client.timeEntries.stop(currentTimeEntry)

package/cmds/today.mjs

@@ -13,7 +13,7 @@ export const desc = 'Reports today\'s activities by project'
 export const builder = {}
 
 export const handler = async function (argv) {
-  const client = Client()
+  const client = await Client()
   const workspace = await getWorkspace()
   const projects = await getProjects(workspace.id)
   const params = {

package/cmds/weekly.mjs

@@ -20,7 +20,7 @@ export const builder = {
 }
 
 export const handler = async function (argv) {
-  const client = Client()
+  const client = await Client()
   const workspace = await getWorkspace()
 
   const weekOffset = argv.previous ? 1 : 0

package/cmds/workspaces/list.mjs

@@ -8,7 +8,7 @@ export const builder = {
 }
 
 export const handler = async function (argv) {
-  const client = Client()
+  const client = await Client()
   const workspaces = await client.workspaces.list()
   console.log(workspaces)
 }

package/config.js

@@ -0,0 +1,82 @@
+import fs from 'fs';
+import {homedir} from 'os';
+import path from 'path';
+
+/**
+ * Reads the specified config file from the users home directory
+ * 
+ * @param {string} configFile file name for the JSON config file, from the users home directory
+ * 
+ * @returns {Promise} the configuration object
+ * 
+ * @throws {Error} if configuration file not found.
+ */
+export const readConfig = async (configFile) => {
+    configFile = path.join(homedir(),configFile)
+	let config
+	if ( await fs.existsSync(configFile) ) {
+		config = fs.readFileSync(configFile,
+			{ encoding: 'utf8', flag: 'r' });
+		config = JSON.parse(config);
+	} else {
+        throw new Error(`Config file not found. You must create one using the config command`)
+	}
+	
+	return config
+}
+
+/**
+ * Validates the config file to ensure that it has all of the required properties specified. This 
+ * is only schema validation, it does not check if the properties are valid values or data types.
+ * 
+ * @param {string} configFile file name for the JSON config file, from the users home directory
+ * @param {Array} configProps an array of properties that defines a valid config file
+ * 
+ * @throws {Configuration file not found}
+ * @throws {Invalid configuration file}
+ * @returns {boolean} 
+ */
+export const validateConfig = async (configFile, configProps) => {
+    configFile = path.join(homedir(),configFile)
+    if (! fs.existsSync(configFile) ) {
+        throw new Error('Configuration file not found')
+    }
+    let config
+    config = fs.readFileSync(configFile,
+        { encoding: 'utf8', flag: 'r' });
+    config = JSON.parse(config);
+    // Check for properties
+    let validConfig = true
+    for (const key of configProps) {
+        validConfig = config[key] ? true : false
+    }
+
+    if (!validConfig) {
+        throw Error('Invalid configuration file')
+    }
+    return validConfig
+}
+
+/**
+ * Creates a boilerplate config file in the user's home directory
+ * 
+ * @param {string} configFile file name for the JSON config file, from the users home directory
+ * @param {Array} configProps an array of properties that defines a valid config file
+ * 
+ * @returns {string} Fully qualified path to configuration file
+ * 
+ * @throws {error} if the file already exists
+ * 
+ */
+export const createConfig = async (configFile,configProps) => {
+    configFile = path.join(homedir(),configFile)
+    if ( await fs.existsSync(configFile) ) {
+        throw Error('File already exists. Will not overwrite')
+    }
+    let config = {}
+    for (const key of configProps) {
+        config[key] = ''
+    }
+    fs.writeFileSync(configFile,JSON.stringify(config, null, 2))
+    return configFile
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@beauraines/toggl-cli",
-  "version": "0.10.22",
-  "description": "",
+  "version": "2.0.0",
+  "description": "CLI client for Toggl Time Tracker",
   "main": "cli.js",
   "bin": {
     "toggl": "./cli.js"

package/standalone/currentTimeEntry.js

@@ -4,7 +4,7 @@ import dotenv from 'dotenv'
 dotenv.config()
 
 async function main () {
-  const client = new Client()
+  const client = await Client()
   const currentTimeEntry = await client.timeEntries.current()
   await displayTimeEntry(currentTimeEntry)
 }

package/standalone/startTimeEntry.js

@@ -28,7 +28,7 @@ async function main () {
 }
 
 async function createTimeEntry (params) {
-//   const client = Client()
+//   const client = await Client()
   const timeEntry = await client.timeEntries.create(
     {
       description: params.description,

package/utils.js

@@ -4,43 +4,49 @@ import dayjs from 'dayjs'
 import utc  from "dayjs/plugin/utc.js";
 import timezone from 'dayjs/plugin/timezone.js';
 import duration from 'dayjs/plugin/duration.js';
+import { readConfig } from './config.js'
 dayjs.extend(utc);
 dayjs.extend(timezone);
 dayjs.extend(duration);
 
-// TODO read from file or GET /me
-export const defaultWorkspaceId = process.env.TOGGL_DEFAULT_WORKSPACE_ID
+let conf
+try {
+  conf = await readConfig('.toggl-cli.json')
+} catch (error) {
+  console.error('Using config from environment variables or create one with the create-config command')
+}
+
+export const defaultWorkspaceId = process.env.TOGGL_DEFAULT_WORKSPACE_ID || conf.default_workspace_id 
 
-// TODO read from file or ENV
-export const defaultProjectId = process.env.TOGGL_DEFAULT_PROJECT_ID
+export const defaultProjectId = process.env.TOGGL_DEFAULT_PROJECT_ID || conf.default_project_id
 
 export const getProjects = async function (workspaceId) {
-  const client = Client()
+  const client = await Client()
   const projects = await client.workspaces.projects(workspaceId)
   const activeProjects = projects.filter(x => x.active)
   return activeProjects
 }
 
 export const getWorkspace = async function () {
-  const client = Client()
+  const client = await Client()
   const workspaces = await client.workspaces.list()
   return workspaces[0]
 }
 
 export const getProjectByName = async function (workspaceId, string) {
-  const client = Client()
+  const client = await Client()
   const projects = await client.workspaces.projects(workspaceId)
   return projects.find(x => x.name.toLowerCase().includes(string.toLowerCase()))
 }
 
 export const getProjectById = async function (workspaceId, projectId) {
-  const client = Client()
+  const client = await Client()
   const projects = await client.workspaces.projects(workspaceId)
   return projects.find(x => x.id == projectId)
 }
 
 export const createTimeEntry = async function (params) {
-  const client = Client()
+  const client = await Client()
 
   const timeEntry = await client.timeEntries.create(
     {
@@ -90,7 +96,7 @@ export const formatDurationAsTime = function (milliseconds) {
  * @returns {String}
  */
 export const convertUtcTime = function (dateTime) {
-  const tz = process.env.TOGGL_TIMEZONE || 'America/New_York'
+  const tz = process.env.TOGGL_TIMEZONE || conf?.timezone || 'America/New_York'
   return dayjs(dateTime).tz(tz).format('YYYY-MM-DD HH:mm')
 }
 
@@ -119,7 +125,7 @@ export const displayTimeEntry = async function (timeEntry) {
 
     console.info(`Project: ${project?.name} (#${timeEntry.pid})`);
 
-    const tz = process.env.TOGGL_TIMEZONE || 'America/New_York'
+    const tz = process.env.TOGGL_TIMEZONE || conf?.timezone || 'America/New_York'
     const startTimeFormatted = dayjs(timeEntry.start).tz(tz).format('YYYY-MM-DD HH:mm')
     const stopTimeFormatted = timeEntry.stop ? dayjs(timeEntry.stop).tz(tz).format('YYYY-MM-DD HH:mm') : 'Currently Running'