Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/teppeis/grunt-parallelize
Make your task parallel.
https://github.com/teppeis/grunt-parallelize
grunt
Last synced: 4 days ago
JSON representation
Make your task parallel.
- Host: GitHub
- URL: https://github.com/teppeis/grunt-parallelize
- Owner: teppeis
- License: mit
- Created: 2013-09-08T17:57:24.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2020-04-30T22:07:42.000Z (over 4 years ago)
- Last Synced: 2024-12-16T18:54:55.124Z (7 days ago)
- Topics: grunt
- Language: JavaScript
- Homepage: https://npmjs.org/package/grunt-parallelize
- Size: 243 KB
- Stars: 79
- Watchers: 4
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
grunt-parallelize
====
Make your task parallel.
[![NPM version][npm-image]][npm-url]
![Node.js version support][node-version]
[![build status][travis-image]][travis-url]
[![Dependency Status][deps-image]][deps-url]
![MIT License][license]
This plugin divides src files of your task and executes them in parallel.
If your task has too many src files and it's CPU intensive like JSHint, this plugin reduces your build time significantly.
#### Before (36sec to jshint 1640 files)
#### Parallelize! (14sec to jshint 1640 files by 4 parallel)
## Getting Started
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide.
Then you can install this plugin to your project with:
```shell
$ npm install grunt-parallelize --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-parallelize');
```
In your project's Gruntfile, add a section named `parallelize` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
jshint: {
all: {
src: './**/*.js'
}
},
parallelize: {
jshint: {
// Run jshint:all task with 2 child processes in parallel.
all: 2
},
},
});
```
And just prefix `parallelize:` to your task name.
```shell
# Normal single process
$ grunt jshint:all
Running "jshint:all" (jshint) task
>> 101 files lint free.
Done, without errors.
# Parallelize!
$ grunt parallelize:jshint:all
Running "parallelize:jshint:all" (parallelize) task
Running "jshint:all" (jshint) task
>> 51 files lint free.
Done, without errors.
Running "jshint:all" (jshint) task
>> 50 files lint free.
Done, without errors.
Done, without errors.
```
### Why grunt-parallelize?
There are concurrent or parallel processing grunt plugins like [grunt-concurrent](https://github.com/sindresorhus/grunt-concurrent) or [grunt-parallel](https://github.com/iammerrick/grunt-parallel).
They execute different tasks in parallel, but this plugin divides a task into multi processes.
## Configuration
### Options
#### options.processes
Type: `Number`
A number of processes.
This is equivalent with the above.
```js
parallelize: {
options: {
processes: 2
},
jshint: {
all: true
},
},
```
### Files format
grunt-parallelize supports all [Grunt standard files formats](http://gruntjs.com/configuring-tasks#files).
* [Compact Format](http://gruntjs.com/configuring-tasks#compact-format)
* [Files Object Format](http://gruntjs.com/configuring-tasks#files-object-format)
* [Files Array Format](http://gruntjs.com/configuring-tasks#files-array-format)
* [Dynamic Options](http://gruntjs.com/configuring-tasks#building-the-files-object-dynamically)
#### Only `src`
If only `src` is specified, the src files are devided per each process.
```js
grunt.initConfig({
jshint: {
all: {
src: ['src/1.js', 'src/2.js', 'src/3.js']
}
},
parallelize: {
jshint: {
all: 2
},
},
});
```
=> parallelized as:
* Process 1: `src/1.js` and `src/2.js`
* Process 2: `src/3.js`
#### Both `src` and `dest`
If `dest` is specified, the dest files are devided per each process.
```js
grunt.initConfig({
concat: {
all: {
files: [
{src: ['src/1.js', 'src/2.js'], dest: 'dest/1.js'},
{src: ['src/3.js', 'src/4.js'], dest: 'dest/2.js'},
{src: ['src/5.js'], dest: 'dest/3.js'},
],
}
},
parallelize: {
jshint: {
all: 2
},
},
});
```
=> parallelized as:
* Process 1: `dest/1.js` (including 'src/1.js' and 'src/2.js') and `dest/2.js` (including 'src/3.js' and 'src/4.js')
* Process 2: `dest/3.js` (including 'src/5.js')
## Thanks
This plugin is inspired by [sindresorhus's grunt-concurrent](https://github.com/sindresorhus/grunt-concurrent). Thanks!
## Changelog
* 2016-04-08 v1.1.7 Fix peerDependencies [#31](https://github.com/teppeis/grunt-parallelize/pull/31)
* 2016-04-07 v1.1.6 Use grunt@1 for internal test [#30](https://github.com/teppeis/grunt-parallelize/pull/30)
* 2016-03-21 v1.1.5 Update dependencies
* 2016-03-16 v1.1.4 Support [email protected] [#24](https://github.com/teppeis/grunt-parallelize/pull/24)
* 2015-11-05 v1.1.3 Cleanup tmp files [#21](https://github.com/teppeis/grunt-parallelize/issues/21)
* 2015-11-05 v1.1.2 Change internal file format [#22](https://github.com/teppeis/grunt-parallelize/issues/22)
* 2015-11-05 v1.1.1 Update deps [#20](https://github.com/teppeis/grunt-parallelize/issues/20)
* 2015-03-23 v1.1.0 Support all file formats and `dest`. Fix ENAMETOOLONG [#13](https://github.com/teppeis/grunt-parallelize/issues/13)
* 2015-02-07 v1.0.1 Update dependencies, test with Node.js v0.12
* 2013-12-23 v1.0.0 Update dependencies
* 2013-11-22 v0.1.1 Replace deprecated grunt.util methods in grunt-0.4.2
* 2013-09-09 v0.1.0 First release
## License
MIT License: Teppei Sato <[email protected]>
[npm-image]: https://img.shields.io/npm/v/grunt-parallelize.svg
[npm-url]: https://npmjs.org/package/grunt-parallelize
[travis-image]: https://travis-ci.org/teppeis/grunt-parallelize.svg?branch=master
[travis-url]: https://travis-ci.org/teppeis/grunt-parallelize
[deps-image]: https://david-dm.org/teppeis/grunt-parallelize.svg
[deps-url]: https://david-dm.org/teppeis/grunt-parallelize
[node-version]: https://img.shields.io/badge/Node.js%20support-v0.10–v5-brightgreen.svg
[license]: https://img.shields.io/npm/l/grunt-parallelize.svg