@beauraines/rtm-cli 1.11.0 → 1.13.0

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 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.
 
+## [1.13.0](https://github.com/beauraines/rtm-cli/compare/v1.12.0...v1.13.0) (2025-12-17)
+
+
+### Features
+
+* **task:** human readeable recurrence and estimates ([#163](https://github.com/beauraines/rtm-cli/issues/163)) ([d78dd0a](https://github.com/beauraines/rtm-cli/commit/d78dd0a1204584a30df2f8a568c25142d93b36cc))
+
+## [1.12.0](https://github.com/beauraines/rtm-cli/compare/v1.11.0...v1.12.0) (2025-12-17)
+
+
+### Features
+
+* **task:** adds tasks as alias for task command ([#162](https://github.com/beauraines/rtm-cli/issues/162)) ([b9196ee](https://github.com/beauraines/rtm-cli/commit/b9196ee2d73680cce9ab01e39cd73e27b426fb7e)), closes [#152](https://github.com/beauraines/rtm-cli/issues/152)
+
 ## [1.11.0](https://github.com/beauraines/rtm-cli/compare/v1.10.0...v1.11.0) (2025-12-17)
 
 

package/README.md

@@ -98,7 +98,7 @@ The main usage of the program:
   setUrl|su [index] [url]                  Set the URL of a Task
   start [index] [start...]                 Set the Start Date of a Task
   tags|t                                   Display all tags
-  task [indices...]                        Display the Task details
+  task|tasks [indices...]                  Display the Task details
   uncomp|unc [indices...]                  Mark one or more Tasks as not complete
   url [options] [indices...]               Display the associated URL of a Task
   whoami                                   Display RTM user information

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beauraines/rtm-cli",
-  "version": "1.11.0",
+  "version": "1.13.0",
   "description": "RTM CLI",
   "keywords": [
     "rtm",
@@ -44,9 +44,11 @@
     "dateformat": "^4.0.0",
     "debug": "^4.3.4",
     "deepmerge": "^4.0.0",
+    "iso8601-duration": "^2.1.3",
     "open": "^8.4.2",
     "ora": "^5.0.0",
     "prompt-sync": "^4.2.0",
+    "rrule": "^2.8.1",
     "should-release": "^1.2.0",
     "standard-version": "^9.5.0",
     "window-size": "^1.1.0"

package/src/cmd/task.js

@@ -6,6 +6,7 @@ const finish = require('../utils/finish.js');
 const filter = require('../utils/filter');
 const { indexPrompt } = require('../utils/prompt')
 const debug = require('debug')('rtm-cli-task');
+const { humanizeDuration, humanizeRecurrence } = require('../utils/format');
 
 
 let TASKS = [];
@@ -83,6 +84,7 @@ async function action(args, env) {
 
 module.exports = {
   command: 'task [indices...]',
+  alias: 'tasks',
   options: [],
   description: 'Display the Task details',
   action: action
@@ -92,7 +94,7 @@ function displayTask(taskDetails) {
   debug(taskDetails)
   let index = taskDetails.index;
   // eslint-disable-next-line no-unused-vars
-  const { _list, list_id, taskseries_id, task_id, _index, name, priority, start, due, completed, isRecurring, isSubtask, estimate, url, tags, notes ,...otherAttributes } = taskDetails.task;
+  const { _list, list_id, taskseries_id, task_id, _index, name, priority, start, due, completed, isRecurring, recurrenceRuleRaw, isSubtask, estimate, url, tags, notes, ...otherAttributes } = taskDetails.task;
   
   const listName = LIST_MAP.get(list_id) || "Not found";
   
@@ -111,10 +113,15 @@ function displayTask(taskDetails) {
   log(`${completed}`)
   log.style(`Is Recurring: `,styles.index)
   log(`${isRecurring}`)
+  if (isRecurring && recurrenceRuleRaw) {
+    log.style(`Recurrence: `,styles.index)
+    log(humanizeRecurrence(recurrenceRuleRaw))
+  }
+
   log.style(`Is Subtask: `,styles.index)
   log(`${isSubtask}`)
   log.style(`Estimate: `,styles.index)
-  log(`${estimate}`)
+  log(humanizeDuration(estimate))
   log.style(`Url: `,styles.index)
   log(`${url}`)
   log.style(`Tags: `,styles.index)

package/src/tests/format.test.js

@@ -0,0 +1,64 @@
+'use strict';
+
+const { humanizeDuration, humanizeRecurrence } = require('../utils/format');
+
+describe('humanizeDuration', () => {
+  test('parses hours and minutes', () => {
+    expect(humanizeDuration('PT1H30M')).toBe('1 hour 30 minutes');
+  });
+
+  test('parses days and seconds', () => {
+    expect(humanizeDuration('P2DT15S')).toBe('2 days 15 seconds');
+  });
+
+  test('returns input for invalid strings', () => {
+    expect(humanizeDuration('invalid')).toBe('invalid');
+  });
+
+  test('returns empty for non-string', () => {
+    expect(humanizeDuration(123)).toBe('');
+  });
+});
+
+describe('humanizeRecurrence', () => {
+  test('parses daily recurrence', () => {
+    const rawRule = { $t: 'FREQ=DAILY;INTERVAL=1' };
+    expect(humanizeRecurrence(rawRule)).toMatch(/every day/i);
+  });
+
+  test('parses weekly recurrence with interval', () => {
+    const rawRule = { $t: 'FREQ=WEEKLY;INTERVAL=2;BYDAY=MO,WE' };
+    const result = humanizeRecurrence(rawRule);
+    expect(result).toMatch(/every 2 weeks on Monday, Wednesday/i);
+  });
+
+  test('parses default weekly recurrence', () => {
+    const rawRule = { every: '0', $t: 'FREQ=WEEKLY;INTERVAL=1;WKST=SU' };
+    expect(humanizeRecurrence(rawRule)).toMatch(/every week/i);
+  });
+
+  test('returns raw for invalid rule', () => {
+    const rawRule = { $t: 'invalid' };
+    expect(humanizeRecurrence(rawRule)).toBe('invalid');
+  });
+
+  test('empty when no $t', () => {
+    expect(humanizeRecurrence({ every: '1' })).toBe('');
+  });
+});
+
+describe('humanizeRecurrence additional input types', () => {
+  test('parses recurrence from stringified JSON', () => {
+    const str = '{"$t":"FREQ=WEEKLY;INTERVAL=1;WKST=SU"}';
+    expect(humanizeRecurrence(str)).toMatch(/every week/i);
+  });
+
+  test('parses recurrence from raw rule string', () => {
+    const raw = 'FREQ=DAILY;INTERVAL=1';
+    expect(humanizeRecurrence(raw)).toMatch(/every day/i);
+  });
+
+  test('returns empty for non-rule string without JSON', () => {
+    expect(humanizeRecurrence('not a rule')).toBe('');
+  });
+});

package/src/utils/format.js

@@ -0,0 +1,68 @@
+'use strict';
+
+const { RRule } = require('rrule');
+const { parse: parseIso } = require('iso8601-duration');
+
+/**
+ * Convert an ISO8601 duration string (e.g. "PT1H30M") into a human-readable string.
+ * @param {string} iso
+ * @returns {string}
+ */
+function humanizeDuration(iso) {
+  if (typeof iso !== 'string') return '';
+  let dur;
+  try {
+    dur = parseIso(iso);
+  } catch (e) {
+    return iso;
+  }
+  const parts = [];
+  if (dur.years) parts.push(`${dur.years} year${dur.years > 1 ? 's' : ''}`);
+  if (dur.months) parts.push(`${dur.months} month${dur.months > 1 ? 's' : ''}`);
+  if (dur.days) parts.push(`${dur.days} day${dur.days > 1 ? 's' : ''}`);
+  if (dur.hours) parts.push(`${dur.hours} hour${dur.hours > 1 ? 's' : ''}`);
+  if (dur.minutes) parts.push(`${dur.minutes} minute${dur.minutes > 1 ? 's' : ''}`);
+  if (dur.seconds) parts.push(`${dur.seconds} second${dur.seconds > 1 ? 's' : ''}`);
+  return parts.length ? parts.join(' ') : iso;
+}
+
+/**
+ * Convert a recurrence rule object with property $t (RFC5545 string) into a human-readable string.
+ * @param {object} rawRule
+ * @returns {string}
+ */
+function humanizeRecurrence(input) {
+  let ruleObj;
+  if (typeof input === 'string') {
+    // Try to parse JSON string
+    try {
+      ruleObj = JSON.parse(input);
+    } catch (e) {
+      // Not JSON: maybe raw RRULE string
+      if (input.includes('FREQ=')) {
+        try {
+          return RRule.fromString(input).toText();
+        } catch (e) {
+          return input;
+        }
+      }
+      return '';
+    }
+  } else if (typeof input === 'object' && input !== null) {
+    ruleObj = input;
+  } else {
+    return '';
+  }
+
+  const ruleString = ruleObj.$t;
+  if (typeof ruleString !== 'string') {
+    return '';
+  }
+  try {
+    return RRule.fromString(ruleString).toText();
+  } catch (e) {
+    return ruleString;
+  }
+}
+
+module.exports = { humanizeDuration, humanizeRecurrence };