homebridge/lib/cli.js

import program from 'commander';
import log from 'npmlog';
import prompt from 'prompt';
import { HOMEBRIDGE_VERSION } from './homebridge';
import { User } from './user';
import { Server } from './server';
import { Provider } from './provider';
import { camelCaseToRegularForm } from './util';

export default function() {

  // Global options (none currently) and version printout
  program
    .version(HOMEBRIDGE_VERSION);

  // Run the HomeBridge server
  program
    .command('server')
    .description('Run the HomeBridge server.')
    .action(runServer);

  program
    .command('providers')
    .description('List installed providers.')
    .action(listInstalledProviders);
  
  program
    .command('setup [provider]')
    .description('Sets up a new HomeBridge provider or re-configures an existing one.')
    .action(setupProvider);

  // Parse options and execute HomeBridge
  program.parse(process.argv);

  // Display help by default if no commands or options given
  if (!process.argv.slice(2).length) {
    program.help();
  }
}

function runServer(options) {
  
  // get all installed providers
  let providers:Array<Provider> = Provider.installed();
  
  // load and validate providers - check for valid package.json, etc.
  try {
    this.providerModules = providers.map((provider) => provider.load());
  }
  catch (err) {
    console.log(err.message);
    process.exit(1);
  }
}

function listInstalledProviders(options) {
  Provider.installed().forEach((provider) => console.log(provider.name));
}

function setupProvider(providerName, options) {
  
  // if you didn't specify a provider, print help
  if (!providerName) {
    log.error("You must specify the name of the provider to setup. Type 'homebridge providers' to list the providers currently installed.");
    program.help();
  }
  
  try {
    let provider = new Provider(providerName);
    let providerModule:object = provider.load({skipConfigCheck: true});
    
    if (providerModule.config) {
      
      prompt.message = "";
      prompt.delimiter = "";
      prompt.start();
      prompt.get(buildPromptSchema(providerName, providerModule.config), (err, result) => {
        
        // apply configuration values entered by the user
        for (let key:string in result) {
          let value:object = result[key];
          
          User.config.set(`${providerName}.${key}`, value);
        }
        
        providerModule.validateConfig();
      });
    }
    else {
      providerModule.validateConfig();
    }
  }
  catch (err) {
    log.error(`Setup failed: ${err.message}`);
  }
}

// builds a "schema" obejct for the prompt lib based on the provider's config spec
function buildPromptSchema(providerName: string, providerConfig: object): object {
  let properties = {};
  
  for (let key:string in providerConfig) {
    let spec:object = providerConfig[key];
    
    // do we have a value for this config key currently?
    let currentValue = User.config.get(`${providerName}.${key}`);

    // copy over config spec with some modifications
    properties[key] = {
      description: `\n${spec.description}\n${camelCaseToRegularForm(key).white}:`,
      type: spec.type,
      required: spec.required,
      default: currentValue
    }
  }
  
  return { properties };
}