An interesting project: Markdown driven task runner

Notes

  1. I would like to publish the project maid ā€¦ I found this project very interesting maid
  2. What is a maidfile?
    A maidfile is where you define tasks, in Markdown!
  3. Have you guys heard about the maid project?
Source-code maidfile.md:

## lint

It uses ESLint to ensure code quality.

```bash
eslint --fix

## build

Build our main app

<!-- Following line is a maid command for running task -->

Run task `build:demo` after this

```bash
# note that you can directly call binaries inside node_modules/.bin
# just like how `npm scripts` works
babel src -d lib

build:demo

You can use JavaScript to write to task script too!

const webpack = require('webpack')

// Async task should return a Promise
module.exports = () =>
  new Promise((resolve, reject) => {
    const compiler = webpack(require('./webpack.config'))
    compiler.run((err, stats) => {
      if (err) return reject(err)
      console.log(stats.toString('minimal'))
      resolve()
    })
  })

Goals

  1. I would like to share here this amazing project that uses Markdown
  2. Iā€™m not being paid, I just found the project proposal interesting
  3. Could this be an extension of Commonmark?
1 Like