File size: 2,139 Bytes
bc20498 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# [gulp](https://github.com/wearefractal/gulp)-sort
> Sort files in stream by path or any custom sort comparator
[](https://travis-ci.org/pgilad/gulp-sort)
## Install
`$ npm install gulp-sort --save-dev`
## Usage
```js
var sort = require('gulp-sort');
// default sort
gulp.src('./src/js/**/*.js')
.pipe(sort())
.pipe(gulp.dest('./build/js'));
// pass in a custom comparator function
gulp.src('./src/js/**/*.js')
.pipe(sort(customComparator))
.pipe(gulp.dest('./build/js'));
// sort descending
gulp.src('./src/js/**/*.js')
.pipe(sort({
asc: false
}))
.pipe(gulp.dest('./build/js'));
// sort with a custom comparator
gulp.src('./src/js/**/*.js')
.pipe(sort({
comparator: function(file1, file2) {
if (file1.path.indexOf('build') > -1) {
return 1;
}
if (file2.path.indexOf('build') > -1) {
return -1;
}
return 0;
}
}))
.pipe(gulp.dest('./build/js'));
// sort with a custom sort function
var stable = require('stable');
gulp.src('./src/js/**/*.js')
.pipe(sort({
customSortFn: function(files, comparator) {
return stable(files, comparator);
}
}))
.pipe(gulp.dest('./build/js'));
```
## Options
`gulp-sort` takes in an optional [comparator](#comparator) function, or dictionary with following params:
### asc
Sort ascending. Defaults to true. Specify false to sort descending.
### comparator
Comparator function to use. `comparator(file1, file2)`. Defaults to `localeCompare` of file paths.
### customSortFn
Use `customSortFn` in order to control the sorting yourself (useful for stable sorts).
`customSortFn` signature is as follows:
`customSortFn(<files>, <comparator>)`
- `files` being the vinyl file objects that were passed in
- `comparator` is the default comparator used, or a custom one that was passed as param
This function is expected to return back the sorted list of files.
## License
MIT ©[Gilad Peleg](http://giladpeleg.com)
|