0.3.0 • Published 11 days ago

gh-gen v0.3.0

Weekly downloads
-
License
MIT
Repository
github
Last release
11 days ago

gh-gen

gh-gen is part of the reaxi project, you can use alternatively reaxi gen <...options>

generate apps from any github repository

like starters, templates and more

gh-gen is designed to be the universal create-app, it can be programmatically enhanced

for project authors who want an create-my-app approach

all you need is one js script config file, it just works ! no need to create your manager from scratch

even if you just to clone projects it's faster than git clone

Features:

  • User preferred installation manager (yarn, npm, pnpm)
  • yarn berry support, -2 or --berry
  • templates/ or examples/ (any folder path) support

    examples: templates/hello -- examples/with-redux -- packages/core-client

  • Create from any branch support
  • Aliases: users can save any aliases commonly used

Usage

gh-gen user/repo
gh-gen user/repo [templates/hello]

like templates/ or examples/ (any folder path)

gh-gen user/repo -n name -b branch

use specific branch

aliases

  • aliases: pick user/repo and branch

default aliases:

  • npr: Andrew-Colman/node-package-rollup
  • next: Andrew-Colman/next.ts

options

argument: '[repo]',
"the repository to generate, please use this signature: 'user/repo' or an known alias"


option: '-p, --path <path>' // path

option: '-b, --branch <name> ', // 'repository branch'

option: '-n, --name <name>', // 'project name (as in package.json)'

option: '-v, --version <version>', // 'project version (as in package.json)'

option: '-a, --author <author>', // 'project author (as in package.json)'

option: '-p, --path <path>', // 'project path'

option: '-2, --berry [ide]', // 'start a yarn/berry project' // ide: vscode (will install vscode sdk for berry)

option: '--aliases', // 'list all aliases from gh-gen-alises.json' //standalone option

option: '-d, --debug', // 'enable debug mode'

Using it as a create-app for your project

creating an gh-gen.config.js file at the root of your repository

you can enhance the generation of features with:

  • executing commands
  • creating new files on demand
  • modifying files
  • deleting files