sfcode
An Online Competing and Development Environment
|
Contributing
Extended glob support for JavaScript. Adds (almost) the expressive power of regular expressions to glob patterns.
Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.
Install with npm:
Heads up!: This library only supports extglobs, to handle full glob patterns and other extended globbing features use micromatch instead.
The main export is a function that takes a string and options, and returns an object with the parsed AST and the compiled .output
, which is a regex-compatible string that can be used for matching.
Extended globbing patterns can be defined as follows (as described by the bash man page):
| pattern | regex equivalent | description | | — | — | — | | ?(pattern-list)
| (...|...)?
| Matches zero or one occurrence of the given pattern(s) | | *(pattern-list)
| (...|...)*
| Matches zero or more occurrences of the given pattern(s) | | +(pattern-list)
| (...|...)+
| Matches one or more occurrences of the given pattern(s) | | @(pattern-list)
| (...|...)
[1] | Matches one of the given pattern(s) | | !(pattern-list)
| N/A | Matches anything except one of the given pattern(s) |
Convert the given extglob
pattern into a regex-compatible string. Returns an object with the compiled result and the parsed AST.
Params
pattern
**{String}**options
**{Object}**returns
**{String}**Example
Takes an array of strings and an extglob pattern and returns a new array that contains only the strings that match the pattern.
Params
list
**{Array}**: Array of strings to matchpattern
**{String}**: Extglob patternoptions
**{Object}**returns
**{Array}**: Returns an array of matchesExample
Returns true if the specified string
matches the given extglob pattern
.
Params
string
**{String}**: String to matchpattern
**{String}**: Extglob patternoptions
**{String}**returns
**{Boolean}**Example
Returns true if the given string
contains the given pattern. Similar to .isMatch
but the pattern can match any part of the string.
Params
str
**{String}**: The string to match.pattern
**{String}**: Glob pattern to use for matching.options
**{Object}**returns
**{Boolean}**: Returns true if the patter matches any part of str
.Example
Takes an extglob pattern and returns a matcher function. The returned function takes the string to match as its only argument.
Params
pattern
**{String}**: Extglob patternoptions
**{String}**returns
**{Boolean}**Example
Convert the given extglob
pattern into a regex-compatible string. Returns an object with the compiled result and the parsed AST.
Params
str
**{String}**options
**{Object}**returns
**{String}**Example
Returns an array of matches captured by pattern
in string
, or null
if the pattern did not match.
Params
pattern
**{String}**: Glob pattern to use for matching.string
**{String}**: String to matchoptions
**{Object}**: See available options for changing how matches are performedreturns
**{Boolean}**: Returns an array of captures if the string matches the glob pattern, otherwise null
.Example
Create a regular expression from the given pattern
and options
.
Params
pattern
**{String}**: The pattern to convert to regex.options
**{Object}**returns
**{RegExp}**Example
Available options are based on the options from Bash (and the option names used in bash).
Type: boolean
Default: undefined
When enabled, the pattern itself will be returned when no matches are found.
Alias for options.nullglob, included for parity with minimatch.
Type: boolean
Default: undefined
Functions are memoized based on the given glob patterns and options. Disable memoization by setting options.cache
to false.
Type: boolean
Default: undefined
Throw an error is no matches are found.
Last run on December 21, 2017
This library has complete parity with Bash 4.3 with only a couple of minor differences.
options.contains
to true.<details>
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
</details>
<details>
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
</details> <details>
Building docs
_(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)_
To generate the readme, run the following command:
</details>
You might also be interested in these projects:
step
to… more | homepageCommits | Contributor |
---|---|
49 | jonschlinkert |
2 | isiahmeadows |
1 | doowb |
1 | devongovett |
1 | mjbvz |
1 | shinnn |
Jon Schlinkert
Copyright © 2017, Jon Schlinkert. Released under the [MIT License](LICENSE).
This file was generated by verb-generate-readme, v0.6.0, on December 21, 2017.
<section class="footnotes">
@
isn "'t a RegEx character." ↩
</section>