gulp-packages/README.md

gulp package management helper

# gulp package management helper

## Features

1. Smart package-require notation
2. Add 'install' task to your gulpfile
3. Add 'uninstall' task to your gulpfile

[For more details](http://qiita.com/ktty1220/items/c1c5705c9b0114f29bb9)

## Install

```sh
$ npm install gulp-packages
```

## Features1: Smart package-require notation

### BEFORE

__gulpfile.js__

```js
var gulp = require('gulp');
var less = require('gulp-less');
var coffee = require('gulp-coffee');
var pleeease = require('gulp-pleeease');
var minifyCss = require('gulp-minify-css');
var taskListing = require('gulp-task-listing');
var minHtm = require('gulp-html-minifier');
var uglify = require('gulp-uglify');
var rename = require('gulp-rename');
var watch = require('gulp-watch');
var plumber = require('gulp-plumber');
var coffeelint = require('gulp-coffeelint');
var concat = require('gulp-concat');
```

### AFTER

__gulpfile.js__

```js
var gulp = require('gulp');
var pkg = require('gulp-packages')(gulp, [
  'less',
  'coffee',
  'pleeease',
  'minify-css',               // MUST call it by pkg.minifyCss()
  'taskListing',              // CamelCase of package name, call it by pkg.taskListing()
  'html-minifier as minHtm',  // call it by pkg.minHtm(), pkg.htmlMinifier DOESN'T work!
  'uglify',
  'rename',
  'watch',
  'plumber',
  'coffeelint',
  'concat'
]);
```

For the above example, Packages are loaded into `pkg` variable.

#### Use of loaded packages

```js
gulp.src('/path/to/*.coffee')
  .pipe(pkg.plumber())  // <-
  .pipe(pkg.coffee())   // <- pkg.XXX(package name)
  .pipe(pkg.uglify())   // <-
  .pipe(gulp.dest('js/'));
```

## Features2: Add 'install' task to your gulpfile

When the following conditions:

__gulpfile.js__

```js
var gulp = require('gulp');
var pkg = require('gulp-packages')(gulp, [
  'less',
  'coffee',
  'pleeease',
  'minify-css',
  'taskListing',
  'uglify',                   // <- not installed yet
  'html-minifier as minHtm',  // <- not installed yet
  'rename',                   // <- not installed yet
  'watch',
  'plumber',                  // <- not installed yet
  'coffeelint',
  'concat'                    // <- not installed yet
]);
```

### BEFORE

```sh
$ npm install gulp-uglify gulp-html-minifier gulp-rename gulp-plumber gulp-concat --save-dev
```

### AFTER

```sh
$ gulp install
```

## Features3: Add 'uninstall' task to your gulpfile

When the following conditions:

__gulpfile.js__

```js
var gulp = require('gulp');
var pkg = require('gulp-packages')(gulp, [
  'less',
  'coffee',
  'pleeease',
  'minify-css',
  'taskListing',
  'watch',
  'coffeelint',
]);
```

and

__package.json__

```json:package.json
{
  "devDependencies": {
    "coffee-script": "*",
    "gulp": "*",
    "gulp-coffee": "*",
    "gulp-coffeelint": "*",
    "gulp-concat": "*",         // <- no longer using
    "gulp-less": "*",
    "gulp-minify-css": "*",
    "gulp-pleeease": "*",
    "gulp-plumber": "*",        // <- no longer using
    "gulp-rename": "*",         // <- no longer using
    "gulp-uglify": "*",         // <- no longer using
    "gulp-html-minifier": "*",  // <- no longer using
    "gulp-watch": "*",
    "gulp-task-listing": "*"
  }
}
```

### BEFORE

```sh
$ npm uninstall gulp-concat gulp-plumber gulp-rename gulp-uglify gulp-html-minifier --save-dev
```

### AFTER

```sh
$ gulp uninstall
```

## Package name rule

1. Remove 'gulp-'
2. [optional] Convert to CamelCase (You can specify non-converted package name. But you must convert to CamelCase when call it)
3. "as" overwrites call name for shorter or else

### Example

| gulp-name       | pkg-name               | call-name         | note                               |
|:----------------|:-----------------------|:------------------|:-----------------------------------|
| gulp-uglify     | 'uglify'               | pkg.uglify()      |                                    |
| gulp-minify-css | 'minifyCss'            | pkg.minifyCss()   | CamelCase of package name          |
| gulp-minify-css | 'minify-css'           | pkg.minifyCss()   | Specify non-converted package name |
| gulp-minify-css | 'minify-css as minCss' | pkg.minCss()      | Using alias                        |

## Changelog

### 0.2.0 (2014-08-30)

* Package name alias (using "as") supported
* Removed internal properties from gulp object
* Show warning when package duplicated

### 0.1.3 (2014-07-27)

* Added 'gulpfriendly' keyword to package.json

### 0.1.2 (2014-07-27)

* 'install' and 'uninstall' changed to synchronized task
* Colored message supported
* Added jshint options comment
* Fixed some messages

### 0.1.1 (2014-07-27)

* Changed to exclude 'gulp-packages' from uninstall target

### 0.1.0 (2014-07-26)

* First release

## License

[MIT license](http://www.opensource.org/licenses/mit-license)

&copy; 2014 [ktty1220](mailto:ktty1220@gmail.com)