README.md

Don — A YAML and Make inspired build tool

Example Don:

assets:
  - rollup
  - node-sass -r
    src/css 
    --output assets/css

# This comment about lint
lint:
  - eslint

done:
  - echo "Finished"

all:
  - $lint
  - $assets $done

Some things to keep in mind:

• A target's command must be indented with at least 2 spaces
• A multi-line command's following lines must be indented at least 2 spaces after the indentation of the command's first line (as seen by assets second command)
• You can't have circular target dependencies
• You can't reference undefined targets as dependencies
• You can't mix dependencies and normal commands on a line

CLI Usage

node don.js file

API Usage

const { parse } = require("@b-fuze/don")
const targets = parse(`
assets:
  - rollup
  - node-sass -r
    src/css 
    --output assets/css

# This comment about lint
lint:
  - eslint

done:
  - echo "Finished"

all:
  - $lint
  - $assets $done
`)

Example output

{
    "assets": [
        {
            "type": "command",
            "command": "rollup"
        },
        {
            "type": "command",
            "command": "node-sass -r src/css  --output assets/css"
        }
    ],
    "lint": [
        {
            "type": "command",
            "command": "eslint"
        }
    ],
    "done": [
        {
            "type": "command",
            "command": "echo \"Finished\""
        }
    ],
    "all": [
        {
            "type": "dependency",
            "dependencies": [
                "lint"
            ]
        },
        {
            "type": "dependency",
            "dependencies": [
                "assets",
                "done"
            ]
        }
    ]
}

Development

Download dependencies to develop Don

npm i

Rebuild Don's parser with

npm run build