README

🧑‍🍳 hygen-cook

A composition tool for hygen templates. Allows you to compose and generate complex services from many small modular hygen generators.

Introduction

Hygen is great for templating out small bits of boilerplate for specific use cases, but less than ideal for large complex projects with multiple different options. Hygen Cook aims to solve that issue by allowing you to define a recipe for that large complex project by combining multiple small generators in a specific shape and order.

Recipes

A recipe is composed of two main sections, ingredients and instructions. Ingredients specifies which generators will be used in the recipe, either by git url or npm package name. Instructions specifies the calls to those generators and the arguments they require. When you have a recipe file and want to cook the recipe, simply call hygen-cook and pass it the recipe, pretty soon you'll have a freshly baked project to start working on.

Usage

Install

To get the hygen-cook command available in your terminal you'll need to install the module globally:

npm i -g hygen-cook

Create a Recipe

name: My API
ingredients:
  - https://github.com/hygen-generators/scaffolder-demo-hygen
  - https://github.com/hygen-generators/github-actions-generator
instructions:
  - package: monorepo
    generator: new
    args:
      - option: name
        value: simple-service
  - package: monorepo-package
    generator: new
    args:
      - option: name
        value: api
  - package: monorepo-package
    generator: lambda
    args:
      - option: name
        value: api-lambda
      - option: component
        value: api
  - package: monorepo-package
    generator: new
    args:
      - option: name
        value: ingest
  - package: monorepo-package
    generator: lambda
    args:
      - option: name
        value: ingest-lambda
      - option: component
        value: ingest
  - package: github-actions
    generator: build-test-publish 
    args:
      - option: admin-github-token
        value: SUPER_SECRET_TOKEN
      - option: main-branch
        value: main
      - option: node-version
        value: '14.11'
      - option: use-commit-lint
      - option: use-lerna
  - package: github-actions
    generator: dependabot
    args:
      - option: admin-github-token
        value: SUPER_SECRET_TOKEN
      - option: main-branch
        value: main
      - option: node-version
        value: '14.11'
  - package: github-actions
    generator: terraform-deploy
    args:
      - option: admin-github-token
        value: SUPER_SECRET_TOKEN
      - option: main-branch
        value: main

Time to cook

hygen-cook -r path/to/my-api-recipe.yml -m npm

CLI Ref

hygen-cook --help
Options:
      --version         Show version number                            [boolean]
  -r, --recipe          The recipe to cook up                [string] [required]
  -m, --packageManager  The package manager to use when installing generator
                        packages
                   [string] [required] [choices: "npm", "yarn"] [default: "npm"]
      --help            Show help                                      [boolean]

Usage no npm install needed!