create-3h-node

A node lib initializer.

Introduction

This is a CLI tool that helps you quickly initialize a development environment for your awesome node library.

Usage

$ create-3h-node --help
A front-end lib initializer.

Usage:
  create-3h-node [options]

Options:
  --name, -n <pkg>              The name of the package
  --author, -a <name>           The author of the package
  --desc, -d <description>      The description of the package
  --keywords, -k <words...>     The keywords of the package
  --repo, -r <repository>       The repository of the package
  --no-install                  Do not install dependencies instantly
  --help, -h                    Show help info

Example

npm init 3h-node -n my-awesome-lib -a Peter -d "This is my awesome lib"
# or
npx create-3h-node -n my-awesome-lib -a Peter -d "This is my awesome lib"

Template Structure

your-awesome-lib/
+-- src/
| `-- index.ts
+-- test/
| `-- index.js
+-- .gitignore
+-- CHANGELOG.md
+-- LICENSE
+-- README.md
`-- tsconfig.json

Workflow

Generally, you

1. Write your source code in the src folder in TypeScript
2. Build your lib by executing npm run build
3. Write test code in test/index.js
4. Execute test/index.js to test your lib
5. ...

Built-in Scripts

| name | description | |:--------|:--------------------| | build | build your code | | docs | build API reference |

Specifically, after building your code by executing npm run build, compiled JavaScript files are placed in the js folder. Additionally, you can execute npm run docs to build the API reference of your lib using package dts2md. By default, documentation files are placed in the docs folder.