Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/olizilla/grunt-asciify
figlet-js based grunt task turns plain-text into Awesome Text
https://github.com/olizilla/grunt-asciify
Last synced: 9 days ago
JSON representation
figlet-js based grunt task turns plain-text into Awesome Text
- Host: GitHub
- URL: https://github.com/olizilla/grunt-asciify
- Owner: olizilla
- License: mit
- Created: 2013-02-23T14:08:36.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2013-10-27T21:45:15.000Z (about 11 years ago)
- Last Synced: 2024-12-13T12:50:33.683Z (21 days ago)
- Language: JavaScript
- Size: 251 KB
- Stars: 20
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# grunt-asciify
# grunt-asciify
Ascii awesomizer. A Grunt task for better banners and hot logs.
```
_____ __________________ .___ .___ ________________.___.._.
/ _ \ / _____/\_ ___ \ | || |\_ _____/\__ | || |
/ /_\ \ \_____ \ / \ \/ | || | | __) / | || |
/ | \ / \\ \____| || | | \ \____ | \|
\____|__ //_______ / \______ /|___||___| \___ / / ______| __
\/ \/ \/ \/ \/ \/
```
[](https://david-dm.org/olizilla/grunt-asciify)
[](https://travis-ci.org/olizilla/grunt-asciify)
Running the asciify task as configured below will push your awesomized text into property called `asciify_myBanner` which can then be used else where, as the template for an awesome file banner for example.
```js
asciify: {
myBanner: {
text: 'Text to asciify'
}
},
uglify:{
options: {
banner: '/*!\n <%= asciify_myBanner %> \n*/\n'
},
all:{
src:'Gruntfile.js',
dest:'Gruntfile.withbanner.min.js'
}
}
```
Asciify picks a property name to store the output by prepending your target name with `asciify_`. In the above example we used `myBanner` as the target, so the property name became `asciify_myBanner`.
## Getting Started
This plugin requires Grunt `~0.4.0`
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
```shell
npm install grunt-asciify --save-dev
```
One the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-asciify');
```
## The "asciify" task
In your project's Gruntfile, add a section named `asciify` to the data object passed into `grunt.initConfig()`.
### Options
#### Default Options
```js
options:{
font:'graffiti'
log:false,
}
```
#### options.font
Type: `String`
Default value: `graffiti`
The name of the figlet font to use. View the [font list](https://github.com/olizilla/figlet-js/tree/master/fonts) and [examples](http://www.figlet.org/examples.html). Use the [asciify](https://npmjs.org/package/asciify) module to show all fonts for your text: `asciify -a "All The Fonts!"`.
#### options.log
Type: `Boolean`
Default value: `false`
Write your asciified text to the console
### Usage Examples
```js
grunt.initConfig({
asciify: {
banner:{
text: 'GRUNT-ASCIIFY!',
// Add the awesome to the console, and use the best font.
options:{
font:'graffiti',
log:true
}
}
},
uglify:{
// Use the property holding our awesomised text in the banner template
options: {
banner: '/*!\n <%= asciify_banner %> \n*/\n'
},
all:{
src:'Gruntfile.js',
dest:'Grunfile.withbanner.min.js'
}
}
});
grunt.loadNpmTasks('grunt-asciify');
grunt.loadNpmTasks('grunt-contrib-uglify');
// Run asciify before uglify so the asciify_banner property is available.
grunt.registerTask('default', ['asciify', 'uglify']);
```
## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).
## Release History
* 0.2.2 - ASCIIFYING TO CONSOLE NOW TRUNCATES TO FIT THE SPACE AVAILABLE
* 0.2.1 - ASCIIFY CORE UPDATED. NO BANNERS WERE HARMED.
* 0.2.0 - GRAFFITI BEATS STANDARD AS DEFAULT FONT. NOW DEPENDS ON THE ASCIIFY MODULE.
* 0.1.0 - IT BEGINS. ASCII BANNERS NOW MANDTORY.