# fronts-cli

**Repository Path**: zk_team/fronts-cli

## Basic Information

- **Project Name**: fronts-cli
- **Description**: 打造大前端公共使用的脚手架提供给 
开发团队使用的集合脚手架和团队项目规范等 脱离业务代码等
- **Primary Language**: JavaScript
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-08-21
- **Last Updated**: 2023-04-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

fronts-cli

## fronts-cli web 前端工具箱(类 vue-cli 等)

## 模板生成命令

#### 全局安装

- (如之前有安装可以 先卸载 npm uninstall fronts-cli -g)
- npm install fronts-cli -g

#### 如需下载特定版本 加@1.8.5（版本号）

npm i fronts-cli@latest -g

```js static
    Usage: main [options] [command]

    Options:
    -V, --version                  output the version number
    -project,--project [name]      build you develop project name
    -token,--apitoken [apitoken]   send your api token
    -author,--author [name]        send your author
    -trigger,--triggerName [name]  send your triggerName
    -branch,--gitBranch [name]     send your gitBranch/tags
    -autotag,--autotag [name]      auto creat your tags
    -host,--host [name]            send your jenkis host
    -file,--file [name]            send your file
    -newfile,--newfile [name]      send your newfile
    -imgMin,--k
    -h, --help                     display help for command

    Commands:
    setup [env]                    run setup commands for all envs
    git-tag [options] [env]        set git tag for all envs
    auto-replace-file [env]        run auto-replace-file for repalce file
    push [options] [env]           run push commands for all envs
    auto-serve [options] [env]     run auto-serve commands for all envs
    create                         run create template file commands
    uploadMini                     run upload miniprogrammer  commands
    husky                          run husky your project commands
    imgMin [options]               Compress images by tinypng api
    help [command]                 display help for command

    Examples:
    $ custom-help --help
    $ custom-help -h

   代码执行模块：

    "dev": "fronts-cli --project rfhouse-html-dev --gitBranch */dev_branch setup dev",
	"test": "fronts-cli  --project rfhouse-html-test-bytag --gitBranch */dev_branch setup test",
    "build": "fronts-cli --project rfhouse-html-bytag --branch xx setup build",
    "test:tag": "fronts-cli --project rfhouse-html-test-bytag --autotag true setup test",
    "push": "fronts-cli push -p true",
    "auto-tag": "fronts-cli git-tag",
    "auto-replace": "fronts-cli auto-replace-file",
    "auto-serve": "fronts-cli auto-serve -p 8007",
    "upload": "fronts-cli uploadMini"

```

#### 自动生成模板

- fronts-cli create 即可运行生成文件交互式命令

#### 模板类型

- vue、小程序 page、小程序 component

#### 预编译 less

- fronts-cli less 即可开启监听 也可以 fronts-cli less -s wxss/css 可传入想生成的文件后缀

#### 自动生成 husky 配置

- fronts-cli husky 即可运行生成 husky 配置工程化

#### 重要补丁和更新

- 更新了微信自动发布 去微信小程序管理后台 配置下载 key [参考文档](https://developers.weixin.qq.com/miniprogram/dev/devtools/ci.html)
- 更新了一个 yarn 安装调整为 cnpm 淘宝镜像
- 新增 pnpm 依赖包选项卡

#### 本地调试

- 使用 npm root -g 找到 NPM 全局包安装位置
- 具体查看当前电脑安装路径（一般 fronts-cli 的项目路径为：C:\Program Files\nodejs\node_modules\fronts-cli）
- 修改 fronts-cli 全局包安装位置 然后执行 fronts-cli 就是当前开发的命令行

#### 注意

- 无法使用 git 命令的同学 注意查看配置 git 命令 [http://note.youdao.com/s/SUkvR3kJ](http://note.youdao.com/s/SUkvR3kJ)
- 配置 jenkis 环境项目[http://note.youdao.com/s/Gl79RraM](http://note.youdao.com/s/Gl79RraM)
- 注意husky配置第一次需要初始化项目 fronts-cli husky
- 打开淘宝镜像对应的 [fronts-cli](https://npmmirror.com/package/fronts-cli)