Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bdougherty/jumper-message
A helpful message for times when it’s a bad idea to do something.
https://github.com/bdougherty/jumper-message
Last synced: 26 days ago
JSON representation
A helpful message for times when it’s a bad idea to do something.
- Host: GitHub
- URL: https://github.com/bdougherty/jumper-message
- Owner: bdougherty
- License: mit
- Created: 2018-03-02T04:29:04.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-28T04:43:46.000Z (over 1 year ago)
- Last Synced: 2023-12-27T16:04:15.454Z (11 months ago)
- Language: JavaScript
- Homepage:
- Size: 982 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
```
┓┏┓┏┓┃
┛┗┛┗┛┃ ⟍ ○⟋
┓┏┓┏┓┃ ∕ jumper
┛┗┛┗┛┃ ノ) message
┓┏┓┏┓┃
┃┃┃┃┃┃
┻┻┻┻┻┻
```
## Usage
```js
import jumperMessage from 'jumper-message';
console.log(jumperMessage('message'));
```
## API
### jumperMessage(message, [options])
#### message
Type: `string`
The string to use as the message.
#### options
Type: `Object`
##### buildingStyle
Type: `string`
Set the style of the bulding to a [chalk style](https://github.com/chalk/chalk#styles). Defaults to `gray`.
##### compact
Type: `boolean`
Remove the padding between the message lines. Defaults to `false`.
##### extraFloors
Type: `Number`
Add extra floors to the building below the message. Defaults to `0`.
##### gradient
Type: `string`
Set the style of the message to be a gradient, using the built-in gradients from [gradient-string](https://github.com/bokub/gradient-string#available-built-in-gradients). Overrides the color set with `messageColor`. Defaults to `pastel` if the specified gradient isn’t valid.
##### messageStyle
Type: `string`
Set the style of the message to a [chalk style](https://github.com/chalk/chalk#styles). Defaults to `bold.white`. Overridden when the `gradient` option is used.
##### personStyle
Type: `string`
Set the style of the jumper to a [chalk style](https://github.com/chalk/chalk#styles). Defaults to `white`.
## Related
* [jumper-message-cli](https://github.com/bdougherty/jumper-message-cli) - CLI for this module
* [chalk](https://github.com/chalk/chalk)
* [gradient-string](https://github.com/bokub/gradient-string)
* [Friday deploy script for Capistrano](https://gist.github.com/exAspArk/4f18795bc89b6e2666ee)
## License
MIT © [Brad Dougherty](https://brad.is)