Skip to content

Latest commit

 

History

History
93 lines (68 loc) · 3.41 KB

readme.md

File metadata and controls

93 lines (68 loc) · 3.41 KB
Raw

glob · nimble license GitHub Actions

Match file paths against Unix style patterns called globs.

glob is a cross-platform, pure Nim implementation of globs 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.

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 install glob

Then import and use:

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 and its package manager 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 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.
  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 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 if you encounter a problem before opening a new one. Pull requests for improvements are also welcome — see the steps above for development.

license

MIT © Bo Lingen