Centimaitre is a small task runner with a dependencies system which works a bit like gulp@3.
First to install:
npm i -D centimaitreCentimaitre doesn't work when installed globally, I recommend installing it locally, and using npx (installed by default with npm):
npm i -D centimaitre
npx cm [cmOptions] <...tasks-to-run> [taskOptions]The CLI is used as such: npx cm [cmOptions] <...tasks-to-run> [taskOptions]
Both cmOptions and taskOptions are parsed with yargs. You should take note of its syntax. For example, if you want to set a given option myOption to false, you should pass --no-myOption on the CLI.
By default, centimaitre will use the cmfile.js found in the directory from which it is called. If you want to override that, you can pass --cmfile=relative/path/to/custom/centimaitre/config/file.
Pass --quiet if you want no logs from centimaitre besides errors, or --verbose if you want extra logs. If you try being funny and pass both, you'll just get the normal logs.
This function assigns given options as default task options.
Params:
- @param {Object} options
Tasks can be defined in any order, their dependencies are resolved at runtime.
This function ensures that the task hasn't been defined multiple times and stores the task into the tasks object. Both dependencies and callback are optional, but at least one of them must be provided, so it can be:
- taskName, callback
- taskName, dependencies
- taskName, dependencies, callback
The task callback is called with the taskOptions object as argument.
Params:
- @param {string} taskName
- @param {Array} [dependencies]
- @param {function(options: Object):Promise|{pipe: function}|void} [callback] when given, is a function that is synchronous, or that returns a Promise, or that returns a Stream. The task is considered finished when the returned Promise is resolved, when the returned Stream has finished or when the synchronous execution has ended.
Here is an example of a basic cmfile.js
const cm = require('centimaitre')
cm.setDefaultOptions({
sourceMaps: true
})
cm.task('clean', () => {
console.log('cleaning')
})
cm.task('task1', ['clean'], () => {
return new Promise(resolve => {
setTimeout(() => resolve(console.log('task1')), 50)
})
})
cm.task('task2', ['clean'], () => {
return new Promise(resolve => {
setTimeout(() => resolve(console.log('task2')), 100)
})
})
cm.task('build', ['task1', 'task2'], (options) => {
if (options.sourceMaps) console.log('build with sourceMaps')
else console.log('build without sourceMaps')
})And then, you can execute the build task with the relevant options (parsed with yargs):
npx cm build --no-sourceMapsThis will execute clean, then task1 & task2, then finally build with options.sourceMaps set to false.
You can find detailed examples of how to use centimaitre with rollup, babel, and node-sass in the examples directory of this repo.
I used to use gulp, and found its dependencies system very convenient. BUT when node@10 was released, two things happened:
- gulp@3 doesn't work on node@10 anymore, it seems the preferred workaround is to switch to yarn, which I most definitely don't want to do.
- gulp@4 lost this dependencies system I thought was convenient (I had to rewrite like 1000 lines of gulpfile) AND gulp@4 doesn't work in gitlab-runner with node@10 (nodejs/node#20498).
With that in mind, I decided to find another task runner, but all of them are overkill. I only wanted something to define tasks, resolve dependencies, and a CLI, so I wrote my own, with blackjack, and hookers. Feel free to use it if you want.
TL;DR: I'm French, I always do bad puns and this is one.
A 'maître' in French is a 'master', 'ruler', 'teacher'. Since a task runner kinda rules the tasks, it almost makes sense to call it that way. I said almost.
A 'centimetre' is 1/100 of a meter, it is small.
This project is all about making a small task runner: 'centimaître'.
<bad-pun> Oh and with this name, you can switch to the maitric system. </bad-pun>