Skip to content

Latest commit

 

History

History
209 lines (149 loc) · 5.7 KB

README.zh-CN.md

File metadata and controls

209 lines (149 loc) · 5.7 KB
Raw

🐸 @omni-door/cli

https://www.omnidoor.org

一个能创建标准的前端项目的脚手架。

NPM downloads npm version node version Build Status codecov install size license

English | 简体中文

<omni.config.js> 详解

变更日志

安装

推荐使用 node 最新的 LTS 版本，或至少保证 node >= 10.13.0

几个选项:

  • 克隆仓库: git@github.com:omni-door/cli.git

  • 用 npm 安装：npm install @omni-door/cli -g

  • 用 Yarn 安装：yarn global add @omni-door/cli

  • 直接用 npx 初始化你的项目：npx @omni-door/cli init

omni --help

  使用: omni [command] [options]

  Options:

    -v, --version   输出版本号
    -h, --help      输出使用帮助

  Commands:

    init [strategy] [options]  初始化你的项目，[strategy(策略)] 可用是stable(默认) 或 lastst
    dev [options]              omni dev -p [port]
    new <module> [options]     omni new [module] [-f | -c]
    build                      根据 [omni.config.js] 打包构建你的项目
    release [options]          根据 [omni.config.js] 发布你的项目

omni init

初始化一个项目

omni init

用最新的依赖@lastest初始化项目

omni init lastest

初始化项目但不安装依赖

omni init -n

套用模板一键初始化项目

omni init -t [projectName]

or

omni init --entire [projectName]

选项

使用: omni init [strategy] [options]

initialize your project, [strategy] could be stable(default) or latest

Arguments:

  strategy                 stable or latest

  Options:
    -rb, --react_basic [name]       创建一个最基本的 React 单页应用
    -rs, --react_standard [name]    创建一个标准的 React 单页应用
    -re, --react_entire [name]      创建一个全量的 React 单页应用
    -rp, --react_pc [name]          创建一个基于 Antd 的 React 中后台单页应用
    -vb, --vue_basic [name]         创建一个最基本的 Vue 单页应用
    -vs, --vue_standard [name]      创建一个标准的 Vue 单页应用
    -ve, --vue_entire [name]        创建一个全量的 Vue 单页应用
    -rS, --react_ssr [name]         创建一个 React SSR 应用
    -rc, --react_components [name]  创建一个 React 组件库
    -vc, --vue_components [name]    创建一个 Vue 组件库
    -t, --toolkit [name]            创建一个工具库
    -n, --no-install                初始化项目不安装任何依赖
    -P, --path <path>               创建项目的工作路径
    -h, --help                      输出帮助信息

omni dev

选项

使用: omni dev [options]

omni dev [-p <port>] [-H <host>] [-P <path>]

Options:
  -p, --port <port>      根据指定的端口号启动开发服务
  -H, --hostname <host>  根据指定的hostname启动开发服务
  -P, --path <path>      启动开发服务的工作路径
  -h, --help             输出帮助信息

omni start

选项

使用: omni start [options]

omni start [-p <port>] [-H <host>] [-P <path>]

Options:
  -p, --port <port>      根据指定的端口号启动生产服务
  -H, --hostname <host>  根据指定的hostname启动生产服务
  -P, --path <path>      启动生产服务的工作路径
  -h, --help             输出帮助信息

omni new

选项

使用: omni new [name] [options]

omni new [name] [-f | -c] [-P <path>]

Arguments:

  module           可选！组件名称。

Options:
  -f, --function     创建一个React函数组件
  -c, --class        创建一个React类组件
  -r, --render       创建一个Vue渲染函数组件
  -s, --single       创建一个Vue模板组件
  -P, --path <path>  创建组件的工作路径
  -h, --help         输出帮助信息

omni build

选项

使用: omni build [options]

根据 [omni.config.js] 的 build 字段构建项目

Options:
  -c, --config <path>  指定构建的配置文件路径
  -n, --no-verify      绕过所有预检直接构建
  -P, --path <path>    构建的工作路径
  -h, --help           输出帮助信息

omni release

选项

使用: omni release [options]

根据 [omni.config.js] 的 release 字段发布项目

Options:
  -a, --automatic         发布并自动迭代版本号
  -i, --ignore            发布并忽视版本号的迭代
  -m, --manual <version>  发布并手动指定版本号
  -t, --tag <tag>         发布时指定tag
  -n, --no-verify         绕过所有的预检直接发布
  -P, --path <path>       发布的工作路径
  -h, --help              输出帮助信息

API文档

点 这里

License

Copyright (c) 2019 Bobby.li

Released under the MIT License