gulp-sort

Sort files in stream by path or any custom sort comparator

Install

$ npm install gulp-sort --save-dev

Usage

1var sort = require('gulp-sort');
2
3// default sort
4gulp.src('./src/js/**/*.js')
5    .pipe(sort())
6    .pipe(gulp.dest('./build/js'));
7
8// pass in a custom comparator function
9gulp.src('./src/js/**/*.js')
10    .pipe(sort(customComparator))
11    .pipe(gulp.dest('./build/js'));
12
13// sort descending
14gulp.src('./src/js/**/*.js')
15    .pipe(sort({
16         asc: false
17    }))
18    .pipe(gulp.dest('./build/js'));
19
20// sort with a custom comparator
21gulp.src('./src/js/**/*.js')
22    .pipe(sort({
23        comparator: function(file1, file2) {
24            if (file1.path.indexOf('build') > -1) {
25                return 1;
26            }
27            if (file2.path.indexOf('build') > -1) {
28                return -1;
29            }
30            return 0;
31        }
32    }))
33    .pipe(gulp.dest('./build/js'));
34
35// sort with a custom sort function
36var stable = require('stable');
37gulp.src('./src/js/**/*.js')
38    .pipe(sort({
39        customSortFn: function(files, comparator) {
40            return stable(files, comparator);
41        }
42    }))
43    .pipe(gulp.dest('./build/js'));

Options

gulp-sort takes in an optional 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