getcli.js

'use strict';

const boolean = require( 'boolean' );
const dashdash = require( 'dashdash' );
const path = require( 'path' );

module.exports = function() {

    dashdash.addOptionType( {
        name: 'commaSeparated',
        takesArg: true,
        helpArg: 'ARG[,ARG]',
        array: true,
        arrayFlatten: true,
        parseArg: function parseCommaSeparated( option, optstr, arg ) {
            return arg.split( ',' );
        }
    } );

    dashdash.addOptionType( {
        name: 'smartBool',
        takesArg: true,
        helpArg: '[true|false]',
        parseArg: function parseSmartBool( option, optstr, arg ) {
            return boolean( typeof arg !== 'undefined' ? arg : true );
        }
    } );

    const options = [ {
        name: 'version',
        type: 'bool',
        help: 'Print version and exit.'
    }, {
        names: [ 'help', 'h' ],
        type: 'bool',
        help: 'Print this help and exit.'
    }, {
        names: [ 'verbose', 'v' ],
        type: 'bool',
        help: 'Enable verbose output.'
    }, {
        name: 'norequestlogging',
        type: 'bool',
        help: 'Disables request logging'
    }, {
        name: 'logformat',
        env: 'EPICENTER_LOGFORMAT',
        type: 'string',
        help: 'Specify the format of request logging.',
        helpArg: 'text|json',
        default: 'text'
    }, {
        names: [ 'require', 'req', 'r' ],
        env: 'EPICENTER_REQUIRES',
        type: 'arrayOfString',
        help: 'Specify requires. By default the following are tried: ./routes, ./handlers, ./api',
        helpArg: 'DIR',
        default: [ './routes', './handlers', './api', './processors' ]
    }, {
        name: 'canonical',
        env: 'EPICENTER_CANONICAL',
        type: 'string',
        help: 'Specify a canonical base url for the server, eg: "https://foo.com"',
        helpArg: 'BASE_URL'
    }, {
        name: 'name',
        env: 'EPICENTER_NAME',
        type: 'string',
        help: 'Specify the service name for restify.',
        helpArg: 'NAME',
        default: null
    }, {
        name: 'httpport',
        env: 'EPICENTER_HTTP_PORT',
        type: 'positiveInteger',
        help: 'Specify the HTTP port to listen on.',
        helpArg: 'PORT',
        default: 8000
    }, {
        name: 'httpsport',
        env: 'EPICENTER_HTTPS_PORT',
        type: 'positiveInteger',
        help: 'Specify the HTTPS port to listen on.',
        helpArg: 'PORT',
        default: 4443
    }, {
        name: 'httpscert',
        env: 'EPICENTER_HTTPS_CERT',
        type: 'string',
        help: 'Specify the path of the file containing the SSL certificate for the server.',
        helpArg: 'PATH'
    }, {
        name: 'httpskey',
        env: 'EPICENTER_HTTPS_KEY',
        type: 'string',
        help: 'Specify the path fo the file containing the SSL private key for the server.',
        helpArg: 'PATH'
    }, {
        name: 'httpsciphers',
        env: 'EPICENTER_HTTPS_CIPHERS',
        type: 'string',
        help: 'Specify the SSL ciphers.',
        helpArg: 'CIPHERS',
        default: 'ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-DSS-AES128-GCM-SHA256:kEDH+AESGCM:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-DSS-AES128-SHA256:DHE-RSA-AES256-SHA256:DHE-DSS-AES256-SHA:DHE-RSA-AES256-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:AES:CAMELLIA:DES-CBC3-SHA:!aNULL:!eNULL:!EXPORT:!DES:!RC4:!MD5:!PSK:!aECDH:!EDH-DSS-DES-CBC3-SHA:!EDH-RSA-DES-CBC3-SHA:!KRB5-DES-CBC3-SHA'
    }, {
        name: 'httpsredirect',
        env: 'EPICENTER_HTTPS_REDIRECT',
        type: 'bool',
        help: 'If specified, will redirect all connections on the unsecured port to the HTTPS port.',
        default: false
    }, {
        names: [ 'corsorigin', 'co' ],
        env: 'EPICENTER_CORS_ORIGINS',
        type: 'commaSeparated',
        help: 'Specify allowed CORS origins. If none are specified, the default * is used.',
        helpArg: 'ORIGIN',
        default: [ '*' ]
    }, {
        names: [ 'corsheader', 'ch' ],
        env: 'EPICENTER_CORS_HEADERS',
        type: 'commaSeparated',
        help: 'Specify allowed CORS headers.',
        helpArg: 'HEADER',
        default: null
    }, {
        name: 'sentrydsn',
        env: 'EPICENTER_SENTRY_DSN',
        type: 'string',
        help: 'Specify a DSN for Sentry (https://getsentry.com) error tracking.',
        helpArg: 'DSN',
        default: null
    } ];

    const scriptName = path.basename( require.main.filename );

    const parser = dashdash.createParser( {
        options: options
    } );

    let opts = {};
    try {
        opts = parser.parse( process.argv );
    }
    catch ( exception ) {
        console.error( exception.message );
        process.exit( 1 );
    }

    if ( opts.version ) {
        const pkg = require( './package.json' );
        console.log( scriptName + ' v' + pkg.version );
        process.exit( 0 );
    }

    if ( opts.help ) {
        const help = parser.help( {
            includeEnv: true,
            includeDefault: true,
            maxCol: process.stdout.columns ? process.stdout.columns - 1 : 80
        } ).trimRight();

        console.log( 'usage: node ' + scriptName + ' [OPTIONS]\n' + 'options:\n' + help );
        process.exit( 0 );
    }

    if ( opts.require[ 0 ].indexOf( ';' ) !== -1 ) {
        opts.require = opts.require[ 0 ].split( ';' );
    }

    opts.requires = opts.require;
    delete opts.require;

    opts.cors = {
        origins: opts.corsorigin,
        allowedHeaders: opts.corsheader
    };
    delete opts.corsorigins;
    delete opts.corsheader;

    if ( !opts.canonical ) {
        opts.canonical = opts.httpscert && opts.httpskey ? 'https://localhost:' + opts.httpsport : 'http://localhost:' + opts.httpport;
    }

    return opts;
};