Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/haltcase/glob
Pure Nim library for matching file paths against Unix style glob patterns.
https://github.com/haltcase/glob
filesystem glob glob-matching hacktoberfest match pattern walk
Last synced: 29 days ago
JSON representation
Pure Nim library for matching file paths against Unix style glob patterns.
- Host: GitHub
- URL: https://github.com/haltcase/glob
- Owner: haltcase
- License: mit
- Created: 2018-05-21T04:02:42.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-27T15:57:45.000Z (9 months ago)
- Last Synced: 2024-10-16T08:05:01.722Z (about 1 month ago)
- Topics: filesystem, glob, glob-matching, hacktoberfest, match, pattern, walk
- Language: Nim
- Homepage: https://glob.bolingen.me
- Size: 538 KB
- Stars: 61
- Watchers: 2
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: license
Awesome Lists containing this project
README
# glob · [](https://nimble.directory/pkg/glob)  [](https://github.com/haltcase/glob/actions)
> Match file paths against Unix style patterns called _globs_.
_glob_ is a cross-platform, pure Nim implementation of [globs][wiki] that supports
creating patterns, testing file paths, and walking through directories to find
matching files or directories.
If you're unfamiliar with globs, they essentially let you use a simple language
to describe what filenames you're looking for with wildcards, placeholders, and
other pretty intuitive features.
You can find the full [documentation here](https://glob.bolingen.me/).
## features
* full glob support across platforms
* all glob syntax: `*` and `?` wildcards plus ranges, groups, & pattern matching
* efficient file system walking without unnecessary traversals
* configurable iteration behavior with sane defaults
* user defined filters for matching and directory traversal
## installation & usage
Install using [Nimble][nimble]:
```shell
nimble install glob
```
Then `import` and use:
```nim
import glob
const pattern = glob("src/**/*.nim")
assert "src/foo.nim".matches(pattern)
assert "src/lib.rs".matches(pattern).not
# directories are expanded by default
# so `src` and `src/**` are equivalent
for path in walkGlob("src"):
# every file in `src` or its subdirectories, lazily
echo path
# need the list now (eagerly)?
from sequtils import toSeq
echo toSeq(walkGlob("src/*.nim"))
```
## development
To build `glob` from source you'll need to install [Nim][nim] and its package
manager [Nimble][nimble].
1. Clone the repo: `git clone https://github.com/haltcase/glob.git`
2. Move into the newly cloned directory: `cd glob`
3. Make your changes: `src`, `tests.nim`
4. Run tests: `nimble test`
Commits should follow the [Conventional Commits][conventional] standard, which
allows for automated changelog generation.
Releases are deployed automatically when new tags are created. For collaborators
on this project, please follow this process for releasing a new version:
1. Ensure tests are passing, as usual.
2. Update the version in `glob.nimble` per [semver][semver].
3. Run `nimble prep_release`, which will update `changelog.md`, commit changes
to `glob.nimble` & `changelog.md`, and create a new tag.
4. Run `git push --follow-tags` to ensure the tag is pushed along with the commit.
5. GitHub Actions will take it from there: the new tag will trigger the
[`release` workflow][release-wf] to deploy a new version of the docs
and create a release on GitHub.
## contributing
This project is open to contributions of all kinds! Please check and search
the [issues](https://github.com/haltcase/glob/issues) if you encounter a
problem before opening a new one. Pull requests for improvements are also
welcome — see the steps above for [development](#development).
## license
MIT © [Bo Lingen](https://github.com/haltcase)
[wiki]: https://en.wikipedia.org/wiki/Glob_(programming)
[nim]: https://github.com/nim-lang/nim
[nimble]: https://github.com/nim-lang/nimble
[conventional]: https://www.conventionalcommits.org/en/v1.0.0/#summary
[fugitive]: https://github.com/haltcase/fugitive
[semver]: https://semver.org/
[release-wf]: https://github.com/haltcase/glob/blob/master/.github/workflows/release.yml