Dimer is an open source project and CMS to help you publish your documentation online.
We believe every project/product is incomplete without documentation.
We want to help you publish user facing documentation, without worrying about tools or code
to write.
Dimer cli utils
Handy utils for Dimer CLI.
There's no need for this package. But I am finding myself creating more small packages, over sticking everything to one repo.
Installation
npm i @dimerapp/cli-utils
# Yarn
yarn add @dimerapp/cli-utils
API
-
info(message, [newLine]) ⇒
void
-
Prints info message in yellow color
-
error(error, [newLine]) ⇒
void
-
Prints error message in red color
-
attention(message, [newLine]) ⇒
void
-
Prints message with
Attention
label in magenta color -
action(action, message) ⇒
void
-
Prints action in cyan color with it's message
-
wrapInBraces(lhs, rhs, [newLine]) ⇒
void
-
Wrap a statement with
lhs
andrhs
inside braces style -
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
-
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
-
configErrors(errors) ⇒
void
-
Print config errors produced by
@dimerapp/config-parser
void
info(message, [newLine]) ⇒ Prints info message in yellow color
Kind: global function
Param | Type | Default |
---|---|---|
message | String |
|
[newLine] | Boolean |
false |
void
error(error, [newLine]) ⇒ Prints error message in red color
Kind: global function
Param | Type | Default |
---|---|---|
error |
Error | String
|
|
[newLine] | Boolean |
false |
void
attention(message, [newLine]) ⇒ Prints message with Attention
label in
magenta color
Kind: global function
Param | Type | Default |
---|---|---|
message | String |
|
[newLine] | Boolean |
false |
void
action(action, message) ⇒ Prints action in cyan color with it's message
Kind: global function
Param | Type |
---|---|
action | String |
message | String |
void
wrapInBraces(lhs, rhs, [newLine]) ⇒ Wrap a statement with lhs
and rhs
inside
braces style
Kind: global function
Param | Type | Default |
---|---|---|
lhs | String |
|
rhs | String |
|
[newLine] | Boolean |
false |
void
versionsProgress(versions) ⇒ 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
Param | Type |
---|---|
versions | Array |
void
filesErrors(basePath, errors) ⇒ 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
Param | Type |
---|---|
basePath | String |
errors | Array |
void
configErrors(errors) ⇒ Print config errors produced by @dimerapp/config-parser
Kind: global function
Param | Type |
---|---|
errors | Array |
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.