Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bbeesley/hygen-cook

A helpful chef to cook hygen recipes
https://github.com/bbeesley/hygen-cook

Last synced: 3 months ago
JSON representation

A helpful chef to cook hygen recipes

Awesome Lists containing this project

README 

        
[![test-and-publish](https://github.com/bbeesley/hygen-cook/actions/workflows/test-and-publish.yml/badge.svg)](https://github.com/bbeesley/hygen-cook/actions/workflows/test-and-publish.yml)



# 🧑‍🍳 hygen-cook



A composition tool for [hygen](https://www.hygen.io) 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.



## Contents



- [What is a Recipe?](#what-is-a-recipe)

- [Usage](#usage)

  - [Install](#install)

  - [Create a Recipe](#create-a-recipe)

  - [Time to cook](#time-to-cook)

  - [CLI Ref](#cli-ref)

- [Example Recipes](#example-recipes)

  - [A node module with github actions to build, test, and publish](#a-node-module-with-github-actions-to-build-test-and-publish)

  - [A monorepo for multiple packages with github actions to build, test, and publish](#a-monorepo-for-multiple-packages-with-github-actions-to-build-test-and-publish)



## What is a Recipe?



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:



```shell

npm i -g hygen-cook

```



### Create a Recipe



```yaml

name: My API

ingredients:

  - https://github.com/hygen-generators/scaffolder-demo-hygen

  - github-actions-generators

instructions:

  - ingredient: scaffolder-demo-hygen

    generator: monorepo

    action: new

    args:

      - option: name

        value: simple-service

  - ingredient: scaffolder-demo-hygen

    generator: monorepo-package

    action: new

    basePath: packages/api

    args:

      - option: name

        value: api

  - ingredient: scaffolder-demo-hygen

    generator: monorepo-package

    action: lambda

    basePath: packages/api

    args:

      - option: name

        value: api-lambda

      - option: component

        value: api

  - ingredient: scaffolder-demo-hygen

    generator: monorepo-package

    action: new

    basePath: packages/ingest

    args:

      - option: name

        value: ingest

  - ingredient: scaffolder-demo-hygen

    generator: monorepo-package

    action: lambda

    basePath: packages/ingest

    args:

      - option: name

        value: ingest-lambda

      - option: component

        value: ingest

  - ingredient: github-actions-generators

    generator: github-actions

    action: 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

  - ingredient: github-actions-generators

    generator: github-actions

    action: dependabot

    args:

      - option: admin-github-token

        value: SUPER_SECRET_TOKEN

      - option: main-branch

        value: main

      - option: node-version

        value: '14.11'

  - ingredient: github-actions-generators

    generator: github-actions

    action: terraform-deploy

    args:

      - option: admin-github-token

        value: SUPER_SECRET_TOKEN

      - option: main-branch

        value: main

```



### Time to cook



```shell

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

```



### CLI Ref



```shell

hygen-cook --help

Options:

      --version             Show version number                        [boolean]

  -r, --recipe              The recipe to cook up            [string] [required]

      --overwriteTemplates  Should overwrite templates?

                                                      [boolean] [default: false]

      --help                Show help                                  [boolean]



```



## Example Recipes



Some example recipes for you to try out using open source generators

### A node module with github actions to build, test, and publish



```yaml:examples/node-module-recipe.yml

name: a-shiny-new-module

node: &vNode '16.14.2'

ingredients:

  - &gha hygen-github-action-generators

  - &nodemod hygen-node-module-generators

instructions:

  - ingredient: *gha

    generator: gha-workflows

    action: new

    args:

      - option: name

        value: workflows

      - option: nodeVersion

        value: *vNode

  - ingredient: *nodemod

    generator: node-module

    action: new

    args:

      - option: name

        value: shiny-new-module

      - option: description

        value: A shiny new module to do awesome things

      - option: author

        value: You 

      - option: repoName

        value: https://github.com/bbeesley/awesome-generators

      - option: nodeVersion

        value: *vNode

      - option: supportNodeVersion

        value: '14.18.3'



```



### A monorepo for multiple packages with github actions to build, test, and publish



```yaml:examples/node-monorepo-recipe.yml

name: a-shiny-set-of-modules

node: &vNode '16.14.2'

repo: &repo 'https://github.com/bbeesley/awesome-generators'

ingredients:

  - &gha hygen-github-action-generators

  - &nodemod hygen-node-module-generators

instructions:

  - ingredient: *gha

    generator: gha-workflows

    action: new

    args:

      - option: name

        value: workflows

      - option: nodeVersion

        value: *vNode

  - ingredient: *nodemod

    generator: node-module

    action: new

    args:

      - option: name

        value: root

      - option: description

        value: Root package for lerna

      - option: author

        value: You 

      - option: repoName

        value: *repo

      - option: nodeVersion

        value: *vNode

      - option: supportNodeVersion

        value: '14.18.3'

      - option: isLernaRoot

        value: 'true'

  - ingredient: *nodemod

    generator: node-module

    action: new

    basePath: packages/a-monorepo-package

    args:

      - option: name

        value: a-monorepo-package

      - option: description

        value: One of the packages in my monorepo

      - option: author

        value: You 

      - option: repoName

        value: *repo

      - option: nodeVersion

        value: *vNode

      - option: supportNodeVersion

        value: '14.18.3'

      - option: isLernaChild

        value: 'true'

  - ingredient: *nodemod

    generator: node-module

    action: new

    basePath: packages/another-monorepo-package

    args:

      - option: name

        value: another-monorepo-package

      - option: description

        value: Another of the packages in my monorepo

      - option: author

        value: You 

      - option: repoName

        value: *repo

      - option: nodeVersion

        value: *vNode

      - option: supportNodeVersion

        value: '14.18.3'

      - option: isLernaChild

        value: 'true'



```