tukod v0.1.1

tukod

Yarn workspaces/monorepo mini cli helper tools

Installation

npm install -g tukod

or

yarn global add tukod

Usage

Usage
  $ tk <command> [options]

Commands
  generate  Generate a new app
  delete    Remove an app
  init      Create base files in the current directory

Options

  --help  Show help
  --version  Show version
  --no-confirm, Disable confirmation
  --dir, Change the current working directory 

generate
  --template, -t  Template to use
  --name, -n  Name of the app

delete
  --name, -n  Name of the app

init
  --name, -n Monorepo project name 

Examples
  $ tk generate --template=react-app --name=my-app
  $ tk init --name=monorepo-name

Making Templates

To add templates you must add templatesPaths in the tk field of your root package.json. templatesPaths field should contain all your templates directory (can be absolute or relative to monorepo directory).

Templates should have .tkignore so that it will be detected as a template. It should also have a package.json file.

// sample .tkignore

.turbo
dist
!node_modules/*
node_modules

Deleting Apps

To delete apps you need to create an empty .unlock file in the app directory

Configuration

// package.json
{
    "tk": {
        "templates": [
          "path/to/additional/templates_list_1",
          "path/to/additional/templates_list_2",
          "P:/absolute/path/to/additional/templates_list_3"
        ]
    }
}
// or
{
  "workspaces": [
      "apps/*",
      "libs/*"
  ]
}

Roadmap

• Generate App
  • Template Paths
  • Remote Templates
• Delete App
• Initialize Base
  • Base Types
• InkJS Renderer
  • Operations
  • Replace Inquirer.JS
• Add Publish Script

License

Distributed under the MIT License. See LICENSE.txt for more information.