@beauraines/rtm-cli 1.9.3 → 1.10.0

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.
 
+## [1.10.0](https://github.com/beauraines/rtm-cli/compare/v1.9.3...v1.10.0) (2025-12-17)
+
+
+### Features
+
+* new command to convert tasks to Obsidian Task format ([#157](https://github.com/beauraines/rtm-cli/issues/157)) ([23c2b39](https://github.com/beauraines/rtm-cli/commit/23c2b391c4a507927cac2aeaed8f5de8557c6b8a))
+
 ### [1.9.3](https://github.com/beauraines/rtm-cli/compare/v1.9.2...v1.9.3) (2025-10-05)
 
 

package/README.md

@@ -7,6 +7,8 @@ Remember The Milk Command Line Interface
 
 ❗❗ **Resolved login issue blocking new users** ❗❗
 
+❗❗ **Adds an output format to convert tasks to [Obsidian Tasks](https://publish.obsidian.md/tasks/Getting+Started/Getting+Started) format** ❗❗
+
 ---
 
 This Node module provides a command line interface, written in JavaScript,
@@ -101,6 +103,7 @@ The main usage of the program:
   url [options] [indices...]               Display the associated URL of a Task
   whoami                                   Display RTM user information
   overdue                                  Display incomplete tasks that are overdue
+  obsidian [indices...]                    Output tasks in Obsidian Task syntax. Export URLs and notes to configured directory (defaults to system temp dir)
 ```
 
 
@@ -131,9 +134,9 @@ Currently, the configuration can customize:
 - the display of completed tasks
 - the display of tasks with due dates in the future
 - **custom aliases** for existing commands
-  - these are useful for applying commonly used [RTM advanced search](https://www.rememberthemilk.com/help/answer/basics-search-advanced)
-  filters to display commands
-  - ex: `overdue` = `ls dueBefore:today AND status:incomplete`
+  - these are useful for applying commonly used [RTM advanced search](https://www.rememberthemilk.com/help/answer/basics-search-advanced) filters to display commands
+
+- obsidianTaskDir: path to a directory where the `obsidian` command writes URLs and notes (defaults to the system temporary directory)
 
 
 For full documentation on the configuration properties, see the
@@ -154,3 +157,24 @@ For information on installing plugins, see the
 
 For information on creating commands, see the **Creating Commands** section
 in the [Project Wiki](https://github.com/dwaring87/rtm-cli/wiki#creating-commands).
+
+### Obsidian Usage Example
+
+Will create output in the [Obsidian Tasks](https://publish.obsidian.md/tasks/Getting+Started/Getting+Started) format. Currently, this only works for incomplete tasks.
+
+For example, `rtm ls icemaker` would output 
+
+```
+     Personal
+4330 (1) descale icemaker 🔁 | Tue Dec-16
+``` 
+
+and `rtm obsidian 4330` would output 
+
+`- [ ] descale icemaker ⌛30m ➕ 2025-09-28 📅 2025-12-16 🔁 every 3 months 🔺 #Personal 🆔 4330`
+
+which could be written to a file in your Obsidian Vault.
+
+```shell
+rtm ls due:today | cut -wf1 | sort | xargs ./src/cli.js obsidian >> ~/LocalDocs/Test/Tasks/rtm.md
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beauraines/rtm-cli",
-  "version": "1.9.3",
+  "version": "1.10.0",
   "description": "RTM CLI",
   "keywords": [
     "rtm",
@@ -36,7 +36,7 @@
   },
   "homepage": "https://github.com/beauraines/rtm-cli#readme",
   "dependencies": {
-    "@beauraines/rtm-api": "^1.6.0",
+    "@beauraines/rtm-api": "^1.13.1",
     "chalk": "^4.0.0",
     "cli-table3": "^0.6.3",
     "commander": "^2.11.0",

package/src/cmd/obsidian.js

@@ -0,0 +1,253 @@
+'use strict';
+
+const df = require('dateformat');
+const log = require('../utils/log.js');
+const config = require('../utils/config.js');
+const finish = require('../utils/finish.js');
+const filter = require('../utils/filter');
+const sanitizeTag = require('../utils/sanitizeTag');
+const { indexPrompt } = require('../utils/prompt');
+const debug = require('debug')('rtm-cli-obsidian');
+const fs = require('fs');
+const path = require('path');
+const os = require('os');
+
+let TASKS = [];
+// Map of RTM list IDs to names
+let LIST_MAP = new Map();
+
+/**
+ * This command outputs tasks in Obsidian Tasks markdown syntax
+ * @param args indices
+ * @param env
+ */
+async function action(args, env) {
+  TASKS = [];
+  const user = config.user(user => user);
+
+  let indices;
+  if (args.length < 1) {
+    indices = indexPrompt('Task:');
+  } else {
+    // Support multiple indices array
+    indices = Array.isArray(args[0]) ? args[0] : [args[0]];
+  }
+
+  // Fetch all RTM lists to map IDs to names
+  try {
+    log.spinner.start('Fetching Lists');
+    const lists = await new Promise((res, rej) => user.lists.get((err, lists) => err ? rej(err) : res(lists)));
+    LIST_MAP = new Map(lists.map(l => [l.id, l.name]));
+  } catch (e) {
+    log.spinner.warn(`Could not fetch lists: ${e.message || e}`);
+  } finally {
+    log.spinner.stop();
+  }
+
+  log.spinner.start('Getting Task(s)');
+  for (const idx of indices) {
+    const filterString = filter();
+    let response = await user.tasks.rtmIndexFetchTask(idx, filterString);
+    if (response.err) {
+      log.spinner.warn(`Task #${idx} not found`);
+      continue;
+    }
+    TASKS.push({ idx, task: response.task });
+  }
+  log.spinner.stop();
+
+  for (const { idx, task } of TASKS) {
+    displayObsidianTask(idx, task);
+  }
+
+  finish();
+}
+
+/**
+ * Format and log a single task in Obsidian Tasks syntax
+ */
+function displayObsidianTask(idx, task) {
+  debug(task);
+  const { name, priority, start, due, completed, tags = [], added, url, list_id, notes = [], estimate, isRecurring, recurrenceRuleRaw } = task;
+
+  const listName = LIST_MAP.get(list_id) || list_id;
+  // Slugify list name for Obsidian tag
+  const listTag = listName.replace(/\s+/g, '-');
+  const checkbox = completed ? 'x' : ' ';
+  let line = `- [${checkbox}] ${name}`;
+
+  if (estimate) {
+    const dur = formatDuration(estimate);
+    line += ` ⌛${dur}`;
+  }
+
+  if (notes.length) {
+    line += ` 📓`;
+  }
+
+  if (url) {
+    line += ` 🔗`;
+  }
+
+  // Add Obsidian wiki link to the exported detail file
+  if (url || notes.length) {
+    line += ` [[${idx}]]`;
+  }
+
+  if (added) {
+    let createdISO = df(added,"isoDate");
+    line += ` ➕ ${createdISO}`;
+  }
+  if (start) {
+    let startISO = df(start,"isoDate");
+    line += ` 🛫 ${startISO}`;
+  }
+  if (due) {
+    let dueISO = df(due,"isoDate");
+    line += ` 📅 ${dueISO}`;
+    
+    // Recurrence indicator
+    if (isRecurring) {
+      if (recurrenceRuleRaw) {
+        const rec = formatRecurrence(recurrenceRuleRaw);
+        line += ` 🔁 ${rec}`;
+      } else {
+        line += ` 🔁`;
+      }
+    }
+  }
+
+
+
+  const priorityMap = { '1': '🔺', '2': '🔼', '3': '🔽' };
+  if (priority && priorityMap[priority]) {
+    line += ` ${priorityMap[priority]}`;
+  }
+
+  // TODO add location as tags https://github.com/beauraines/rtm-cli/issues/159
+  // Add list tag first, then other tags
+  const allTags = [`#${listTag}`, ...tags.map(t => `#${sanitizeTag(t)}`)];
+  const tagStr = allTags.map(t => ` ${t}`).join('');
+  line += `${tagStr}`;
+
+  line += ` 🆔 ${idx}`;
+
+  if (url || notes.length) {
+    exportDetails(idx, url, notes);
+  }
+
+  log(line);
+}
+
+// Helper: format ISO8601 durations (e.g. PT1H30M) to human label
+function formatDuration(iso) {
+  const match = iso.match(/^P(?:T(?:(\d+)H)?(?:(\d+)M)?(?:(\d+)S)?)$/);
+  if (!match) return iso;
+  const [, H, M, S] = match;
+  const parts = [];
+  if (H) parts.push(`${H}h`);
+  if (M) parts.push(`${M}m`);
+  if (S) parts.push(`${S}s`);
+  return parts.join('') || iso;
+}
+
+// Helper: format RFC5545 recurrence to Obsidian Tasks syntax
+function formatRecurrence(raw) {
+  let rule = raw;
+  if (typeof raw === 'string') {
+    try {
+      rule = JSON.parse(raw);
+    } catch (e) {
+      return raw;
+    }
+  }
+  if (rule.$t) {
+    const parts = rule.$t.split(';');
+    const map = {};
+    parts.forEach(p => {
+      const [k, v] = p.split('=');
+      map[k] = v;
+    });
+    const FREQ = map.FREQ;
+    const INTERVAL = parseInt(map.INTERVAL) || 1;
+    const BYDAY = map.BYDAY;
+    const BYMONTH = map.BYMONTH;
+    const BYMONTHDAY = map.BYMONTHDAY;
+    const getOrdinal = n => {
+      const s = ['th','st','nd','rd'];
+      const v = n % 100;
+      return s[(v-20)%10] || s[v] || s[0];
+    };
+    const weekdayNames = { MO:'Monday', TU:'Tuesday', WE:'Wednesday', TH:'Thursday', FR:'Friday', SA:'Saturday', SU:'Sunday' };
+    const monthNames = { '1':'January','2':'February','3':'March','4':'April','5':'May','6':'June','7':'July','8':'August','9':'September','10':'October','11':'November','12':'December' };
+    switch (FREQ) {
+      case 'DAILY':
+        return INTERVAL === 1 ? 'every day' : `every ${INTERVAL} days`;
+      case 'WEEKLY': {
+        const days = BYDAY ? BYDAY.split(',').map(d => weekdayNames[d] || d).join(', ') : '';
+        if (INTERVAL > 1) {
+          return days ? `every ${INTERVAL} weeks on ${days}` : `every ${INTERVAL} weeks`;
+        }
+        return days ? `every ${days}` : 'every week';
+      }
+      case 'MONTHLY':
+        if (BYMONTHDAY) {
+          const day = parseInt(BYMONTHDAY);
+          const ord = getOrdinal(day);
+          return INTERVAL > 1 ? `every ${INTERVAL} months on the ${day}${ord}` : `every month on the ${day}${ord}`;
+        }
+        return INTERVAL > 1 ? `every ${INTERVAL} months` : 'every month';
+      case 'YEARLY':
+        if (BYMONTH && BYMONTHDAY) {
+          const month = monthNames[BYMONTH] || BYMONTH;
+          const day = parseInt(BYMONTHDAY);
+          const ord = getOrdinal(day);
+          return INTERVAL > 1 ? `every ${INTERVAL} years on ${month} ${day}${ord}` : `every year on ${month} ${day}${ord}`;
+        }
+        return INTERVAL > 1 ? `every ${INTERVAL} years` : 'every year';
+    }
+  }
+  if (rule.every) {
+    return `every ${rule.every}`;
+  }
+  return '';
+}
+
+// Helper: export URL and notes to a file in /tmp
+function exportDetails(idx, url, notes) {
+  const fileName = `${idx}.md`;
+  const exportDir = (process.env.NODE_ENV === 'test' ? os.tmpdir() : (config.config.obsidianTaskDir || os.tmpdir()));
+  const filePath = path.join(exportDir, 'rtm', fileName);
+  let content = '';
+  if (url) {
+    content += `🔗 [${url}](${url})\n\n---\n\n`;
+  }
+  if (notes && notes.length) {
+    notes.forEach((n, i) => {
+      const title = n.title || '';
+      const body = n.content || n.body || n.text || '';
+      if (title) content += `${title}\n`;
+      if (body) content += `${body}\n`;
+      content += `\n---\n\n`;
+    });
+  }
+  // Trim trailing newline for combined URL and notes case
+  if (url && notes && notes.length) {
+    content = content.replace(/\n$/, '');
+  }
+  // Ensure the export directory exists
+  fs.mkdirSync(path.dirname(filePath), { recursive: true });
+  try {
+    fs.writeFileSync(filePath, content);
+  } catch (e) {
+    console.error(`Failed to write details file for task ${idx}: ${e}`);
+  }
+}
+
+module.exports = {
+  command: 'obsidian [indices...]',
+  options: [],
+  description: 'Output tasks in Obsidian Task syntax. Export URLs and notes to configured directory (defaults to system temp dir)\n\nusage: rtm -x true ls due:today | cut -wf1 | sort | xargs ./src/cli.js -x true obsidian >> ~/LocalDocs/Test/Tasks/rtm.md',
+  action: action,
+  exportDetails
+};

