![](\"https://cloud.githubusercontent.com/assets/6306796/26037402/2d80aa16-38f2-11e7-8bba-72e956921eb2.png\")
\r\n \r\n \r\n
npm scripts on steroids!
\r\n\r\n\r\n[](https://badge.fury.io/js/makfy)\r\n\r\nInstall it globally\r\n\r\n`npm install -g makfy` / `yarn global add makfy`\r\n\r\nor locally\r\n\r\n`npm install --save-dev makfy` / `yarn add --dev makfy`\r\n\r\n**To support this project star it on [github](https://github.com/xaviergonz/makfy)!**\r\n\r\n## What is makfy?\r\n\r\nmakfy is an evolution of npm-scripts to help you automate time-consuming tasks in your development workflow.\r\n\r\n## Why makfy?\r\n\r\nBuild systems should be simple, and that's why we guess npm scripts are gaining traction lately. \r\nmakfy tries to follow that KISS philosophy while adapting gracefully to complex build requirements.\r\n\r\n#### What does it inherit from npm scripts?\r\n\r\n- It is still **shell-based** in its core.\r\n\r\n- The gazillion CLI tools available in npm (_browserify, rimraf, webpack..._) are still available for you to use. \r\n In other words, if there's a CLI version of it available nothing else is needed to use it with makfy.\r\n\r\n#### What does it add?\r\n\r\n- **Javascript/Typescript powered** \r\n `makfyfile.(js|ts)` is a javascript/typescript file, so you can use it to decide how the shell commands should run or when.\r\n\r\n- **Easy argument definition** \r\n It is easy to create command line arguments for each command, plus validation is made automatically.\r\n\r\n- **Command line help auto-generation** \r\n So you don't have to dig into config files to know what each command does.\r\n\r\n- **Concurrency made easy** \r\n Thanks to async/await plus some nifty tricks (and concurrent logs look good!).\r\n\r\n- **Utils included, such as a smart cache!** \r\n For example it includes a file checker so shell commands are not run twice if not needed, or only run on the files that changed.\r\n\r\n- **Strong validation of `makfyfile.js` files** \r\n You should not be left wondering if you mistyped something.\r\n\r\n- **Colorized detailed logs** \r\n So it is easy to spot where your build is currently at and/or where it failed.\r\n\r\n## Sample `makfyfile.(js|ts)` files\r\n\r\nA simple example (run with `makfy clean`).\r\n\r\n**Note:** To use the async/await syntax you must install **node 7.6+** or use a typescript file; if you can't then you can either use promises (though the syntax won't be as nice) or babelize compile the `makfyfile.js` file before.\r\n\r\n```ts\r\nimport { cmd } from \"makfy\";\r\n// or\r\nconst { cmd } = require(\"makfy\");\r\n\r\ncmd(\"clean\").run(async (exec) => {\r\n await exec(\r\n // running sequentially\r\n \"rimraf ./dist-a\",\r\n \"rimraf ./dist-b\",\r\n // and these run after the other ones too, but in parallel!\r\n [\"rimraf ./dist-c\", \"rimraf ./dist-d\"]\r\n );\r\n});\r\n```\r\n\r\nAnother one but with arguments and help (run with `makfy clean --dev`, `makfy clean --prod` or `makfy clean --dev --prod`).\r\n\r\n```ts\r\nimport { cmd, flag } from \"makfy\";\r\n// or\r\nconst { cmd } = require(\"makfy\");\r\n\r\ncmd(\"clean\")\r\n .desc(\"clean the project\")\r\n .args({\r\n prod: flag(),\r\n dev: flag()\r\n })\r\n .argsDesc({\r\n prod: \"production clean\",\r\n dev: \"dev clean\"\r\n })\r\n .run(async (exec, { prod, dev }) => {\r\n await exec(prod ? \"rimraf ./dist-prod\" : null, dev ? \"rimraf ./dist-dev\" : null);\r\n });\r\n```\r\n\r\nThe help we will get when running `makfy --list` or `makfy`.\r\n\r\n```\r\nusing command file 'makfyfile.js'...\r\nlisting all commands...\r\n\r\nclean [--dev] [--prod]\r\n - clean the project\r\n [--dev] dev clean (default: false)\r\n [--prod] production clean (default: false)\r\n```\r\n\r\nRunning commands inside commands (`makfy build`).\r\n\r\n```ts\r\nimport { cmd } from \"makfy\";\r\n// or\r\nconst { cmd } = require(\"makfy\");\r\n\r\ncmd(\"build\")\r\n .run(async (exec) => {\r\n await exec(\r\n \"@clean\",\r\n { _: \"clean\" }, // same as above\r\n ... // whatever commands go next\r\n );\r\n });\r\n\r\n// shorter version\r\ncmd(\"build\")\r\n .run(\r\n \"@clean\",\r\n { _: 'clean' }, // same as above\r\n ... // whatever commands go next\r\n );\r\n\r\ncmd(\"clean\")...\r\n```\r\n\r\nRunning commands inside commands and sending them arguments.\r\n\r\n```ts\r\nimport { cmd } from \"makfy\";\r\n// or\r\nconst { cmd } = require(\"makfy\");\r\n\r\ncmd(\"build\")\r\n .run(async (exec) => {\r\n await exec(\r\n \"@clean --dev --prod\",\r\n { _: \"clean\", args: { dev: true, prod: true }}, // same as above\r\n ... // whatever commands go next\r\n );\r\n });\r\n\r\n// shorter version\r\ncmd(\"build\")\r\n .run(\r\n \"@clean --dev --prod\",\r\n { _: \"clean\", args: { dev: true, prod: true }}, // same as above\r\n ... // whatever commands go next\r\n );\r\n\r\ncmd(\"clean\")...\r\n```\r\n\r\n_Pro-tip!_ \r\nRunning the typescript compiler, but only if the sources did not change - this reduces build times tremendously!\r\n\r\n```ts\r\nimport { cmd, getFileChanges } from \"makfy\";\r\n// or\r\nconst { cmd, getFileChanges } = require(\"makfy\");\r\n\r\ncmd(\"compile\").run(async (exec) => {\r\n const delta = await getFileChanges(\"typescript\", [\"./src/**/*.ts\", \"./src/**/*.tsx\"]);\r\n\r\n if (delta.hasChanges) {\r\n await exec(\r\n // here you would remove all target files generated by this step\r\n // then compile new target files\r\n \"tsc -p .\"\r\n // additionally you could even only run the compiler over delta.added + delta.modified files\r\n );\r\n }\r\n});\r\n```\r\n\r\n### `cmd` short syntax\r\n\r\nIf your command doesn't need any to access any arguments then you can use the `cmd(\"commandName\").run(...commands)` function to make it shorter to write:\r\n\r\n```ts\r\nimport { cmd } from \"makfy\";\r\n// or\r\nconst { cmd } = require(\"makfy\");\r\n\r\ncmd(\"clean\").desc(\"cleans stuff\").run(\r\n // running sequentially\r\n \"rimraf ./dist-a\",\r\n \"rimraf ./dist-b\",\r\n // and these run after the other ones too, but in parallel!\r\n [\"rimraf ./dist-c\", \"rimraf ./dist-d\"]\r\n);\r\n```\r\n\r\nIf you want to make it even shorter you might use template literals:\r\n\r\n```ts\r\nimport { cmd } from \"makfy\";\r\n// or\r\nconst { cmd } = require(\"makfy\");\r\n\r\ncmd(\"clean\").desc(\"cleans stuff\").run(`\r\n // commands starting with '//' will be ignored\r\n rimraf ./dist-a\r\n rimraf ./dist-b\r\n`);\r\n```\r\n\r\n## Documentation\r\n\r\nThe basic structure of a `makfyfile.(js|ts)` is as follows:\r\n\r\n```ts\r\nimport { cmd, setDependencies, setOptions, flag, choice, str } from \"makfy\";\r\n// or\r\nconst { cmd, setDepenencies, setOptions, flag, choice, str } = require(\"makfy\");\r\n\r\ncmd(\"commandName\")\r\n .desc?(\"command description\")\r\n .args?({\r\n [argName]:\r\n | flag()\r\n | choice([\"option1\", \"option2\", \"default\"?])\r\n | str(\"default\"?)\r\n })\r\n .argsDesc?({\r\n [argName]: \"arg description\"\r\n })\r\n // one of these two\r\n .run(async (exec, args) => {...})\r\n .run(\"cmd1\", \"cmd2\", ...)\r\n\r\n// optionally...\r\nsetDependencies(string[] | undefined);\r\nsetOptions(Options);\r\n```\r\n\r\nIn more detail:\r\n\r\n#### `cmd(commandName)`\r\n\r\nAdds a command to the list of possible commands. If `commandName` starts with `_` then it will be\r\nconsidered an internal command that cannot be invoked/listed using the CLI, yet can be run by other\r\ncommands.\r\n\r\n- **`.run(async (exec, args) => Promise