Skip to content

Barretem/cli-scaffold

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cli-scaffold

Status Platform GitHub Issues GitHub Pull Requests License


标准的命令行工具脚手架,能够快速像写TS那样写CLI命令行工具

📝 目录

  1. 简介
  2. 使用说明
  3. 开发说明
  4. 项目说明
  5. TODO

🧐 简介

命令行工具脚手架,能够快速开发相应的命令行工具,减少配置的烦恼。使得命令行工具的编写变得更加简单。

🎈使用说明

将代码clone到本地:

git clone https://github.com/Barretem/cli-scaffold.git

💭 开发说明

# 进入项目目录
cd cli-scaffold
# 安装相关的依赖
yarn
# 启动项目
yarn dev
# 运行命令行工具
node bin/spaas add module
# 即可运行编写的代码

🚀 项目说明

项目目录

cli-scaffold
 ┣ bin
 ┃ ┣ spaas # 命令行入口文件
 ┣ src
 ┃ ┣ add
 ┃ ┃ ┗ module.ts # 命令行脚本
 ┃ ┗ utils
 ┃ ┃ ┗ index.ts
 ┣ .babelrc
 ┣ .gitignore
 ┣ .npmignore
 ┣ .npmrc
 ┣ README.md
 ┣ global.d.ts
 ┣ package.json
 ┣ tsconfig.json
 ┣ tslint.json
 ┗ yarn.lock
  • 需要更改命令行初始命令的话,只需要在package.json中找到bin对象,将spaas改掉即可
  • 开发新命令的时候,统一在bin目录加上${初始化命令}-${二级命令}文件,并且文件头部需要加上#! /usr/bin/env node
  • 其余的命令逻辑统一在src目录下

⛏️ TODO

About

命令行工具脚手架

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published