package/src/tests/obsidian.test.js

@@ -0,0 +1,74 @@
+const fs = require('fs');
+const path = require('path');
+const os = require('os');
+const { exportDetails } = require('../cmd/obsidian');
+
+describe('exportDetails', () => {
+  const tmpDir = os.tmpdir();
+  const idx = 'test123';
+  const filePath = path.join(tmpDir, 'rtm', `${idx}.md`);
+
+  afterEach(() => {
+    if (fs.existsSync(filePath)) {
+      fs.unlinkSync(filePath);
+    }
+  });
+
+  test('exports URL only', () => {
+    exportDetails(idx, 'http://example.com', []);
+    const content = fs.readFileSync(filePath, 'utf-8');
+    expect(content).toBe('🔗 [http://example.com](http://example.com)\n\n---\n\n');
+  });
+
+  test('exports notes only', () => {
+    const notes = [
+        {
+          id: 114947974,
+          created: "2025-12-15T15:51:05.000Z",
+          modified: "2025-12-15T15:51:05.000Z",
+          title: undefined,
+          body: "Duplicate model names from different connections don't display in the drop down"
+        }
+      ];
+    exportDetails(idx, null, notes);
+    const expected = `Duplicate model names from different connections don't display in the drop down\n\n---\n\n`;
+    const content = fs.readFileSync(filePath, 'utf-8');
+    expect(content).toBe(expected);
+  });
+
+  test('exports URL and notes', () => {
+    const notes = [
+        {
+          id: 114947974,
+          created: "2025-12-15T15:51:05.000Z",
+          modified: "2025-12-15T15:51:05.000Z",
+          title: undefined,
+          body: "Duplicate model names from different connections don't display in the drop down"
+        },
+        {
+          id: 114947974,
+          created: "2025-12-15T15:51:05.000Z",
+          modified: "2025-12-15T15:51:05.000Z",
+          title: "Note 2",
+          body: "note 2 body"
+        }
+      ];
+    exportDetails(idx, 'http://ex.com', notes);
+    const content = fs.readFileSync(filePath, 'utf-8');
+    const expected = [];
+    expected.push('🔗 [http://ex.com](http://ex.com)');
+    expected.push('');
+    expected.push('---');
+    expected.push('');
+    expected.push(`Duplicate model names from different connections don't display in the drop down`);
+    expected.push('');
+    expected.push('---');
+    expected.push('');
+    expected.push('Note 2');
+    expected.push('note 2 body');
+    expected.push('');
+    expected.push('---');
+    expected.push('');
+    expect(content.split('\n')).toEqual(expected);
+  });
+});

package/src/tests/sanitizeTag.test.js

@@ -0,0 +1,24 @@
+const sanitizeTag = require('../utils/sanitizeTag');
+
+describe('sanitizeTag', () => {
+  test('replaces leading @ with context/', () => {
+    expect(sanitizeTag('@home')).toBe('context/home');
+  });
+
+  test('leaves tags without @ unchanged', () => {
+    expect(sanitizeTag('work')).toBe('work');
+  });
+
+  test('returns context/ for standalone @', () => {
+    expect(sanitizeTag('@')).toBe('context/');
+  });
+
+  test('handles empty string', () => {
+    expect(sanitizeTag('')).toBe('');
+  });
+
+  test('non-string inputs are returned as-is', () => {
+    expect(sanitizeTag(123)).toBe(123);
+    expect(sanitizeTag(null)).toBe(null);
+  });
+});

package/src/utils/sanitizeTag.js

@@ -0,0 +1,14 @@
+'use strict';
+
+// This is used for the Obsidian reformatting
+
+
+function sanitizeTag(tag) {
+  if (typeof tag !== 'string') return tag;
+  if (tag.startsWith('@')) {
+    return `context/${tag.slice(1)}`;
+  }
+  return tag;
+}
+
+module.exports = sanitizeTag;