@wenbo/print-message
Version:
NodeJS module for printing out beautiful messages in console
150 lines (114 loc) • 5.4 kB
Markdown
[](https://github.com/semantic-release/semantic-release)
[](http://commitizen.github.io/cz-cli/)
NodeJS module for printing out beautiful messages in console.
Install `print-message` module:
```bash
npm install print-message
```
Require `print-message` module and call a function:
```javascript
var printMessage = require('print-message');
printMessage(['Hello, everyone']);
```
You can set your own options for border.
```javascript
var printMessage = require('print-message');
printMessage([
"You can set your own options for border",
"Options below is default options"
], {
border: true, // Enable border
color: 'default', // Default text color from console
borderColor: 'yellow', // Border color is yellow
borderSymbol: '─', // Symbol that uses for border
sideSymbol: '│', // Symbol that uses for side separators
leftTopSymbol: '┌', // Symbol that uses for left top corner
leftBottomSymbol: '└', // Symbol that uses for left bottom corner
rightTopSymbol: '┐', // Symbol that uses for right top corner
rightBottomSymbol: '┘', // Symbol that uses for right bottom corner
marginTop: 0, // Margin before border is begins
marginBottom: 0, // Margin after border is ends
paddingTop: 0, // Padding after border begins
paddingBottom: 0, // Padding before border ends
printFn: process.stdout.write.bind(process.stdout) // Custom function for print generated message
});
```
```javascript
var printMessage = require('print-message');
printMessage([
"Hello",
"It's the huge world",
"But width can be calculated automatically"
]);
```
```javascript
var printMessage = require('print-message');
printMessage(['You can set your own options for border'], {
border: true, // Enable border
color: 'green', // Text color
borderColor: 'blue', // Border color is blue
borderSymbol: '│', // Symbol that uses for border
sideSymbol: '│', // Symbol that uses for side separators
leftTopSymbol: '└', // Symbol for left top corner
leftBottomSymbol: '┌', // Symbol for left bottom corner
rightTopSymbol: '┘', // Symbol for right top corner
rightBottomSymbol: '┐', // Symbol for right bottom corner
marginTop: 3, // Margin before border is begins
marginBottom: 3, // Margin after border is end
paddingTop: 2, // Padding top after border begins
paddingBottom: 2, // Padding bottom before border ends
printFn: function (message) {
// Custom function that accepts generated message as argument and print it
process.stdout.write(message);
}
});
```
```javascript
var printMessage = require('print-message');
printMessage([
"This message will be without border",
"But you still can set marginTop and marginBottom"
], {
border: false,
marginTop: 3,
marginBottom: 3
});
```
The MIT License (MIT)
Copyright (c) 2015 Eugene Obrezkov
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.