Giter Club home page Giter Club logo

clow's Introduction

clow Build Status

The project generator🔯

clow logo

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

clow's People

Contributors

airtoxin avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.