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

96
IT晴天
2017.12.29 22:13 字数 400

公司的业务有部分需要兼容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源。

那年前端