open-index/open-npm huggingface dataset:
npm package: @stephanbit/flow
Description: A generator using gulp task runner. Speed up your development with templates. This Version is a little bit refactored and full in ES6 written.
Author: Stephan Bitomsky
Latest version: 2.0.0
Deprecated: this package has benn deprecated use eze-cli

# FLOW v2.0.0 #

A generator using gulp task runner. Speed up your development with templates. This Version is a little bit refactored and full in ES6 written.

## How do I get set up? ###

Install `flow` globally with:

```bash
npm install @stephanbit/flow -g
```

## Usage

```bash
flow <generator>[:<task>] [<args>]
```

* `<tasks>`: a colon (":") separated list of a task or tasks to run. If not provided the `default` task in the flow file is run
* `<args>`: any other given arguments (not prefixed with "--" or "-") can be accessed via the `gulp.args` property from within a flow file

**Example:**

```bash
flow cfw:module myModule
```

Which will run task `module` in generator `flow-cfw` and `gulp.args` will be set to `["myModule"]`.

### List available generators

If run without any arguments, flow will list all installed generators.

```bash
flow
```

### List available tasks in generator

To list available tasks within a generator, use the generator name in conjunction with the `--tasks` parameter.

```bash
flow <generator> --tasks
```

### Print version(s)

As usual you can use `-v` or `--version` to get the current flow version:

```bash
flow -v
```

It can also be used together with a generator name:

```bash
flow <generator> -v
```

You'll then get the version for flow, the gulp version installed in the generator and the version number of the given generator.

## Creating a generator

A Flow generator is an npm package following the naming convention `flow-*` and containing a `flow.js` file.

Add `flowgenerator` as a keyword in your `package.json`.

As when building gulp plugins all flow generators need to have `gulp` installed as a local dependency.

All `flow-*` packages should be installed globally (for now) to be found by the flow executable.

**Note** remember to add gulp plugins (and gulp itself) as ordinary dependencies, instead of devDependencies, when building a flow generator.