grunt-bell

Plays an ascii bell and shows seconds taken by tasks

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
grunt-bell
220.1.29 years ago9 years agoMinified + gzip package size for grunt-bell in KB

Readme

grunt-bell
Plays an ascii bell

Getting Started

This plugin requires Grunt ~0.4.1 If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a 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-bell --save-dev ``` Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript: ```js grunt.loadNpmTasks('grunt-bell'); ```

The "bell" task

Overview

In your project's Gruntfile, use the bell task during your custom tasks defined with grunt.registerTask() or grunt.registerMultiTask(). ```js // sound the bell when these tasks complete grunt.registerTask('default', 'sometask', 'anothertask', 'bell'); ```

Options

options.separator

Type: String Default value: ', ' A string value that is used to do something with whatever.

options.punctuation

Type: String Default value: '.' A string value that is used to do something else with whatever else.

Usage Examples

Default Options

In this example, the default options are used to do something with whatever. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result would be Testing, 1 2 3. ```js grunt.initConfig({ bell: {
options: {},
files: {
'dest/default_options': ['src/testing', 'src/123'],
},
}, }) ```

Custom Options

In this example, custom options are used to do something else with whatever else. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result in this case would be Testing: 1 2 3 !!! ```js grunt.initConfig({ bell: {
options: {
separator: ': ',
punctuation: ' !!!',
},
files: {
'dest/default_options': ['src/testing', 'src/123'],
},
}, }) ```

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.

Release History

(Nothing yet)