caz: A TypeScript repository from LuoHao-study

A simple yet powerful template-based Scaffolding tools for my personal productivity.

Introduction

CAZ (Create App Zen)

It's a a simple template-based Scaffolding tools for my personal productivity, inspired by Yeoman & Vue CLI 2 & etc.

pronounced: [kæz] 📷 ✌
written: CAZ / caz

For more introduction, please refer to the How it works.

Features

Light-weight
High efficiency
Less dependencies
Configurable
Extensible
Template-based
TypeScript
Use modern API
Easy to use
Still powerful

I'll give you specific reasons later

Introduction
- Features
Getting Started
Common Usage
Advanced Usage
References
Motivation
About
- How It Works
- Built With
Roadmap
Contributing
License

Getting Started

Prerequisites

Node.js (>= 10.17, 12.10 preferred)
npm (>= 6.x) or yarn (>= 1.20)
Git (>= 2.20)

Installation

# install it globally
$ npm install -g caz

# or yarn
$ yarn global add caz

Basic Usage

Create new project from a template.

$ caz <template> [project] [-f|--force] [-o|--offline]

# caz with an official template
$ caz <template> [project]

# caz with a github repo
$ caz <owner>/<repo> [project]

If you only use it occasionally, I recommend that you use npx to run caz directly.

$ npx caz <template> [project] [-f|--force] [-o|--offline]

Options

-f, --force: Overwrite if the target exists
-o, --offline: Try to use an offline template

Common Usage

GitHub Repository Templates

$ caz nm my-project

The above command pulls the template from caz-templates/nm, then prompts for some information according to the configuration of this template, and generate the project at ./my-project.

$ caz nm#typescript my-project

By running this command, CAZ will pulls the template from typescript branch of caz-templates/nm.

Use Custom templates

$ caz zce/nm my-project

The above command pulls the template from zce/nm. This means that you can also pull templates from your GitHub repository.

Local Templates

Instead of a GitHub repo, you can also use a template on your local file system.

e.g.

$ caz ~/local/template my-project

The above command use the template from ~/local/template.

Remote ZIP Templates

Instead of a GitHub repo, you can also use a template with a zip file uri.

e.g.

$ caz https://cdn.zce.me/boilerplate.zip my-project

The above command will download & extract template from https://cdn.zce.me/boilerplate.zip.

Offline Mode

$ caz nm my-project --offline

By running this command, CAZ will try to find a cached version of nm template or download from GitHub if it's not yet cached.

List Available Templates

Show all available templates

$ caz list [owner] [-j|--json] [-s|--short]

Options:

-j, --json: Output with json format
-s, --short: Output with short format
-h, --help: Display this message
-v, --version: Display version number

Official Templates

Current available templates list:

template - for creating caz templates.
nm - for creating node modules.
react - 🚧 for creating modern react app.
vue - for creating modern vue.js app.
electron - 🚧 for creating electron app.
jekyll - 🚧 for creating jekyll site.
mp - 🚧 for creating wechat mini-programs.
x-pages - for creating x-pages static site.

Maybe more: https://github.com/caz-templates

You can also run $ caz list to see all available official templates in real time.

Advanced Usage

Create Your Template

$ caz template my-template

The above command will pulls the template from caz-templates/template, and help you create your own CAZ template.

To create and distribute your own template, please refer to the How to create template.

Maybe fork an official template is also a good decision.

Configuration

CAZ will read the configuration file in ~/.cazrc, default config:

; template download registry,
; {owner} & {name} & {branch} will eventually be replaced by the corresponding value.
registry = https://github.com/{owner}/{name}/archive/{branch}.zip
; template offlicial organization name
official = caz-templates
; default template branch name
branch = master

This means that you can customize the configuration by modifying the configuration file.

For example, in your ~/.cazrc:

registry = https://gitlab.com/{owner}/{name}/archive/{branch}.zip
official = faker
branch = dev

Then run the following command:

$ caz nm my-project

The above command will download & extract template from https://gitlab.com/faker/nm/archive/dev.zip.

Programic API

# install it locally
$ npm install caz

# or yarn
$ yarn add caz

with ESM and async/await:

import caz from 'caz'

;(async () => {
  try {
    const template = 'nm'
    // project path (relative cwd or full path)
    const project = 'my-project'
    const options = { force: false, offline: false }
    // scaffolding by caz...
    await caz(template, project, options)
    // success created my-project by nm template
  } catch (e) {
    // error handling
    console.error(e)
  }
})()

or with CommonJS and Promise:

const { default: caz } = require('caz')

const template = 'nm'
// project path (relative cwd or full path)
const project = 'my-project'
const options = { force: false, offline: false }
// scaffolding by caz...
caz(template, project, options)
  .then(() => {
    // success created my-project by nm template
  })
  .catch(e => {
    // error handling
    console.error(e)
  })

This means that you can develop your own scaffolding module based on it.

To create and distribute your own scaffolding tools, please refer to the How to create scaffolding tools based on CAZ.

References

caz(template, project?, options?)

Create new project from a template

template

Type: string
Details: template name

project

Type: string
Details: project name
Default: '.'

options

Type: object
Details: options
Default: {}

force

Type: boolean Details: overwrite if the target exists Default: false

offline

Type: boolean Details: try to use an offline template Default: false

Motivation

👉 🛠 ⚙

Joking: I want to make wheels ;P

The real reason is that I think I need a scaffolding tool that is more suitable for my personal productivity.

Nothing else.

About

How It Works

P.S. The picture is from the Internet, but I have forgotten the specific source, sorry to the author.

Main Workflow

The core code is based on the middleware mechanism provided by zce/mwa.

The following middleware will be executed sequentially.

confirm - Confirm destination by prompts.
resolve - Resolve template from remote or local.
load - Load template config by require.
inquire - Inquire template prompts by prompts.
setup - Apply template setup hook.
prepare - Prepare all template files.
rename - Rename file if necessary.
render - Render file if template.
emit - Emit files to destination.
install - Execute npm | yarn | pnpm install command.
init - Execute git init && git add && git commit command.
complete - Apply template complete hook.

Built With

cac - Simple yet powerful framework for building command-line apps.
chalk - Terminal string styling done right
env-paths - Get paths for storing things like data, config, cache, etc
extract-zip - unzip a zip file into a directory using 100% javascript
fast-glob - It's a very fast and efficient glob library for Node.js
ini - An ini encoder/decoder for node
lodash - Lodash modular utilities.
node-fetch - A light-weight module that brings Fetch API to node.js
ora - Elegant terminal spinner
prompts - Lightweight, beautiful and user-friendly prompts
semver - The semantic version parser used by npm.
validate-npm-package-name - Give me a string and I'll tell you if it's a valid npm package name

Roadmap

The following are the features I want to achieve or are under development:

See the open issues for a list of proposed features (and known issues).

Contributing

Fork it on GitHub!
Clone the fork to your own machine.
Checkout your feature branch: git checkout -b my-awesome-feature
Commit your changes to your own branch: git commit -am 'Add some feature'
Push your work back up to your fork: git push -u origin my-awesome-feature
Submit a Pull Request so that we can review your changes.

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

LuoHao-study/caz