https://github.com/caseywebb/taskr-rename
:pencil2: Rename plugin for Taskr
https://github.com/caseywebb/taskr-rename
fly-plugin flyjs rename taskr taskr-plugin
Last synced: about 2 months ago
JSON representation
:pencil2: Rename plugin for Taskr
- Host: GitHub
- URL: https://github.com/caseywebb/taskr-rename
- Owner: caseyWebb
- License: wtfpl
- Created: 2017-03-07T00:41:54.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-07T11:57:04.000Z (about 2 years ago)
- Last Synced: 2024-10-18T07:12:30.628Z (7 months ago)
- Topics: fly-plugin, flyjs, rename, taskr, taskr-plugin
- Language: JavaScript
- Homepage:
- Size: 1.01 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# taskr-rename
> Rename plugin for [Taskr][]
**NOTE:** This repository has been renamed from fly-rename to taskr-rename. If you haven't yet migrated to [Taskr][], now is the time to do so.
[![NPM][npm-shield]][npm]
[![License][license-shield]][license]
[![Build Status][build-status-shield]][build-status]
[![Coverage Status][codecov-shield]][codecov]
[![Dependency Status][david-dm-shield]][david-dm]
## Install
```yarn
$ yarn add -D taskr taskr-rename
```
*or*
```bash
$ npm install --save-dev taskr taskr-rename
```
## Usage
### Object
```js
export default function* (task) {
yield task.source('./src/foo.js')
.rename({
dirname: 'dir/name',
basename: 'bar',
prefix: 'prefix-',
suffix: '-suffix',
extname: '.html'
})
.target('./dist')
// .dist/dir/name/prefix-bar-suffix.html
}
```
### Function
```js
export default function* (task) {
yield task.source('./src/foo.js')
.rename((file) => {
file.dirname = 'dir/name'
file.basename = 'bar'
file.extname = '.html'
})
.target('./dist')
// .dist/dir/name/bar.html
}
```
[Taskr]: https://github.com/lukeed/taskr
[npm]: https://npmjs.com/package/taskr-rename
[npm-shield]: https://img.shields.io/npm/v/taskr-rename.svg
[license]: ./LICENSE
[license-shield]: https://img.shields.io/npm/l/taskr-rename.svg
[build-status]: https://github.com/caseyWebb/taskr-rename/actions/workflows/nodejs.yml
[build-status-shield]: https://img.shields.io/github/workflow/status/caseyWebb/taskr-rename/Node%20CI/master
[codecov]: https://codecov.io/gh/caseyWebb/taskr-rename
[codecov-shield]: https://img.shields.io/codecov/c/github/caseyWebb/taskr-rename.svg