Get the file paths in a
vinylstream
Useful when you need to use the file paths from a Gulp pipeline in an async Node.js package.
Simply pass an async function such as del and this package will provide each path in the stream as the first argument.
$ npm install vinyl-paths
// gulpfile.js
const gulp = require('gulp');
const stripDebug = require('gulp-strip-debug');
const del = require('del');
const vinylPaths = require('vinyl-paths');
// Log file paths in the stream
gulp.task('log', =>
gulp.src('app/*')
.pipe(stripDebug())
.pipe(vinylPaths(async paths => {
console.log('Paths:', paths);
})
);
// Delete files in the stream
gulp.task('delete', =>
gulp.src('app/*')
.pipe(stripDebug())
.pipe(vinylPaths(del))
);
// Or if you need to use the paths after the pipeline
gulp.task('delete2', =>
new Promise(function (resolve, reject) {
const vp = vinylPaths();
gulp.src('app/*')
.pipe(vp)
.pipe(gulp.dest('dist'))
.on('end', async () => {
try {
await del(vp.paths);
resolve();
} catch (error) {
reject(error);
}
});
})
);You should only use a vanilla Node.js package like this if you're already using other plugins in the pipeline, otherwise just use the module directly as gulp.src is costly. Remember that Gulp tasks can return promises as well as streams!
The optional callback will receive a file path for every file and is expected to return a promise. An array of the file paths so far is available as a paths property on the stream.
- gulp-revert-path - Revert the previous
file.pathchange