An open API service indexing awesome lists of open source software.

https://github.com/nochso/finder


https://github.com/nochso/finder

Last synced: 10 months ago
JSON representation

Awesome Lists containing this project

README

          

`github.com/nochso/finder`
==========================

[![Released under MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![GitHub release](https://img.shields.io/github/release/nochso/finder.svg?maxAge=2592000)](https://github.com/nochso/finder/releases)
[![SemVer 2.0.0](https://img.shields.io/badge/SemVer-2.0.0-blue.svg)][semver]
[![Build Status](https://travis-ci.org/nochso/finder.svg?branch=master)](https://travis-ci.org/nochso/finder)
[![Coverage Status](https://coveralls.io/repos/github/nochso/finder/badge.svg?branch=master)](https://coveralls.io/github/nochso/finder?branch=master)
[![Go Report Card](https://goreportcard.com/badge/github.com/nochso/finder)](https://goreportcard.com/report/github.com/nochso/finder)

A fluent interface around Go's [path/filepath.Walk].

- Inspired by [symfony/finder]
- Single external dependency on [gobwas/glob] for glob path matching

Installation
------------

```
go get github.com/nochso/finder
```

Usage
-----

See [documentation on godoc][godoc].

Changes
-------

See the [CHANGELOG] for a full history of versions and their changes.

Versioning
----------

This package adheres to [semantic versioning 2.0.0][semver].

*TL;DR* If you use version `1.*` you should never have problems using future
`1.*` versions. Only a major release e.g. `2.0.0` will break backwards
compatibility.

License
-------

This package is released under the MIT license. See [LICENSE] for the full
license.

[path/filepath.Walk]: https://golang.org/pkg/path/filepath/#Walk
[symfony/finder]: https://symfony.com/doc/current/components/finder.html
[gobwas/glob]: https://github.com/gobwas/glob
[LICENSE]: LICENSE
[semver]: http://semver.org/spec/v2.0.0.html
[godoc]: https://godoc.org/github.com/nochso/finder
[CHANGELOG]: CHANGELOG.md