1.1.0 • Published 5 years ago

koro-cli v1.1.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

一个类似vue-cli的脚手架

一个类似vue-cli的脚手架,用于学习脚手架开发理念:下载模板,通过命令行交互, 处理下载的模板

本项目基于:eos-cli

example:

npm.io

全局安装:

npm install koro-cli -g

mac环境下要加sudo

如果你用npm安装失败,报权限问题用sudo也没有用,可以尝试一下用cnpm。(我遇到了这个问题,现在也不知道为什么会这样!)

演示

本地调试

下载项目。

安装依赖

npm install

监听变动,方便本地调试

npm run watch

修改配置文件位置:

本地调试将配置文件放在项目中,方便调试:

// constants.js
// 配置文件目录
// export const RC = `${HOME}/.kororc`;
export const RC = `./.kororc`; //本地调试将配置文件放在项目中,方便调试

创建配置文件:

npm run postinstall

本地开发的时候需要创建该文件,发布到npm上就不用了。

因为用户install之后,会自动执行npm run postinstall

执行 npm link

package.json上的配置,链接到全局, 此时就可以使用 koro 命令了。

mac 环境下要使用sudo npm link才能链接全局环境。

下载模板:

本项目是一个学习项目, 项目内置模板为一个只有readme仓库,然后只是简单的把用户选项放到新创建的:answer.txt文件中。

koro init testName // 下载模板到testName文件夹

修改下载仓库:

koro config set registry OBKoro1 // 修改用户
koro config set templateName codeBlack // 修改仓库名

自定义模板

正常情况下:应该根据用户命令行交互的命令,通过node.js来自定义项目模板,这一步需要大家自己做了。

发布

开发完成后,即可发布至 npm, 用户通过 npm install koro-cli -g 全局安装。 即可使用 koro 命令

注意事项:

  1. 更改package的bin属性即可更改命令名称
"bin": {
    "else": "./bin/www"
}

注意postinstall也要修改。

  1. 发布之前要将.kororc文件改回去:
// 配置文件目录
export const RC = `${HOME}/.kororc`; // 全局读取
// export const RC = `./.kororc`; // 本地调试将配置文件放在项目中,方便调试