Generator-fish NPM

generator-fish

AKFish's generator

Installation

First, install Yeoman and generator-fish using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-fish

Then generate your new project:

yo fish

Usage

In your project folder, run:

yo fish

Then follow the instructions.

Select tasks via CLI argument:

yo fish --coffee --mocha

Or run in standalone mode:

yo fish:coffee

Supported gulp tasks:

coffee
mocha
es6(babel)
browserify
watch
clean
copy

(Optional) You can override configurations with CLI arguments passed to gulp command.

Run:

yo fish:cli

To configure CLI mapping.

Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced. Feel free to learn more about him.

Development

Add New Task

Run the internal `fish:fish` generator in `generator-fish` project folder:

yo fish:fish

Modify the generated `generators/#new#/index.js`

'use strict';
var yeoman = require('yeoman-generator');
var chalk = require('chalk');
var Fish = require('../../lib/base');

module.exports = Fish.buildTask('coffee', ['gulp-coffee'],
  {
    defaultSrc: "./coffee/**/*.coffee",
    defaultDst: "./lib",
    ignoreSrc: false, // toggle `src` question
    ignoreDst: false, // toggle `dst` question
    supportSourceMap: true, // toggle `sourceMap` question
    questions: [
      {
        type: 'confirm',
        name: 'bare',
        message: '--bare',
        default: true
      },
    ]
  },
  {
    // TODO: custom prototype methods
  });

When running, the prompts will generate props in its 'flatten' form:

{
  src: '',
  dst: '',
  // other fields
}

When stored to gulpconfig.json under the task's namespace, fields other than generic and private ones will be moved to opts field.

{
  src: '',
  dst: '',
  // other fields
  opts: {
    // other fields
  }
}

The opts field will be used as gulp plugin options.

Notes:

Generic questions will be asked before custom questions:
- taskName
- src, toggled by ignoreSrc
- dst, toggled by ignoreDst
- sourceMap, toggled by supportSourceMap
Questions with _ as prefix in their names are private.
Special custom prototype methods:
- _doPrompt - called right after this.props is set but before it's stored to gulpconfig
- _doWriting - called after gulpfile.coffee, gulpconfig.json and task templates are written
- _doInstall - called after fish:app and task's dependencies are installed

Modify the generated `generators/#new#/templates/task.coffee`

A typical task.coffee should be like this:

# require dependencies
module.exports = (profile = 'default') ->
  cfg = config["name:#{profile}"]

  # gulp.task

It's a template file with this.props as its parameters
It should expose a function that takes profile name as the only option
Following objects are exposed to global in gulpfile.coffee:
- gulp
- heap - gulp-heap
- config - all configurations
Task specific configurations are stored in config[name:profile]