feat(mite-amend): use first argument as note if it’s not numeric

Author: Ephigenia

README.md

@@ -29,6 +29,7 @@ line-separatedEase to use CLI tool for creating, listing, starting and stopping
             - [Stop Tracking](#Stop-Tracking)
         - [Modify Time-Entries](#Modify-Time-Entries)
             - [Change Note](#Change-Note)
+            - [Change Service or Project](#Change-Service-or-Project)
             - [Un-/Lock Entry](#Un-Lock-Entry)
         - [Delete entry](#Delete-entry)
         - [Open](#Open)
@@ -56,7 +57,7 @@ Features
 
 - Create and start new Entries with interactive survey-like cli interface
 - Delete, lock, unlock single time entries
-- Edit the currently running entries text for fast updating the work log
+- Edit the currently running entries text, service and project for quickly updating the work log
 - Show, filter, group time entries to show reports for last month, current week etc.
 - Delete single entries by id
 - List, sort, filter, update & delete user accounts, customers, projects & services using variable columns and cli-tables, CSV or TSV data
@@ -81,21 +82,21 @@ Options:
   -h, --help         output usage information
 
 Commands:
-  amend|reword       edit the text for a specific time entry or the currently runnning entry
+  amend|reword       edit note, service, project of a specific time entry or the currently runnning entry
   autocomplete       install/uninstall autocompletion
   config             show or set configuration settings
-  customer           update/delete single customer
+  customer           create/delete/list/update customer
   customers|clients  list, filter & search customers
   delete|rm          delete a specific time entry
   list|st            list time entries
   lock               lock single time entry
   new|create         create a new time entry
   open               open the given time entry in browser
-  project            update/delete a single project
+  project            create/delete/list/update a single project
   projects           list, filter, archive/unarchive & search projects
-  service            update/delete single service
+  service            create/delete/list/update single service
   services           list, filter & search services
-  start              start the tracker for the given id, will also stop already running entry
+  start              start the tracker for the given id, will also stop allready running entry
   stop               stop any running counter
   unlock             unlock single time entry
   users              list, filter & search for users
@@ -362,6 +363,12 @@ You can also pipe in the note:
 
     cat myVerLongNote.txt | mite amend 1234567
 
+#### Change Service or Project
+
+Changing the project or service id of the current or any other time entry works the same:
+
+    mite amend 12345678 --service-id 12834 --project-id 12938123
+
 #### Un-/Lock Entry
 
 Lock a single time entry

source/lib/auto-complete/completions/amend.js

@@ -17,7 +17,25 @@ const NOTE_MAX_LENGTH = (process.stdout.columns || 80) - 20;
  * @param {string} env.line - the current complete input line in the cli
  * @returns {Promise<Array<string>>}
  */
-module.exports = async ({ line, words }) => {
+module.exports = async ({ line, words, prev }) => {
+
+  switch (prev) {
+    case '--project-id':
+      return miteApi.getProjects({ archived: false }).then(
+        projects => projects.map(c => ({
+          name: String(c.id),
+          description: c.name
+        }))
+      );
+    case '--service-id':
+        return miteApi.getServices({ archived: false }).then(
+          service => service.map(c => ({
+            name: String(c.id),
+            description: c.name + (c.billable ? ' $' : '')
+          }))
+        );
+  }
+
   const defaults = [
     (words < 3 ? {
       name: '--help',
@@ -26,7 +44,15 @@ module.exports = async ({ line, words }) => {
     (line.indexOf('--editor') === -1 ? {
       name: '--editor',
       description: 'open $EDITOR for editing the entry’s note'
-    } : undefined)
+    } : undefined),
+    {
+      name: '--project-id',
+      description: 'id of the project the entry should be assigned to'
+    },
+    {
+      name: '--service  -id',
+      description: 'id of the service  the entry should be assigned to'
+    }
   ];
 
   // try to find the latest entries created by the current user and propose the

source/mite-amend.js

@@ -16,18 +16,32 @@ program
   .version(pkg.version)
   .arguments('[timeEntryId] [note]')
   .description(
-    'Rewrite the note for the given time entry id or use the currently ' +
-    'running time entry and edit it’s note',
+    `Updates the note of the currently tracked time entry (when no id is given) \
+or the one specified in the first argument. The content of the note can be \
+second argument or piped into the program. See the examples for the different \
+usages.
+
+Also the project id and service id of a time entry can be altered if the user \
+has the required permissions to do it.`,
     {
-      timeEntryId: 'optional id of the time entry that should be altered, ' +
-        'if not given the currently running entry is used',
+      timeEntryId:
+        'optional id of the time entry that should be altered, if not given ' +
+        'the currently running entry is used',
       note: 'optional value to which the time entries note should be set'
     }
   )
   .option(
     '-e, --editor',
     'open preferred $EDITOR for editing'
   )
+  .option(
+    '--project-id <id>',
+    'the project id which should be set'
+  )
+  .option(
+    '--service-id <id>',
+    'the service id which should be set'
+  )
   .on('--help', () => console.log(`
 Examples:
 
@@ -42,9 +56,21 @@ Examples:
 
   Change the note via command line argument:
     mite amend 12345678 "created a programmable list of items"
+
+  If you leave out the id the currently tracked note will be changed
+    mite amend "created a programmable list of items"
+
+  Change project and service
+    mite amend 12345678 --service-id 918772 --project-id 129379
     `));
 
 function main(timeEntryId, note) {
+  // if first argument is the note instead of the timeEntry
+  if (!note && !timeEntryId.match(/^\d+/)) {
+    note = timeEntryId;
+    timeEntryId = undefined;
+  }
+
   const mite = miteApi(config.get());
   const miteTracker = tracker(config.get());
   const getTimeEntry = util.promisify(mite.getTimeEntry);
@@ -77,25 +103,35 @@ function main(timeEntryId, note) {
     promise = getTimeEntry(timeEntryId);
   }
 
+  let updateData = {
+    ...(program.projectId && { project_id: program.projectId }),
+    ...(program.serviceId && { service_id: program.serviceId }),
+  };
+
   return promise
     .then(data => {
       if (!data) {
         throw new Error('Unable to find time entry with the given ID');
       }
       return data.time_entry;
     })
+    /**
+     * @return {Object.<string>}
+     * @return {string} entry.note new note
+     */
     .then(timeEntry => {
       timeEntryId = timeEntry.id;
 
-      // only ask for updated note entered via editor or inquirer if it’s
-      // not been set before
-      if (typeof note !== 'undefined') {
-        // use note passed over via pipe
+      // if only service and project should be changed (no note given)
+      if (typeof note === 'undefined' && updateData !== {}) {
+        return updateData;
+      } else if (typeof note !== 'undefined') {
+        // note passed over via pipe or argument
         return { note };
       } else if (program.editor) {
         // use $EDITOR and return content
-        return openEditor(timeEntry.note).then((editedText) => {
-          return { note: editedText };
+        return openEditor(timeEntry.note).then((editorContent) => {
+          return { note: editorContent };
         });
       } else {
         // use interactive mode (inquirer)

source/mite.js

@@ -8,19 +8,19 @@ const autoComplete = require('./lib/auto-complete');
 
 program
   .version(pkg.version)
-  .command('amend', 'edit the text for a specific time entry or the currently runnning entry').alias('reword')
+  .command('amend', 'edit note, service, project of a specific time entry or the currently runnning entry').alias('reword')
   .command('autocomplete', 'install/uninstall autocompletion')
   .command('config', 'show or set configuration settings')
-  .command('customer', 'update/delete single customer')
+  .command('customer', 'create/delete/list/update customer')
   .command('customers', 'list, filter & search customers').alias('clients')
   .command('delete', 'delete a specific time entry').alias('rm')
   .command('list', 'list time entries', { isDefault: true }).alias('ls').alias('status').alias('st')
   .command('lock', 'lock single time entry')
   .command('new', 'create a new time entry').alias('create')
   .command('open', 'open the given time entry in browser')
-  .command('project', 'update/delete a single project')
+  .command('project', 'create/delete/list/update a single project')
   .command('projects', 'list, filter, archive/unarchive & search projects')
-  .command('service', 'update/delete single service')
+  .command('service', 'create/delete/list/update single service')
   .command('services', 'list, filter & search services')
   .command('start', 'start the tracker for the given id, will also stop allready running entry')
   .command('stop', 'stop any running counter')