Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lukeed/taskr
A fast, concurrency-focused task automation tool.
https://github.com/lukeed/taskr
bluebird coroutines generators lightweight nodejs parallel performance task-runner tasks
Last synced: about 2 months ago
JSON representation
A fast, concurrency-focused task automation tool.
- Host: GitHub
- URL: https://github.com/lukeed/taskr
- Owner: lukeed
- License: mit
- Created: 2015-06-30T12:19:00.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-12-21T17:09:00.000Z (over 3 years ago)
- Last Synced: 2024-04-15T15:34:07.548Z (5 months ago)
- Topics: bluebird, coroutines, generators, lightweight, nodejs, parallel, performance, task-runner, tasks
- Language: JavaScript
- Homepage:
- Size: 1.12 MB
- Stars: 2,527
- Watchers: 54
- Forks: 89
- Open Issues: 16
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
- awesome-list - taskr - focused task automation tool. | lukeed | 2400 | (JavaScript)
- awesome-starred - lukeed/taskr - A fast, concurrency-focused task automation tool. (nodejs)
README
Taskr
A fast, concurrency-focused task runner.
Fasten your seatbelt. :rocket:
Taskr is a highly performant task runner, much like Gulp or Grunt, but written with concurrency in mind. With Taskr, everything is a [coroutine](https://medium.com/@tjholowaychuk/callbacks-vs-coroutines-174f1fe66127#.vpryf5tyb), which allows for cascading and composable tasks; but unlike Gulp, it's not limited to the stream metaphor.
Taskr is extremely extensible, so _anything_ can be a task. Our core system will accept whatever you throw at it, resulting in a modular system of reusable plugins and tasks, connected by a declarative [`taskfile.js`](https://github.com/lukeed/taskr/tree/master/packages/taskr#taskfiles) that's easy to read.
```js
const src = 'src/{admin,client}';
const dist = 'build';
module.exports = {
*lint(task) {
yield task.source(`${src}/*.js`).xo({ esnext:true });
},
*scripts(task) {
yield task.source(`${src}/*.js`).babel({ presets:['es2015'] }).target(`${dist}/js`);
},
*styles(task) {
yield task.source(`${src}/*.sass`).sass().autoprefixer().target(`${dist}/css`);
},
*build(task) {
yield task.parallel(['lint', 'scripts', 'styles']);
}
}
```
## History
> **TL;DR** This is the continuation of and successor to [Fly](https://www.npmjs.com/package/fly)!
Fly's original author, [Jorge Bucaran](https://github.com/JorgeBucaran), has shifted focus to other exciting projects. Before leaving, he chose to guarantee Fly's future by transferring the project to [Luke Edwards](https://github.com/lukeed), who was one of the first and most enthused contributors.
To reflect this milestone, Fly has been renamed to Taskr and has a stable, exciting future ahead! :tada:
For existing Fly users, `[email protected]` is equivalent to `[email protected]` -- with a few exceptions:
1. The `flyfile.js` has been renamed to `taskfile.js`;
2. The `fly` key inside `package.json` has been renamed to `taskr`. (See [Local Plugins](#https://github.com/lukeed/taskr/tree/master/packages/taskr#local-plugins))
At this point, the Fly & [Taskr ecosystems](#packages) are fully interchangeable, which means that you can install `taskr` and use any `fly-*` or `taskr-*` plugins of your choosing. That said, most plugins have _already_ been ported over to the new namespace!
Lastly, Taskr will maintain a list of [official plugins](#official-packages). Don't forget to check 'em out!
## Core Features
- **lightweight:** with `6` dependencies, installation takes seconds
- **minimal API:** Taskr only exposes a couple methods, but they're everything you'll ever need
- **performant:** because of [Bluebird](https://github.com/petkaantonov/bluebird/), creating and running Tasks are quick and inexpensive
- **cascadable:** sequential Task chains can cascade their return values, becoming the next Task's argument
- **asynchronous:** concurrent Task chains run without side effects & can be `yield`ed consistently
- **composable:** chain APIs and Tasks directly; say goodbye to `pipe()` x 100!
- **modular:** easily share or export individual Tasks or Plugins for later use
- **stable:** requires Node `>= 4.6` to run (LTS is `6.11`)
## Docs
The main documentation can be found in [`taskr`](/packages/taskr), our core package.
Each `@taskr/*` or `taskr-*` plugin will also include its own documentation, too!
## Packages
The Taskr repo is managed as a monorepo that is composed of its many _official_ packages.
> **Important:** The core package is `taskr` and must be installed before using any additional plugins.
### Official Packages
These npm packages are officially released and maintained by the Taskr team.
If you can't find what you need, be sure to check out the [community list](#community-plugins) or browse for all [taskr-related plugins on `npmjs.com`](https://www.npmjs.com/browse/keyword/taskr-plugin), too!
If you're still missing something, open a ticket so that the team & community can try to help you... or create & share your own Taskr plugin! We have an awesome [Yeoman generator](https://github.com/lukeed/generator-taskr) to help speed up the process.
| Package | Version | Dependencies | Description |
|--------|-------|------------|-----------|
| [`taskr`](/packages/taskr) | [](https://www.npmjs.com/package/taskr) | [](https://david-dm.org/lukeed/taskr?path=packages/taskr) | Core package. _Required_ |
| [`@taskr/babel`](/packages/babel) | [](https://www.npmjs.com/package/@taskr/babel) | [](https://david-dm.org/lukeed/taskr?path=packages/babel) | Babel plugin for Taskr |
| [`@taskr/browserify`](/packages/browserify) | [](https://www.npmjs.com/package/@taskr/browserify) | [](https://david-dm.org/lukeed/taskr?path=packages/browserify) | Browserify plugin for Taskr |
| [`@taskr/buble`](/packages/buble) | [](https://www.npmjs.com/package/@taskr/buble) | [](https://david-dm.org/lukeed/taskr?path=packages/buble) | Bublé plugin for Taskr |
| [`@taskr/clear`](/packages/clear) | [](https://www.npmjs.com/package/@taskr/clear) | [](https://david-dm.org/lukeed/taskr?path=packages/clear) | Remove one or more directories |
| [`@taskr/coffee`](/packages/coffee) | [](https://www.npmjs.com/package/@taskr/coffee) | [](https://david-dm.org/lukeed/taskr?path=packages/coffee) | CoffeeScript plugin for Taskr |
| [`@taskr/concat`](/packages/concat) | [](https://www.npmjs.com/package/@taskr/concat) | [](https://david-dm.org/lukeed/taskr?path=packages/concat) | Concatenate files with optional source maps. |
| [`@taskr/esnext`](/packages/esnext) | [](https://www.npmjs.com/package/@taskr/esnext) | [](https://david-dm.org/lukeed/taskr?path=packages/esnext) | Allows `async`/`await` syntax within `taskfile.js` |
| [`@taskr/flatten`](/packages/flatten) | [](https://www.npmjs.com/package/@taskr/flatten) | [](https://david-dm.org/lukeed/taskr?path=packages/flatten) | Flatten source files to a max of sub-dirs. |
| [`@taskr/gzip`](/packages/gzip) | [](https://www.npmjs.com/package/@taskr/gzip) | [](https://david-dm.org/lukeed/taskr?path=packages/gzip) | Gzip plugin for Taskr |
| [`@taskr/htmlmin`](/packages/htmlmin) | [](https://www.npmjs.com/package/@taskr/htmlmin) | [](https://david-dm.org/lukeed/taskr?path=packages/htmlmin) | Minify HTML with Taskr |
| [`@taskr/jest`](/packages/jest) | [](https://www.npmjs.com/package/@taskr/jest) | [](https://david-dm.org/lukeed/taskr?path=packages/jest) | Jest plugin for Taskr |
| [`@taskr/less`](/packages/less) | [](https://www.npmjs.com/package/@taskr/less) | [](https://david-dm.org/lukeed/taskr?path=packages/less) | Compile LESS to CSS with Taskr |
| [`@taskr/postcss`](/packages/postcss) | [](https://www.npmjs.com/package/@taskr/postcss) | [](https://david-dm.org/lukeed/taskr?path=packages/postcss) | PostCSS plugin for Taskr |
| [`@taskr/prettier`](/packages/prettier) | [](https://www.npmjs.com/package/@taskr/prettier) | [](https://david-dm.org/lukeed/taskr?path=packages/prettier) | Prettier plugin for Taskr |
| [`@taskr/rev`](/packages/rev) | [](https://www.npmjs.com/package/@taskr/rev) | [](https://david-dm.org/lukeed/taskr?path=packages/rev) | Version/Hash assets for cache-busting |
| [`@taskr/sass`](/packages/sass) | [](https://www.npmjs.com/package/@taskr/sass) | [](https://david-dm.org/lukeed/taskr?path=packages/sass) | Compile SASS to CSS with Taskr |
| [`@taskr/shell`](/packages/shell) | [](https://www.npmjs.com/package/@taskr/shell) | [](https://david-dm.org/lukeed/taskr?path=packages/shell) | Execute shell commands with Taskr |
| [`@taskr/stylus`](/packages/stylus) | [](https://www.npmjs.com/package/@taskr/stylus) | [](https://david-dm.org/lukeed/taskr?path=packages/stylus) | Compile Stylus to CSS with Taskr |
| [`@taskr/typescript`](/packages/typescript) | [](https://www.npmjs.com/package/@taskr/typescript) | [](https://david-dm.org/lukeed/taskr?path=packages/typescript) | Compile Typescript with Taskr |
| [`@taskr/uglify`](/packages/uglify) | [](https://www.npmjs.com/package/@taskr/uglify) | [](https://david-dm.org/lukeed/taskr?path=packages/uglify) | UglifyJS plugin for Taskr |
| [`@taskr/unflow`](/packages/unflow) | [](https://www.npmjs.com/package/@taskr/unflow) | [](https://david-dm.org/lukeed/taskr?path=packages/unflow) | Remove Flow type annotations with Taskr |
| [`@taskr/watch`](/packages/watch) | [](https://www.npmjs.com/package/@taskr/watch) | [](https://david-dm.org/lukeed/taskr?path=packages/watch) | Watch files & Execute specified tasks on change |
| [`@taskr/zip`](/packages/zip) | [](https://www.npmjs.com/package/@taskr/zip) | [](https://david-dm.org/lukeed/taskr?path=packages/zip) | ZIP compress files with Taskr |
| [`generator-taskr`](https://github.com/lukeed/generator-taskr) | [](https://www.npmjs.com/package/generator-taskr) | [](https://david-dm.org/lukeed/generator-taskr) | Official Yeoman generator |
### Community Plugins
| Package | Version | Dependencies | Description |
|--------|-------|------------|--------------|
| [`taskr-autoprefixer`](https://github.com/lukeed/taskr-autoprefixer) | [](https://www.npmjs.com/package/taskr-autoprefixer) | [](https://david-dm.org/lukeed/taskr-autoprefixer) | CSS Autoprefixer plugin for Taskr |
| [`taskr-nunjucks`](https://github.com/lukeed/taskr-nunjucks) | [](https://www.npmjs.com/package/taskr-nunjucks) | [](https://david-dm.org/lukeed/taskr-nunjucks) | Render Nunjucks templates with Taskr |
| [`taskr-precache`](https://github.com/lukeed/taskr-precache) | [](https://www.npmjs.com/package/taskr-precache) | [](https://david-dm.org/lukeed/taskr-precache) | Cache assets for offline use via service worker |
| [`taskr-svelte`](https://github.com/lukeed/taskr-svelte) | [](https://www.npmjs.com/package/taskr-svelte) | [](https://david-dm.org/lukeed/taskr-svelte) | Compile Svelte components with Taskr
| [`taskr-xo`](https://github.com/lukeed/taskr-xo) | [](https://www.npmjs.com/package/taskr-xo) | [](https://david-dm.org/lukeed/taskr-xo) | XO plugin for Taskr
| [`taskr-standard`](https://github.com/elmasse/taskr-standard) | [](https://www.npmjs.com/package/taskr-standard) | [](https://david-dm.org/elmasse/taskr-standard) | Standard plugin for Taskr
| [`template-taskr`](https://github.com/adamkiss/template-taskr) | [](https://www.npmjs.com/package/template-taskr) | [](https://david-dm.org/adamkiss/template-taskr) | Unofficial SAO generator
## License
MIT © [Luke Edwards](https://lukeed.com) and [Jorge Bucaran](https://github.com/JorgeBucaran)