mite-cli/source/lib/auto-complete/completions/projects.js

command line tool for time tracking service mite.de

#!/usr/bin/env node
'use strict';

const config = require('./../../../config');
const miteApi = require('./../../mite-api')(config.get());
const {
  getCustomerOptions,
  removeAlreadyUsedOptions
} = require('../helpers');
const options = require('./../../options');
const projectsCommand = require('./../../commands/projects');

const defaults = [
  {
    name: '--archived',
    description: 'defines wheter archived projects should be shown',
  },
  {
    name: options.plain.definition,
    description: options.plain.description(),
  },
  {
    name: options.pretty.definition,
    description: options.pretty.description(),
  },
  {
    name: options.json.definition,
    description: options.json.description(),
  },
  {
    name: '--columns',
    description: 'define the columns that are shown',
  },
  {
    name: '--customer',
    description: 'given a regular expression will list only projects where the customers’s name matches',
  },
  {
    name: '--customer-id',
    description: 'given a customer id will list only projects for that customer',
  },
  {
    name: '--help',
    description: 'show help message',
  },
  {
    name: '--search',
    description: 'given a query will show only projects where name or customer name match',
  },
  {
    name: '--sort',
    description: 'defines the order of projects',
  }
];

/**
 * https://www.npmjs.com/package/tabtab#3-parsing-env
 *
 * @param {string} env.lastPartial - the characters entered in the current
 *                               argument before hitting tabtab
 * @param {string} env.prev - last given argument value, or previously
 *                            completed value
 * @param {string} env.words - the number of argument currently active
 * @param {string} env.line - the current complete input line in the cli
 * @returns {Promise<Array<string>>}
 */
module.exports = async ({ prev, line }) => {
  // argument value completion
  switch (prev) {
    case '--archived':
    case '-a':
      return ['yes', 'no', 'all'];
    case '--columns':
      return Object.keys(projectsCommand.columns.options).concat(['all']);
    case '--customer':
      // propose a list of customers
      return miteApi.getCustomers().then(customers => customers.map(c => ({
        name: String(c.name)
      })));
    case '--customer-id':
      return await getCustomerOptions();
    case '--search':
      return ['query'];
    case '--sort':
      return projectsCommand.sort.options;
  }

  // return default options without the ones which where already entered
  const options = removeAlreadyUsedOptions(defaults, line);
  return options;
};