一些脚手架相关的 npm 包用法汇总

commander

nodejs 命令行解决方案

// 基本用法
const program = require('commander')
program
  .version('1.0.0')
  .name("my-command")
  .usage('<command> [options]')
  .description('测试commander')
  .option('-f, --float <number>', 'float argument')
  .parse(process.argv) // 将option传入的值挂在 pragram 上,如上面的 --float 参数被挂在 program.float

// command 的两种用法
// 1、command 接受一个参数 + action
program
  .command('rm <dir>')
  .option('-r, --recursive', 'Remove recursively')
  .action(function (dir, cmdObj) {
    console.log('remove ' + dir + (cmdObj.recursive ? ' recursively' : ''))
  })
program.parse(process.argv)
// 2、command 接受两个参数(Git风格的子命令)。Commander 将会尝试在入口脚本(例如 ./examples/pm)的目录中搜索 program-command 形式的可执行文件,例如 pm-install, pm-search。
const program = require('commander');
program
  .version('0.1.0')
  .command('install [name]', 'install one or more packages')
  .command('search [query]', 'search with optional query')
  .command('update', 'update installed packages', {executableFile: 'myUpdateSubCommand'})
  .command('list', 'list packages installed', {isDefault: true})
  .parse(process.argv);

inquirer

nodejs 交互命令行解决方案

const inquirer = require('inquirer')

const requireLetterAndNumber = value => {
  if (/\w/.test(value) && /\d/.test(value)) {
    return true
  }
  return 'Password need to have at least a letter and a number'
}

inquirer
  .prompt([{
    type: 'password',
    message: 'Enter a password',
    name: 'password1',
    validate: requireLetterAndNumber
  },
  {
    type: 'password',
    message: 'Enter a masked password',
    name: 'password2',
    mask: '*',
    validate: requireLetterAndNumber
  }
  ])
  .then(answers => console.log(JSON.stringify(answers, null, '  ')))

chalk

通过颜色来高亮 console.log 打印出来的信息

console.log(
        '  ' + chalk.yellow('★') +
        '  ' + chalk.blue(repo.name) +
        ' - ' 

download-git-repo

用于下载远程仓库至本地 支持GitHub、GitLab、Bitbucket

// download(repository, destination, options, callback)
// 以克隆模式将 flippidippi/download-git-repo-fixture 下载到本地 test/tmp 目录下
download('flippidippi/download-git-repo-fixture', 'test/tmp', {clone:true},function (err) {
  console.log(err ? 'Error' : 'Success')
})

ora

用于命令行上的加载效果

const ora=require('ora')
const spinner = ora('downloading template')  
spinner.start()//显示加载状态
spinner.stop() //隐藏加载状态

user-home

用于获取用户电脑的根目录

const home=require('user-home')
path.join(home, '.vue-templates')

tildify

将绝对路径转换成带波浪符的路径

const tildify = require('tildify');
tildify('/Users/sindresorhus/dev');   //=> '~/dev'

metalsmith

插件式的静态网站生成器

// 插件格式
function <function name> {
  return (files,metalsmith,done)=>{
    //逻辑代码
    ...
  }
}

handlebars

模版引擎,渲染字符串级别

var source = "<p>Hello, my name is {{name}}. I am from {{hometown}}. I have " +
             "{{kids.length}} kids:</p>" ;
var template = Handlebars.compile(source);
var data = { "name": "Alan", "hometown": "Somewhere, TX"}
var result = template(data);

consolidate

支持各种模板引擎的渲染,渲染文件级别

var cons = require('consolidate');
cons.handlebars.render('views/page.html', { user: 'tobi' })
  .then(function (html) {
    console.log(html);
  })
  .catch(function (err) {
    throw err;
  });

multimatch

支持多个条件的匹配

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

推荐阅读更多精彩内容