# mrepo-cli

> m-cli 是一款快速搭建前端项目的脚手架工具。

Latest version **0.5.0** (published 2023-03-23) · MIT license · 0 weekly downloads

## Install

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

Provides the command `m-cli`.

## 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.5.0 |
| Published | 2023-03-23 |
| First published | 2022-08-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 3.6 MB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | xinghen |

## Links

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

## Dependencies (7)

- [ora](https://npm.io/package/ora.md) ^5.0.0
- [axios](https://npm.io/package/axios.md) ^0.26.1
- [chalk](https://npm.io/package/chalk.md) ^4.0.0
- [figlet](https://npm.io/package/figlet.md) ^1.5.2
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.0.1
- [commander](https://npm.io/package/commander.md) ^9.0.0
- [download-git-repo](https://npm.io/package/download-git-repo.md) ^3.0.2

## Recent versions

- 0.5.0 (latest) — 2023-03-23
- 0.4.0 — 2022-09-06
- 0.2.0 — 2022-08-07
- 0.1.0 — 2022-08-07

## README

### 介绍

m-cli 是一款快速搭建前端项目的脚手架工具。

### 安装

```
npm i -g mrepo-cli
# or
yarn global add mrepo-cli
```
### 使用流程
```
1、输入项目名称；
2、询问一些配置，并根据配置渲染模板；
4、完成创建项目，并输出运行提示;
```

### 基础
1、通过运行以下命令来创建一个项目：
```
m-cli create [项目名称]
```
2、选择前端前端框架
![markdown picture](./assets/framework.jpg) 
3、选择项目模板
![markdown picture](./assets/template.jpg)
4、选择需要的功能模块
![markdown picture](./assets/plugin.jpg)
5、下载并安装环境依赖
![markdown picture](./assets/install.jpg)
![markdown picture](./assets/pro.jpg)

### 开发
工程目录如下图所示：
![markdown picture](./assets/dir.jpg)
整个项目逻辑如下:
```
1、选择前端框架，如vue、react、svelte...
2、根据前端框架筛选可用的项目模板；
3、根据项目模板匹配需要的功能模块，如相关库、业务模块工具函数库...
4、检查同名项目，覆盖或重命名；
5、下载对应项目模板，并添加相关的功能模块；
6、根据选择的功能模块，更新package.json文件；
7、安装项目依赖库
8、输出运行提示
```
代码地址：core/create.js
![markdown picture](./assets/code_create.jpg)
项目模板可根据需要手动配置工程文件或项目地址
本地文件地址：src:[工程路径]
远端项目地址：direct:[https地址]
代码地址：lib/repo/config.js
![markdown picture](./assets/repo.jpg)
### 本地调试
```
npm link
```
### 发布
登陆NPM
注意：发布时，需换源 
```
npm config set registry https://registry.npmjs.org/

npm login
npm publish

```
![markdown picture](./assets/publish.jpg)

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