https://github.com/caseywebb/taskr-filter
:heavy_minus_sign: Filter plugin for Taskr
https://github.com/caseywebb/taskr-filter
fly fly-plugin taskr taskr-plugin
Last synced: about 2 months ago
JSON representation
:heavy_minus_sign: Filter plugin for Taskr
- Host: GitHub
- URL: https://github.com/caseywebb/taskr-filter
- Owner: caseyWebb
- License: wtfpl
- Created: 2017-10-25T21:48:20.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T11:01:44.000Z (over 2 years ago)
- Last Synced: 2024-10-18T07:13:03.563Z (7 months ago)
- Topics: fly, fly-plugin, taskr, taskr-plugin
- Language: JavaScript
- Size: 1.31 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# taskr-filter
> Filter plugin for [Taskr][]
[![NPM][npm-shield]][npm]
[![License][license-shield]][license]
[![Build Status][build-status-shield]][build-status]
[![Coverage Status][codecov-shield]][codecov]
## Install
```yarn
$ yarn add -D taskr taskr-filter
```
_or_
```bash
$ npm install --save-dev taskr taskr-filter
```
## Usage
### Function
```js
export default function*(task) {
yield task
.source(path.join(__dirname, 'src/*'))
.filter((file) => {
// file.base
// file.dir
// file.data
return file.base.indexOf('.js') > 1
})
.target('./dist')
}
```
### RegExp
```js
export default function*(task) {
yield task
.source(path.join(__dirname, 'src/*'))
.filter(/\.js$/)
.target('./dist')
}
```
### Glob(s)
Uses [multimatch][], which supports multiple patterns
### RegExp
```js
export default function*(task) {
yield task
.source(path.join(__dirname, 'src/*'))
.filter('**/*.js')
.target('./dist')
}
```
**NOTE:** RegExps and globs are tested against the full path. You will need to use globstars, and may want to restrict them to your workspace. For example, to match anything with 'ba', but only in a specified directory, use `path.join(__dirname, 'ba*')`.
[taskr]: https://github.com/lukeed/taskr
[multimatch]: https://www.npmjs.com/package/multimatch
[npm]: https://npmjs.com/package/taskr-filter
[npm-shield]: https://img.shields.io/npm/v/taskr-filter.svg
[license]: ./LICENSE
[license-shield]: https://img.shields.io/npm/l/taskr-filter.svg
[build-status]: https://github.com/caseyWebb/taskr-filter/actions/workflows/nodejs.yml
[build-status-shield]: https://img.shields.io/github/workflow/status/caseyWebb/taskr-filter/Node%20CI/master
[codecov]: https://codecov.io/gh/caseyWebb/taskr-filter
[codecov-shield]: https://img.shields.io/codecov/c/github/caseyWebb/taskr-filter.svg