appverse-chalkboard

Helpers methods to write Appverse command line packages.

Installing

• Add the package dependency.

    npm install appverse-chalkboard --save

Usage

   var out = require('appverse-chalkboard');
   out.info (" HI!"); 
   

Methods

welcome

Welcome message

Parameters

package.json as object

info

Logs to console with info style

Parameters

Text as String

success

Logs to console success symbol and text with success style

Parameters

Text as String

error

Logs to console with error style

Parameters

Text as String

fail

Logs to console error symbol and text with error style

Parameters

Text as String

warning

Logs to console warning symbol and text with warning style

Parameters

Text as String

table

Draws a table

Parameters

Headers as Array of Strings

Rows as Array of String Array

startProgress

Starts and shows a spinner

Parameters

Text as String

progress

Change current spinner text

Parameters

Text as String

stopProgress

Stop spinner

updater

Check for package updates

Parameters

package.json as object

interval as number

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.