appverse-doctor

Check, install or uptade global NPM packages required to work with Appverse - HTML5

Installing

• Install the Appverse Doctor NPM package as global.

    npm install -g appverse-doctor

Usage

Command line

    $ appverse-doctor

• Force missing packages installation

    $ appverse-doctor -i

• Help

    $ appverse-doctor --help

• Version

    $ appverse-doctor --version

API

Call the doctor by code:

    var doctor = require('appverse-doctor'); 
    doctor.check().then (() => {
      console.log ("Done");
    });

Options

options.force

Type: Boolean
Default: false

Skip prompting. Force installation or upgrade of packages.

    var doctor = require('appverse-doctor'); 
    doctor.check({force:true}).then (() => {
      console.log ("Done");
    });

options.banner

Show welcome banner Type: Boolean
Default: true

    var doctor = require('appverse-doctor'); 
    doctor.check({banner:false}).then (() => {
      console.log ("Done");
    });

options.skipUpdate

Check and notify if there is a new appverse-doctor version. Type: Boolean
Default: true

    var doctor = require('appverse-doctor'); 
    doctor.check({skipUpdate:false}).then (() => {
      console.log ("Done");
    });

options.packages

Appverse Doctor uses a configuration file where required packages and versions are defined, but it's possible to provide a custom package list.

Type: Array

The latest will be replaced with the last published version of the package.

    var options = {
       packages: [
           {package: 'yo', version: 'latest'},
           {package: 'bower', version: '1.6'}
       ]
    }
    doctor.check(options).then (() => {
        console.log ("Done");
    });

License

Copyright (c) 2012 GFT Appverse, S.L., Sociedad Unipersonal.

This Source Code Form is subject to the terms of the Appverse Public License Version 2.0 ("APL v2.0"). If a copy of the APL was not distributed with this file, You can obtain one at http://appverse.org/#/license/information.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the conditions of the AppVerse Public License v2.0 are met.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. EXCEPT IN CASE OF WILLFUL MISCONDUCT OR GROSS NEGLIGENCE, IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.