A fast, concurrency-focused task automation tool.
2hu12 and lukeed README: fix broken link (#302)
Replace the invalid `Fly` github link with npm link.
Latest commit 82d0bef Dec 8, 2017

readme.md

Taskr

Taskr

A fast, concurrency-focused task runner.
Fasten your seatbelt. 🚀

Taskr is a highly performant task runner, much like Gulp or Grunt, but written with concurrency in mind. With Taskr, everything is a coroutine, 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 that's easy to read.

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}https://github.com/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!

Fly's original author, Jorge Bucaran, has shifted focus to other exciting projects. Before leaving, he chose to guarantee Fly's future by transferring the project to Luke Edwards, 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! 🎉

For existing Fly users, taskr@1.0.x is equivalent to fly@2.0.6 -- 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)

At this point, the Fly & Taskr ecosystems 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. 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, 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 yielded 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, 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 pacakge 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 or browse for all taskr-related plugins on npmjs.com, 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 to help speed up the process.

Package Version Dependencies Description
taskr npm Dependency Status Core package. Required
@taskr/babel npm Dependency Status Babel plugin for Taskr
@taskr/browserify npm Dependency Status Browserify plugin for Taskr
@taskr/buble npm Dependency Status Bublé plugin for Taskr
@taskr/clear npm Dependency Status Remove one or more directories
@taskr/coffee npm Dependency Status CoffeeScript plugin for Taskr
@taskr/concat npm Dependency Status Concatenate files with optional source maps.
@taskr/esnext npm Dependency Status Allows async/await syntax within taskfile.js
@taskr/flatten npm Dependency Status Flatten source files to a max of sub-dirs.
@taskr/gzip npm Dependency Status Gzip plugin for Taskr
@taskr/htmlmin npm Dependency Status Minify HTML with Taskr
@taskr/jest npm Dependency Status Jest plugin for Taskr
@taskr/less npm Dependency Status Compile LESS to CSS with Taskr
@taskr/postcss npm Dependency Status PostCSS plugin for Taskr
@taskr/prettier npm Dependency Status Prettier plugin for Taskr
@taskr/rev npm Dependency Status Version/Hash assets for cache-busting
@taskr/sass npm Dependency Status Compile SASS to CSS with Taskr
@taskr/shell npm Dependency Status Execute shell commands with Taskr
@taskr/stylus npm Dependency Status Compile Stylus to CSS with Taskr
@taskr/typescript npm Dependency Status Compile Typescript with Taskr
@taskr/uglify npm Dependency Status UglifyJS plugin for Taskr
@taskr/unflow npm Dependency Status Remove Flow type annotations with Taskr
@taskr/watch npm Dependency Status Watch files & Execute specified tasks on change
@taskr/zip npm Dependency Status ZIP compress files with Taskr
generator-taskr npm Dependency Status Official Yeoman generator

Community Plugins

Package Version Dependencies Description
taskr-autoprefixer npm Dependency Status CSS Autoprefixer plugin for Taskr
taskr-nunjucks npm Dependency Status Render Nunjucks templates with Taskr
taskr-precache npm Dependency Status Cache assets for offline use via service worker
taskr-svelte npm Dependency Status Compile Svelte components with Taskr
taskr-xo npm Dependency Status XO plugin for Taskr
taskr-standard npm Dependency Status Standard plugin for Taskr
template-taskr npm Dependency Status Unofficial SAO generator

License

MIT © Luke Edwards and Jorge Bucaran