glob-stream
Advanced tools
Package description
The glob-stream npm package allows for reading file paths from a globbing pattern. It is a wrapper around node-glob and vinyl-fs to stream the file objects that match the glob patterns. This package is particularly useful in build processes and file manipulation scripts where matching files based on patterns is required.
Reading files using glob patterns
This feature allows you to read files that match a specific pattern. In the code sample, all JavaScript files under the 'src' directory and its subdirectories are matched and their paths are logged.
const globStream = require('glob-stream');
const stream = globStream('./src/**/*.js');
stream.on('data', function(file) {
console.log(file.path);
});Combining multiple glob patterns
glob-stream supports combining multiple patterns, including exclusion patterns. In this example, all JavaScript files under 'src' except those in the 'vendor' subdirectory are matched.
const globStream = require('glob-stream');
const stream = globStream(['./src/**/*.js', '!./src/vendor/**']);
stream.on('data', function(file) {
console.log(file.path);
});fast-glob is an alternative to glob-stream that provides a similar functionality of matching files based on glob patterns. It is known for its performance and offers a promise-based API, making it a good choice for modern asynchronous workflows. Unlike glob-stream, fast-glob does not return a stream of file objects but rather a promise that resolves with an array of matching paths.
node-glob is the underlying library used by glob-stream for matching files based on patterns. While glob-stream provides a stream interface for handling the matched files, node-glob itself focuses on the globbing functionality and returns an array of matched file paths. It is a more basic option for those who do not need the streaming capabilities offered by glob-stream.
Readme
A wrapper around node-glob to make it streamy.
var gs = require('glob-stream');
var stream = gs.create('./files/**/*.coffee', { /* options */ });
stream.on('data', function(file){
// file has path, base, and cwd attrs
});
You can pass any combination of globs. One caveat is that you can not only pass a glob negation, you must give it at least one positive glob so it knows where to start. All given must match for the file to be returned.
Returns a stream for multiple globs or filters.
Returns a stream for a single glob or filter.
process.cwd()falsefalseThis argument is passed directly to node-glob so check there for more options
var stream = gs.create(['./**/*.js', '!./node_modules/**/*']);
Globs are executed in order, so negations should follow positive globs. For example:
gulp.src(['!b*.js', '*.js'])
would not exclude any files, but this would
gulp.src(['*.js', '!b*.js'])
glob wrapper with support for multiple patterns.MIT
FAQs
Readable streamx interface over anymatch.
We found that glob-stream demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.