@beauraines/rtm-cli 1.5.2

package/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [dwaring87] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: davidwaring # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 David Waring
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,143 @@
+Remember The Milk Command Line Interface
+========================================
+
+**node module:** [rtm-cli](https://www.npmjs.com/package/rtm-cli)<br />
+**GitHub repo:** [dwaring87/rtm-cli](https://github.com/dwaring87/rtm-cli)
+
+---
+
+This Node module provides a command line interface, written in JavaScript,
+for the popular [Remember the Milk](https://www.rememberthemilk.com/) task list
+manager.
+
+![](https://raw.githubusercontent.com/dwaring87/rtm-cli/master/screens/ls.png)
+
+
+## Installation
+
+### NPM
+
+If you already have [Node](https://nodejs.org) installed, this program can be
+installed via `npm`:
+
+```shell
+npm install -g rtm-cli
+```
+
+which will install the executable `rtm` into your `$PATH`.
+
+**Note:** RTM CLI requires Node version >= 7.5.0
+
+### Executable Releases
+
+Standalone executables, that do not require a pre-existing installation of Node,
+are available in the [Releases](https://github.com/dwaring87/rtm-cli/releases)
+page.
+
+
+## Usage
+
+The main usage of the program:
+
+```
+  Usage: rtm [options] <command> [command arguments]
+
+
+    Options:
+
+      -V, --version            output the version number
+      -p, --plain              do not use styled/colored text (overrides --color)
+      -c, --color              force the use of styled/colored text
+      -s, --status             toggle the display of the status spinner
+      -x, --completed [value]  set display of completed tasks (true/false/number of days)
+      -d, --hideDue [value]    hide tasks due more than n days from today (false/number of days)
+      -f, --config [file]      specify configuration file
+      -v, --verbose            print stack traces on errors
+      -h, --help               output usage information
+
+
+    Commands:
+
+      add|a [task...]                     Add a new Task
+      addList|al [name] [filter...]       Add a new List or Smart List
+      addTags|at [index] [tags...]        Add one or more tags to a Task
+      archiveList|arl [name...]           Archive a List
+      comp|x [indices...]                 Complete one or more Tasks
+      decPri|- [indices...]               Decrease the Priority of one or more Tasks
+      due [index] [due...]                Set the Due Date of a Task
+      edit [index] [name...]              Change the name of a Task
+      incPri|+ [indices...]               Increase the Priority of one or more Tasks
+      lists|l                             Display all lists
+      login                               Add RTM User information
+      logout                              Remove RTM User information
+      ls [filter...]                      List all tasks sorted first by list then by priority
+      lsd [filter...]                     List all tasks sorted first by due date then by priority
+      lsp [filter...]                     List all tasks sorted first by priority then due date
+      move|mv [index] [list...]           Move Task to a different List
+      planner [options] [filter...]       Display tasks in a weekly planner (--start: sun, mon, today)
+      postpone|pp [indices...]            Postpone one or more Tasks
+      pri|p [index] [priority]            Change Task Priority
+      remove|rm [indices...]              Remove one or more Tasks
+      removeList|rml [name...]            Remove a List
+      removeTags|rmt [index] [tags...]    Remove one or more tags from a Task
+      renameList|mvl [oldName] [newName]  Rename a List
+      reset                               Reset cached task indices
+      setUrl|su [index] [url]             Set the URL of a Task
+      tags|t                              Display all tags
+      uncomp|unc [indices...]             Mark one or more Tasks as not complete
+      url [options] [index...]            Display the associated URL of a Task
+      whoami                              Display RTM user information
+      overdue                             Display incomplete tasks that are overdue
+```
+
+
+### Interactive Mode
+
+An interactive mode is started when no commands are given to `rtm`, which
+allows commands to be given sequentially.
+
+Use the `quit` command to leave the interactive mode.
+
+
+### Full Usage Information
+
+For full documentation on the usage of the built-in commands and options,
+see the [Command Reference](https://github.com/dwaring87/rtm-cli/wiki/Command-Reference).
+
+
+## Configuration
+
+RTM CLI has a number of properties that can be configured using a separate JSON configuration
+file. The default user configuration file is located at `$HOME/.rtm.json` but can be changed
+using the `--config <file>` option.
+
+Currently, the configuration can customize:
+
+- the formats of displayed dates
+- styled text output for different task properties
+- 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`
+
+
+For full documentation on the configuration properties, see the
+[Configuration Reference](https://github.com/dwaring87/rtm-cli/wiki/Configuration-Reference).
+
+
+## Plugins
+
+RTM CLI supports adding additional commands through plugins.
+
+**Available Plugins:**
+
+  - Export - [rtm-plugin-export](https://github.com/dwaring87/rtm-plugin-export)
+    - Provides an `export` command to export tasks to a CSV file
+
+For information on installing plugins, see the
+[Plugin Reference](https://github.com/dwaring87/rtm-cli/wiki/Plugin-Reference).
+
+For information on creating commands, see the **Creating Commands** section
+in the [Project Wiki](https://github.com/dwaring87/rtm-cli/wiki#creating-commands).

package/build.js

@@ -0,0 +1,86 @@
+#!/usr/bin/env node
+'use strict';
+
+const path = require('path');
+const fs = require('fs');
+const pkg = require('pkg');
+const archiver = require('archiver');
+const config = require('./package.json');
+
+// Build Paths
+const configPath = path.dirname(require.resolve('./package.json'));
+const binPath = path.normalize(configPath + '/' + config.pkg.out);
+
+
+
+clean();
+build()
+  .then(pack);
+
+
+
+/**
+ * Clean the Bin Directory
+ */
+function clean() {
+  console.log();
+  console.log("CLEANING...");
+  let files = fs.readdirSync(binPath);
+  for ( let file of files ) {
+    fs.unlinkSync(path.normalize(binPath + '/' + file));
+  }
+}
+
+/**
+ * Build Binaries using PKG
+ * @returns Promise
+ */
+function build() {
+  console.log();
+  console.log("BUILDING...");
+  return pkg.exec(['./package.json', '--targets', config.pkg.targets, '--out-dir', binPath]);
+}
+
+/**
+ * Pack the Binaries into separate zip files
+ */
+function pack() {
+  console.log();
+  console.log("PACKAGING...");
+
+  let bins = fs.readdirSync(binPath);
+  for ( let bin of bins ) {
+    if ( bin.includes('rtm-cli-') ) {
+      let parts = bin.split('-');
+      let os = parts[2];
+      let arch = parts[3];
+      let name = 'rtm';
+      let version = config.version;
+      let zipName = name + '-' + os + '.' + arch + '-' + version + '.zip';
+
+      let zipFile = path.normalize(binPath + '/' + zipName);
+      let binFile = path.normalize(binPath + '/' + bin);
+
+      let zip = fs.createWriteStream(zipFile);
+      let archive = archiver('zip', {zib: {level: 9}});
+
+      zip.on('close', function() {
+        fs.unlinkSync(binFile);
+        console.log("..." + bin);
+      });
+
+      zip.on('error', function(err) {
+        throw err;
+      });
+
+      if ( os === 'win' ) {
+        name = name + '.exe';
+      }
+
+      archive.pipe(zip);
+      archive.file(binFile, {name: name});
+      archive.finalize();
+    }
+  }
+}
+

package/config.json

@@ -0,0 +1,40 @@
+{
+  "client": {
+    "key": "cbc76268b901ccb8d9fc5f3aebc4ee1f",
+    "secret": "131beea786379309",
+    "perms": "delete"
+  },
+  "dateformat": "ddd mmm-dd",
+  "plannerDateformat": "ddd",
+  "completed": 7,
+  "hideDue": false,
+  "plain": false,
+  "status": true,
+  "styles": {
+    "list": "yellow.underline",
+    "index": "dim",
+    "priority": {
+      "0": "reset",
+      "1": "red",
+      "2": "blue",
+      "3": "cyan"
+    },
+    "completed": "dim",
+    "notes": "yellow",
+    "url": "yellow",
+    "tags": "magenta",
+    "due": "green"
+  },
+  "iconType": "text",
+  "aliases": [
+    {
+      "name": "overdue",
+      "description": "Display incomplete tasks that are overdue",
+      "command": "lsd",
+      "args": "dueBefore:today AND status:incomplete"
+    }
+  ],
+  "plugins": [
+    "{{HOME}}/.rtm.plugins/"
+  ]
+}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@beauraines/rtm-cli",
+  "version": "1.5.2",
+  "description": "RTM CLI",
+  "keywords": [
+    "rtm",
+    "cli",
+    "terminal",
+    "remember the milk",
+    "tasks",
+    "task manager",
+    "todo",
+    "gtd"
+  ],
+  "bin": {
+    "rtm": "src/cli.js"
+  },
+  "main": "src/utils/index.js",
+  "scripts": {
+    "postversion": "npm run build",
+    "build": "node build.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/beauraines/rtm-cli.git"
+  },
+  "author": "Beau Raines <beau.raines@gmail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/beauraines/rtm-cli/issues"
+  },
+  "homepage": "https://github.com/beauraines/rtm-cli#readme",
+  "dependencies": {
+    "chalk": "^2.3.0",
+    "cli-table3": "^0.5.0",
+    "commander": "^2.11.0",
+    "copy-paste": "^1.3.0",
+    "dateformat": "^3.0.2",
+    "deepmerge": "^2.0.1",
+    "opn": "^5.4.0",
+    "ora": "^1.3.0",
+    "prompt-sync": "^4.2.0",
+    "rtm-api": "@beauraines/rtm-api",
+    "window-size": "^1.1.0"
+  },
+  "devDependencies": {
+    "archiver": "^2.1.0",
+    "pkg": "^4.3.3"
+  },
+  "pkg": {
+    "scripts": [
+      "config.json",
+      "src/cmd/*.js"
+    ],
+    "targets": "node8-linux-x86,node8-linux-x64,node8-macos-x86,node8-macos-x64,node8-win-x86,node8-win-x64",
+    "out": "./bin"
+  }
+}