# platform-cli

> generator of project prototype

Latest version **1.1.2** (published 2016-06-07) · ISC license · 0 weekly downloads

## Install

```sh
npm install platform-cli
pnpm add platform-cli
yarn add platform-cli
bun add platform-cli
```

Provides the commands `pf`, `server`, `pf-init`, `pf-make`, `pf-mock`, `platform`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2016-06-07 |
| First published | 2016-05-10 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 16 |
| Known vulnerabilities | 0 (+4 in 3 direct dependencies) |
| Install scripts | no |
| Author | lanmingming |
| Maintainers | minglan |
| Keywords | platform |

## Links

- npm: https://www.npmjs.com/package/platform-cli
- npm.io page: https://npm.io/package/platform-cli

## Dependencies (16)

- [koa](https://npm.io/package/koa.md) ^1.1.2
- [chalk](https://npm.io/package/chalk.md) ^1.1.1
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [mockjs](https://npm.io/package/mockjs.md) ^1.0.0
- [rimraf](https://npm.io/package/rimraf.md) ^2.5.2
- [koa-ejs](https://npm.io/package/koa-ejs.md) ^3.0.0
- [request](https://npm.io/package/request.md) ^2.69.0
- [co-views](https://npm.io/package/co-views.md) ^2.1.0
- [koa-body](https://npm.io/package/koa-body.md) ^1.4.0
- [commander](https://npm.io/package/commander.md) ^2.9.0
- [koa-views](https://npm.io/package/koa-views.md) ^4.1.0
- [koa-multer](https://npm.io/package/koa-multer.md) ^1.0.0
- [koa-router](https://npm.io/package/koa-router.md) ^5.4.0
- [koa-static](https://npm.io/package/koa-static.md) ^2.0.0
- [koa-bodyparser](https://npm.io/package/koa-bodyparser.md) ^2.0.1
- [download-git-repo](https://npm.io/package/download-git-repo.md) ^0.1.1

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.1.2 (latest) — 2016-06-07
- 1.1.1 — 2016-05-18
- 1.1.0 — 2016-05-18
- 1.0.9 — 2016-05-16
- 1.0.8 — 2016-05-16
- 1.0.7 — 2016-05-16
- 1.0.6 — 2016-05-16
- 1.0.5 — 2016-05-16
- 1.0.4 — 2016-05-11
- 1.0.3 — 2016-05-10
- 1.0.2 — 2016-05-10
- 1.0.1 — 2016-05-10
- 1.0.0 — 2016-05-10

## README

#### 安装
``` powershell
npm install -g platform-cli
```

#### 初始化项目
``` powershell
#pf为platform 简写， 可以使用platform 代替pf
#查看帮助
pf init -h
#列出可用的种子项目
pf init -l
#初始化项目(以vue为例)
pf init vue vue-platform 
```

#### 生成样板文件

``` powershell
#该命令只能在项目的 src 文件夹下执行
cd vue-platform/src 
#查看帮助
pf make -h
#列出可生成文件列表
pf make -l
#生成test组件
pf make ct test
#生成test页面
pf make pg test
```

#### 开启mock服务
``` powershell
#在本地4000端口开启， 进入 打开 localhost:4000/index 页面
pf mock -p 4000
```

#### 自定义配置文件
###### 在项目的根目录下有 `.platform` 配置文件， 该文件为必须。
``` powershell
{
	"type": "vue",              // 指定项目类型
	"template": "boilerplate"   // 指定样板文件的模板文件存放位置
}
```
###### 模板文件配置在`config.json` 中， 可以自定义生成类型,  `short` 字段用来配置命令简写
``` powershell
{
	"component": {
		"desc": "Create a new Vue Component in a `.vue` format",
		"file": "component.vue",
		"type": ".vue",
		"example": "vue make component(ct) components/CounterWidget"
	},
	"page": {
		"desc": "Create a new page in a `.vue` format",
		"file": "page.vue",
		"type": ".vue",
		"example": "vue make page pages/CounterPage"
	},
	"short": {
		"ct": "component",
		"pg": "page"
	}
}
```
#### mock服务使用
###### 改功能用来模拟后端数据，数据基于 [mock.js](http://mockjs.com/examples.html)生成， 在界面中填入接口及`request param` , `request body` , `response` 等，然后访问 `http://localhost:{port}/mock/{your interface}` 便可以根据你填的`response` 得到返回数据。例如：
``` powershell
输入：
	api: mymock,
	param: test,
	response: { // 填入的response为标准json
		"errno": 0,
		"data": {
			"mock|3": [{
				"name": "test"
			}]
		}
	}
访问： http://localhost:4000/mock/mymock?test=1
返回: {
	"errno": 0,
	"data": [
		{"name": "test"},
		{"name": "test"},
		{"name": "test"}
	]
}
```

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