https://github.com/ship-components/ship-components-banner
https://github.com/ship-components/ship-components-banner
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/ship-components/ship-components-banner
- Owner: ship-components
- Created: 2015-08-10T05:03:33.000Z (almost 11 years ago)
- Default Branch: develop
- Last Pushed: 2018-10-23T19:00:21.000Z (over 7 years ago)
- Last Synced: 2024-04-24T08:27:31.219Z (about 2 years ago)
- Language: JavaScript
- Size: 127 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ship-components-banner
[](https://www.npmjs.com/package/ship-components-banner)
[](https://david-dm.org/ship-components/ship-components-banner)
Generates a banner from a package.json file.
## Install
```shell
npm install ship-components-banner --save-dev
```
## Usage
```js
var ShipComponentsBanner = require('ship-components-banner');
// Basic Usage
var banner = new ShipComponentsBanner().build();
console.log(banner);
/*!
* ___.
* \_ |__ _____ ____ ____ ___________
* | __ \\__ \ / \ / \_/ __ \_ __ \
* | \_\ \/ __ \| | \ | \ ___/| | \/
* |___ (____ /___| /___| /\___ >__|
* \/ \/ \/ \/ \/
* ship-components-banner X.X.X
* Description: Generates a fancy banner from a package.json file
* Author: Isaac Suttell
* License: MIT
*/
```
## Options
```js
var ShipComponentsBanner = require('ship-components-banner');
var banner = new ShipComponentsBanner({
/**
* Either takes a path or an object. It defaults to the package.json in your process.cwd()
* @type {String|Object}
*/
pkg: 'package.json',
/**
* ASCII Font to use. See below for more options.
* @type {String}
*/
font: 'Graffiti',
/**
* Should an ascii art title be generated?
* @type {Boolean}
*/
fancy: true,
/**
* Default line ending us UNIX
* @type {String}
*/
lineEnding: '\n',
/**
* Wrap everything in a comment or just create the text
* @type {Boolean}
*/
wrap: true,
/**
* Add a line break at the end
* @type {Boolean}
*/
lastLineBreak: true,
/**
* Add a timestamp which can be useful for automated build systems
* @type {Boolean}
*/
timestamp: false,
/**
* An array of keys to include in order
* @type {Array}
*/
keys: ['name', 'description', 'author', 'homepage', 'bugs', 'license'],
}).build();
```
## Fonts
You can get a list of fonts with a preview of each by running:
```shell
$ npm run fonts
```
From the command line of your project.
## License
The MIT License (MIT)
Copyright (c) 2017 SHIP
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.