# @tool-developer/wo-cli

> Command line interface for rapid development

Latest version **0.0.6** (published 2023-10-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @tool-developer/wo-cli
pnpm add @tool-developer/wo-cli
yarn add @tool-developer/wo-cli
bun add @tool-developer/wo-cli
```

Provides the command `wo`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2023-10-05 |
| First published | 2021-07-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 17 |
| Unpacked size | 51.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | @tool-developer |
| Maintainers | tooldeveloper |
| Keywords | cli, wo-cli |

## Links

- npm: https://www.npmjs.com/package/@tool-developer/wo-cli
- Repository: https://github.com/tool-developer/wo-cli
- Homepage: https://github.com/tool-developer/wo-cli#readme
- Issues: https://github.com/tool-developer/wo-cli/issues
- npm.io page: https://npm.io/package/@tool-developer/wo-cli

## Dependencies (17)

- [ora](https://npm.io/package/ora.md) ^5.4.1
- [glob](https://npm.io/package/glob.md) ^7.1.7
- [chalk](https://npm.io/package/chalk.md) ^4.1.1
- [debug](https://npm.io/package/debug.md) ^4.3.2
- [execa](https://npm.io/package/execa.md) ^5.1.1
- [dotenv](https://npm.io/package/dotenv.md) ^10.0.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [mem-fs](https://npm.io/package/mem-fs.md) ^2.2.1
- [semver](https://npm.io/package/semver.md) ^7.3.5
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.0.0
- [inquirer](https://npm.io/package/inquirer.md) ^8.1.1
- [papaparse](https://npm.io/package/papaparse.md) ^5.3.1
- [jscodeshift](https://npm.io/package/jscodeshift.md) ^0.13.0
- [is-git-clean](https://npm.io/package/is-git-clean.md) ^1.1.0
- [yargs-parser](https://npm.io/package/yargs-parser.md) ^20.2.9
- [mem-fs-editor](https://npm.io/package/mem-fs-editor.md) ^9.0.1
- [yeoman-generator](https://npm.io/package/yeoman-generator.md) 4.13.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.0.6 (latest) — 2023-10-05
- 0.0.5 — 2021-12-20
- 0.0.4 — 2021-11-25
- 0.0.3 — 2021-07-10
- 0.0.2 — 2021-07-07
- 0.0.1 — 2021-07-06

## README

# wo-cli
快速开发脚手架

可以自定义模板，从而创建对应模板类型项目，模板不受语言框架限制(React,Vue均可)，具体参考[添加新模板类型](#添加新模板类型)。



## 操作步骤
第一步：全局安装脚手架
```
npm i -g @tool-developer/wo-cli
```

第二步：创建空项目目录(非空目录会提示是否覆盖)
```
mkdir projectName && cd projectName
```

第三步：项目初始化(拉取项目模板)

建议：如果不是首次安装使用脚手架，建议都先经过第六步操作，升级脚手架模板和元数据信息。
```
wo
```
or
```
wo [init] [options]

wo [init] --name projectName --port 8000
```

第四步：根据项目prompts提示进行设置，常见prompts说明：
```
name:输入项目名称，默认使用文件名

type:项目类型，目前支持fe和ae两种文件类型，更多类型可参考添加项目模板类型

branch:分支选择，对应类型模板仓库分支

description:项目描述，会添加到package.json中
```
`注意`: 
1. 不同的项目模板类型prompts不同；
2. 如果已经通过options方式设置对应prompts值，不会再次要求输入；

第五步：快速创建页面(使用页面模板)
```
wo page [pageName[,pageName,...]] [options]
```
举例说明：
```
wo page test/t1 --template loading
```
使用内部的loading页面模板创建了test/t1文件，文件内容，以及目录结构以实际页面模板为准。

如果不想生成的文件都为index.*，可以使用--no-index选项
```
wo page user/test2 --no-index
```

通过--dir，指定自定义目录，创建页面
```
wo page user/test3 --dir src/pages
```

如果.wo中配置有--template对应模板同名大写目录，会使用该目录
.wo
```
CONTROLLER=controller/
```
配置有CONTROLLER(controller的大写)，指定--templdate的时候，会使用该配置，

不会使用SRC_PAGES配置，从而实现页面模板多目录配置。
```
wo page user/test4 --template controller
```
执行优先级是--dir,[template.toUpperCase()],SRC_PAGES。



`注意`:如果本身页面模板就没有index.*相关文件，是可以不使用no-index选项的，使用了会得到如下提示：

>The 'index' is not index.* files, can not set 'not-index' option 

使用过程中，如果不清楚有什么页面模板，可以通过以下操作查看页面模板列表：
```
wo page --list
```

第六步：升级模板类型和元数据信息(建议创建新项目之前，都执行该步骤，保证本地模板是最新的)

```
wo update --meta --type
```

由于访问github的问题，模板仓库同步了一份到gitee.com

v0.05之后，可以指定meta仓库为gitee.com地址
```
wo update --meta https://gitee.com/tool-developer/wo-template-meta.git --type
```

or 

只升级具体类型模板
```
wo update --type wx
```

## 命令详解
如果记不住有哪些操作命令，以及各个命令是如何使用的，以及相关参数，可以使用help，很容易就可以得到相应命令的帮助信息。

### 命令帮助
#### 查看脚手架实现了哪些命令
```
wo -h
```
or
```
wo --help
```

#### 查看某个命令，更加详细帮助信息

wo [cmd] -h/--help

wo help [cmd]
```
wo help list
```
or
```
wo list -h
```
or 
```
wo list --help
```

## 添加新命令
只需要在scripts目录下创建对应[cmd].js文件，即可创建对应命令。

对于up-*相关的操作，除了添加文件之外，还需要在update.js中添加参数说明即可。

### 命令文件格式约定
```
// 处理入口方法
exports.run = async(opts={})=>{
  // 接收参数，参数从opts中得到，已经进行了parse转换处理
  // 具体处理
}
// 该命令描述信息，会显示在help中
exports.description = '';
// 用法，会显示在help中
exports.usage = 'wo [cmd] [options]';
// 参数options，以及说明，会显示在help中
exports.options = {
  '--name':"Set your template name"
}
// 不显示该命令
exports.hide = true;// 默认为false
```
强烈建议description,usage,options放在文件的最底部，方便查看。

### 添加新模板类型
相关模板建议放置到专门的基础权限模板仓库分组中，仓库地址为：
```
https://github.com/tool-developer-template/
```
建议命名格式采取wo-template-[type]的方式，便于快速找到对应模板仓库地址。

其中模板元数据信息仓库地址：
```
https://github.com/tool-developer-template/wo-template-meta.git
```
wo-template-meta中只有一个types.json的文件，记录当前已添加的模板类型，大概格式如下：
```
{
 "wx": {
  "repository": "https://github.com/tool-developer-template/wo-template-wx.git",
  "description": "微信小程序"
 }
}
```
可以知道，包含了某个模板类型(ae)中的仓库地址(repository)，以及模板类型描述(description)等几个信息。

脚手架通过读取该文件，就可以得到当前模板类型列表，以及对应模板的仓库地址，从而将其clone到本地，这样脚手架就可以通过这些信息创建对应的项目类型。

### 模板的基本结构
可以随意点开一个模板，可以看到类似这样的目录结构：
```
meta.js:设置模板初始化完成之后的提示操作信息

template/:具体的项目目录结构，内部可设置变量，经过ejs模板引擎解析处理

pages/:具体页面模板，里面的每一个文件夹名，就对应一个页面模板，里面的文件结构，就对应页面模板的具体内容

transform/:模板升级转换处理

.wo:项目环境配置文件

```

meta.js文件信息说明：
```
// 项目创建完成后输出信息
exports.run ={
  "yarn test":"Start to test the project"
};
// 项目创建过程中的prompts
// 参考:https://github.com/SBoudrias/Inquirer.js/blob/master/README.md
exports.prompts = {
  "name": {
      "message": "What's the project name?",
      "default": "`${this.name}`"
  },
  "description": {
      "name": "description",
      "message": "What's your project description?"
  }
}
```

.wo 关键信息
```
TYPE: 模板类型

SRC_PAGES: 页面文件目录

BRANCH: 分支信息
```


### 项目模板添加
模板的添加过程，就是将我们创建的遵循一定目录结构的文件提交到git仓库中，然后将该仓库地址信息添加到wo-template-meta/types.json中。

这个操作过程，可以纯手动完成，就像操作普通的git操作流程那样即可。

也可以通过脚手架命令操作：
```
wo add --name test --repo https://github.com/tool-developer-template/wo-template-test.git --desc 测试
```

需要注意的是：
1. 我们的模板需要设置为public仓库类型；
2. 添加的repo地址，需要使用https的地址，不要使用git@打头的地址；

### 项目模板移除
想要删除某种项目模板类型，只需要将其从wo-template-meta/types.json中移除，重新提交即可。对应关联的git仓库地址，可以不用删除(建议也不要删除)。

### 页面模板添加
页面模板，只需要在模板仓库地址中有pages目录下，放置提取的页面结构文件即可。

页面模板中也可以使用变量，除了注入prompts输入之外，还额外注入两个变量。

```
pageName:页面名字,如index
contextName:转换处理之后的页面名字(首字母转换为大写),如Index
```

---
_Source: https://npm.io/package/@tool-developer/wo-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._