The globule npm package is a utility for file system operations that involve matching file paths using glob patterns. It provides a simple and flexible way to find, read, and manipulate files based on patterns.
File Matching
This feature allows you to find files that match a specific glob pattern. In this example, it finds all JavaScript files in the 'src' directory and its subdirectories.
const globule = require('globule');
const matches = globule.find('src/**/*.js');
console.log(matches);File Copying
This feature allows you to copy files that match a specific glob pattern to a new location. In this example, it copies all JavaScript files from the 'src' directory to the 'dist' directory.
const globule = require('globule');
globule.copy('src/**/*.js', 'dist');File Deletion
This feature allows you to delete files that match a specific glob pattern. In this example, it deletes all JavaScript files in the 'dist' directory and its subdirectories.
const globule = require('globule');
globule.del('dist/**/*.js');File Reading
This feature allows you to read the contents of files that match a specific glob pattern. In this example, it reads and logs the contents of all JavaScript files in the 'src' directory and its subdirectories.
const globule = require('globule');
const files = globule.find('src/**/*.js');
files.forEach(file => {
const content = globule.read(file);
console.log(content);
});The 'glob' package is a popular library for matching files using glob patterns. It is similar to 'globule' but focuses solely on file matching without additional file manipulation features. It is widely used and has a simple API for finding files.
The 'fast-glob' package is a high-performance alternative to 'glob' and 'globule'. It offers faster file matching and supports advanced features like concurrency and caching. It is suitable for large projects where performance is critical.
The 'minimatch' package is a lightweight library for matching file paths against glob patterns. It is often used as a dependency in other packages and provides a simple and efficient way to perform pattern matching.
An easy-to-use wildcard globbing library.
Install the module with: npm install globule
var globule = require('globule');
var filepaths = globule.find('**/*.js');
Returns a unique array of all file or directory paths that match the given globbing pattern(s). This method accepts either comma separated globbing patterns or an array of globbing patterns. Paths matching patterns that begin with ! will be excluded from the returned array. Patterns are processed in order, so inclusion and exclusion order is significant. Patterns may be specified as function arguments or as a src property of the options object.
globule.find(patterns [, patterns [, ...]] [, options])
globule.find({src: patterns, /* other options */})
The options object supports all glob library options, along with a few extras. These are the most commonly used:
src This property may be used instead of specifying patterns as function arguments.filter Either a valid fs.Stats method name or a function that will be passed the matched src filepath and options object as arguments. This function should return a Boolean value.nonull Retain globbing patterns in result set even if they fail to match files.matchBase Patterns without slashes will match just the basename part. Eg. this makes *.js work like **/*.js.srcBase Patterns will be matched relative to the specified path instead of the current working directory. This is a synonym for cwd.prefixBase Any specified srcBase will be prefixed to all returned filepaths.Match one or more globbing patterns against one or more file paths. Returns a uniqued array of all file paths that match any of the specified globbing patterns. Both the patterns and filepaths arguments can be a single string or array of strings. Paths matching patterns that begin with ! will be excluded from the returned array. Patterns are processed in order, so inclusion and exclusion order is significant.
globule.match(patterns, filepaths [, options])
This method contains the same signature and logic as the globule.match method, but returns true if any files were matched, otherwise false.
globule.isMatch(patterns, filepaths [, options])
Given a set of source file paths, returns an array of src-dest file mapping objects. Both src and dest paths may be renamed, depending on the options specified. Patterns may be specified as function arguments or as a src property of the options object.
globule.mapping(filepaths [, filepaths [, ...]] [, options])
globule.mapping({src: filepaths, /* other options */})
In addition to the options the globule.find method supports, the options object also supports these properties:
srcBase The directory from which patterns are matched. Any string specified as srcBase is effectively stripped from the beginning of all matched paths.destBase The specified path is prefixed to all dest filepaths.ext Remove anything after (and including) the first . in the destination path, then append this value.extDot Change the behavior of ext, "first" and "last" will remove anything after the first or last . in the destination filename, respectively. Defaults to "first".flatten Remove the path component from all matched src files. The src file path is still joined to the specified destBase.rename If specified, this function will be responsible for returning the final dest filepath. By default, it flattens paths (if specified), changes extensions (if specified) and joins the matched path to the destBase.This method is a convenience wrapper around the globule.find and globule.mapping methods.
globule.findMapping(patterns [, options])
Given the files foo/a.js and foo/b.js:
globule.find("foo/*.js")
// ["foo/a.js", "foo/b.js"]
globule.find("*.js", {srcBase: "foo"})
// ["a.js", "b.js"]
globule.find({src: "*.js", srcBase: "foo", prefixBase: true})
// ["foo/a.js", "foo/b.js"]
globule.findMapping("foo/*.js")
// [{src: ["foo/a.js"], dest: "foo/a.js"}, {src: ["foo/b.js"], dest: "foo/b.js"}]
globule.findMapping("foo/*.js", {destBase: "bar"})
// [{src: ["foo/a.js"], dest: "bar/foo/a.js"}, {src: ["foo/b.js"], dest: "bar/foo/b.js"}]
globule.findMapping({src: "*.js", srcBase: "foo", destBase: "bar"})
// [{src: ["foo/a.js"], dest: "bar/a.js"}, {src: ["foo/b.js"], dest: "bar/b.js"}]
globule.mapping(["foo/a.js", "foo/b.js"])
// [{src: ["foo/a.js"], dest: "foo/a.js"}, {src: ["foo/b.js"], dest: "foo/b.js"}]
globule.mapping(["foo/a.js", "foo/b.js"], {destBase: "bar"})
// [{src: ["foo/a.js"], dest: "bar/foo/a.js"}, {src: ["foo/b.js"], dest: "bar/foo/b.js"}]
globule.mapping("foo/a.js", "foo/b.js", {destBase: "bar"})
// [{src: ["foo/a.js"], dest: "bar/foo/a.js"}, {src: ["foo/b.js"], dest: "bar/foo/b.js"}]
globule.mapping(["a.js", "b.js"], {srcBase: "foo", destBase: "bar"})
// [{src: ["foo/a.js"], dest: "bar/a.js"}, {src: ["foo/b.js"], dest: "bar/b.js"}]
globule.mapping({src: ["a.js", "b.js"], srcBase: "foo", destBase: "bar"})
// [{src: ["foo/a.js"], dest: "bar/a.js"}, {src: ["foo/b.js"], dest: "bar/b.js"}]
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
2018-05-29 - v1.2.1 - Update dependencies, lodash@4.17.10 to avoid errant security warnings.
2017-06-10 - v1.2.0 - Update dependencies, lodash@4.17.
2016-10-23 - v1.1.0 - Update dependencies, lodash@4.16, glob@7.1.
2016-04-14 - v1.0.0 - Update dependencies, lodash@4.9, glob@7.0, minimatch@3.0. Paths are unix-style with prefixBase enabled.
2014-01-07 - v0.2.0 - Updated dependencies. Added src option. Improved exclusion speed significantly.
2013-04-11 - v0.1.0 - Initial release.
Copyright (c) 2018 "Cowboy" Ben Alman
Licensed under the MIT license.
FAQs
An easy-to-use wildcard globbing library.
We found that globule demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 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
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.