1.0.3 • Published 6 years ago

@dimerapp/cli-utils v1.0.3

Weekly downloads
21
License
MIT
Repository
github
Last release
6 years ago

Dimer cli utils

Handy utils for Dimer CLI.

npm-image

There's no need for this package. But I am finding myself creating more small packages, over sticking everything to one repo.

npm.io

Installation

npm i @dimerapp/cli-utils

# Yarn
yarn add @dimerapp/cli-utils

API

info(message, newLine) ⇒ void

Prints info message in yellow color

Kind: global function

ParamTypeDefault
messageString
newLineBooleanfalse

error(error, newLine) ⇒ void

Prints error message in red color

Kind: global function

ParamTypeDefault
errorError | String
newLineBooleanfalse

attention(message, newLine) ⇒ void

Prints message with Attention label in magenta color

Kind: global function

ParamTypeDefault
messageString
newLineBooleanfalse

action(action, message) ⇒ void

Prints action in cyan color with it's message

Kind: global function

ParamType
actionString
messageString

wrapInBraces(lhs, rhs, newLine) ⇒ void

Wrap a statement with lhs and rhs inside braces style

Kind: global function

ParamTypeDefault
lhsString
rhsString
newLineBooleanfalse

versionsProgress(versions) ⇒ void

Log updates for multiple versions. The log will re-write on the same lines.

A version node must have.

  • no
  • processed
  • total

Kind: global function

ParamType
versionsArray

filesErrors(basePath, errors) ⇒ void

Print all errors for multiple files. Errors must be part of vfile messages.

Base path is required to shorten the file names

Kind: global function

ParamType
basePathString
errorsArray

configErrors(errors) ⇒ void

Print config errors produced by @dimerapp/config-parser

Kind: global function

ParamType
errorsArray

Change log

The change log can be found in the CHANGELOG.md file.

Contributing

Everyone is welcome to contribute. Please take a moment to review the contributing guidelines.

Authors & License

thetutlage and contributors.

MIT License, see the included MIT file.