自建node的简单cli——san-cli

公司的业务有部分需要兼容IE8,虽然公司内部已有相应的框架,但是百度的San还是引起了个人的兴趣,奈何San这个东西,一年多了配套还有待完善,为了快速构建项目,自建一个简单cli,步骤如下:

创建cli项目

创建san-cli目录,并使用npm init创建package.json文件:

mkdir san-cli && cd san-cli
npm init

在交互询问中输入相应参数,其中name参数检验npm中是否已占用,如创建好的package.json文件如下,其中bin为cli调用的命令名称,main为入口js:

{
  "name": "my-san-cli",
  "version": "0.0.1",
  "description": "Auto generate san(a MVVM framework) project template",
  "main": "index.js",
  "bin": {
    "san": "./index.js"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/woodstream/san-cli.git"
  },
  "keywords": [
    "san-cli"
  ],
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "woodstream",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/woodstream/san-cli/issues"
  },
  "dependencies": {
  }
}

由于入口为index.js,所以创建index.js文件,并写入如下内容:

#!/usr/bin/env node

const clone = require('git-clone')
const program = require('commander')
const shell = require('shelljs');
const log = require('tracer').colorConsole()


program
    .version('0.0.1')
    .description('San(MVVM framework)应用模板工程的cli')
program
    .command('* init <project> <tpl>')
    .action(function(tpl, project) {
        log.info('目前san-cli支持amd和webpack两种模板,示例:san init myproject --amd | --webpack')
        if (tpl && project) {
            let pwd = shell.pwd()
            let url;
            if(tpl == '--amd'){
                url = `https://github.com/woodstream/san-mui-with-amd.git`;
            }else{
                url = `https://github.com/woodstream/san-mui-with-webpack.git`;
            }
            log.info(`正在${url}拉取模板代码 ...`)
            clone(url, pwd + `/${project}`, null, function() {
                shell.rm('-rf', pwd + `/${project}/.git`)
                log.info('模板工程建立完成')
            })
        } else {
            log.error('正确命令例子:san-cli init myproject --amd')
        }
    })
program.parse(process.argv)

意思是根据不同的命令参数,拉取不同多脚手架模版,可以观察到require到依赖模块,所以npm里添加依赖配置,执行命令:

npm i commander --save
npm i git-clone --save
npm i shelljs --save
npm i tracer --save

执行完后再次打开package.json,可以发现里面多了如下内容:

 "dependencies": {
    "commander": "^2.12.2",
    "git-clone": "^0.1.0",
    "shelljs": "^0.7.8",
    "tracer": "^0.8.11"
  }

安装并测试cli

执行如下命令全局安装即可,:

npm i 上述san-cli项目的本地或远程路径 -g

安装完成,测试:

san init san-demo --amd

发布到npm

1、先到npm网站注册一个账号,去关联邮箱收取邮件并验证邮箱。
2、在命令行登录npm,输入下述命令,随后填入注册时的信息:

npm adduser

3、发布提交:

npm publish

4、若发布失败,检查是否使用npm的源,如使用cnpm等第三方源的切换回npm源。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,427评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,551评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,747评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,939评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,955评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,737评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,448评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,352评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,834评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,992评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,133评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,815评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,477评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,022评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,147评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,398评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,077评论 2 355

推荐阅读更多精彩内容