clow

The project generator🔯

Install

$ npm install -g clow

Quick start

Once clow installed, you can use clow command.

Then, let's try $ clow github:airtoxin/clow-template-babel my-first-project. This command ask some settings, so answer it and wait a few minutes. When command finished, you got babel project template on my-first-project directory. Run npm run watch, npm test ... in created project directory. It works! wow!

Documents

CLI

clow takes 2 or more arguments: list of and . Simple!

The last argument is path of project destination. The other arguments are path or url (or github shorthand) of project template source. (eg. ~/my-clow-templates/babel, https://github.com/airtoxin/clow/archive/master.zip, github:airtoxin/clow-template-babel) Template url only support compressed file url.

Template project structure

Template project must contain clow.js file at root.

my-template
    └── clow.js

clow file (clow.js)

see examples

The clow file must export array of task definitions. (module.exports = [...];)

Task definition is object that contains type field. type field defines 'which task uses this'. Other fields are relied to task.

Bundled tasks

template

Compile template files of Hogan.js and put them to dest.

{ type: 'template', src: { cwd: 'templates', pattern: '**/*' }, dest: '.', args: {} }

• src.cwd: relative path of source directory from root of project template directory. If above example's task runs in pathtotemplate/babel-gen, files matches pathtotemplate/babel-gen/templates/**/* ware processed. If got url source, project template directory was set to temporary directory.
• src.pattern: glob pattern of input files.
• dest: relative path of destination directory of compiled files.
• args: Hogan.js variable mapping object. If value is null, clow ask you 'what is this value?' at runtime.
• delimiters: Hogan.js delimiters option. (optional)

shell

Runs shell command.

{ type: "shell", commands: ["pwd", "ls -la"] }

• commands: shell command list.

clow-template

Runs other clow task.

{ type: 'clow-template', templates: ['path/to/my-templates', `https://url.to.my-template.s`] }

• templates: file or url of project template sources.

npm-install

Install npm's package.

{ type: 'npm-install': dependencies: ['babel-polyfill'], devDependencies: ['babel-cli', 'babel-preset-es2015'] }

License

MIT