我想写一个前端开发工具(三):优化!从vue-cli学了几招

我从过年开始写自己的前端工具 coodev,目前已经写出一个基本的架子,大多数预想的功能都能跑通,还剩一些需要解决的问题也都已经列出来了。本来这一周打算解决对不同后端模板的前后端渲染支持的问题。但是看了一下代码,当初很多功能写的还是有很大优化空间的。我打算先停下脚步,多看一些优秀的开源框架的源码,然后优化整理一下我的前端工具。
在选择阅读源码时,我首先想到的就是vue-cli的源码。毕竟我最初的灵感就是来源于vue-cli。闲话少说,我们先下载一份vue-cli,打开源码先看package.json熟悉整体的代码结构,不过这里我建议直接阅读/bin 文件夹下的几个文件:vue、 vue-init、 vue-build、 vue-list
引用的比较多的比如vue-init就在一开始引用了一大堆的文件
#!/usr/bin/env node
var download = require('download-git-repo')
var program = require('commander')
var exists = require('fs').existsSync
var path = require('path')
var ora = require('ora')
var home = require('user-home')
var tildify = require('tildify')
var chalk = require('chalk')
var inquirer = require('inquirer')
var logger = require('../lib/logger')
var generate = require('../lib/generate')
var checkVersion = require('../lib/check-version')
var warnings = require('../lib/warnings')
它们都是干嘛用的,我们调一些比较重要的说一下。
一、优化参数处理
先看vue:
#!/usr/bin/env node
require('commander')
.version(require('../package').version)
.usage('<command> [options]')
.command('init', 'generate a new project from a template')
.command('list', 'list available official templates')
.command('build', 'prototype a new project')
.parse(process.argv)
可以看出这个文件主要是对 ‘commander’的使用。那么‘commander’这个npm包又是什么呢?字面意思‘指挥官’,我们在 https://www.npmjs.com/ 网站上可以搜一下,会有一些简单的文档用例。其实‘commander’就是命令控制器,vue-cli用这个库来管理用户输入的命令,来完成在终端上用户命令行的交互。
回到vue-cli能看到一个很大的链试调用,完成了一些列的任务,我们要先了解这些api,就能明白这个文件在干什么了。关于 ‘commander’的API,可以看npm上的官方例子,后续我也会写一篇有关于使用 ‘commander’的文章。我这里先介绍几个我用到的:
我原先是通过一个map定义命令,用到的地方require一下,通过 process.argv.splice(2) 拿到参数。后来改用‘commander’,就比较省心直接注册参数:
var program = require('commander');
program
.version(require('./package').version)
.option('-i, --init', '初始化项目文件夹')
.option('-d, --dev', '以开发模式启动coodev 即时编译 不压缩')
.option('-b, --build', '以生产模式启动coodev 编译一次 压缩')
.option('-s, --server', '本地server调试')
.option('-p, --publish', '提交到发布仓库')
.parse(process.argv);
/** init */
if (program.init) {
require('./src/tasks/task-init.js').render();
}
/** dev */
if (program.dev) {
require('./src/tasks/task-dev.js').render();
}
/** build */
if (program.build) {
require('./src/tasks/task-build.js').render();
}
/** start */
if (program.start) {
require('./src/tasks/task-server.js').render();
}
/** publish */
if (program.publish) {
require('./src/tasks/task-publish.js').render();
}
program.on('--help', function () {
console.log(' Examples:')
console.log()
console.log(chalk.gray(' # create a new project with an official template'))
console.log(' $ coodev --init')
console.log()
console.log(chalk.gray(' # develop project'))
console.log(' $ coodev --dev')
console.log()
console.log(chalk.gray(' # start local server'))
console.log(' $ coodev --start')
console.log()
});
其中version和我原来的方式差不多,版本号就直接引用package.json,自己觉得预设的命令就用option定义(简写,全名,描述),简写和全名是调用的时候用的,描述是在输入命令'--help'的时候会自动抓取的。最后的‘on’,就像是jquery中的事件绑定一样,给命令追加额外的处理逻辑。
这里只是一些常用的,我后期还要加上一些交互性质的参数处理,比如引导用户配置工程等等,虽然原来自己写的也能满足目前的需求,但为了后期的功能,还是先改成‘commander’好一些。
二、按需拉取github上的模板
这事我最想学习的功能。用过vue-cli的朋友都知道有一个这样的命令 $ vue init webpack-simple yourproject-name 的初始化命令,他会作为几个脚手架给我们初始化模板,那么模板都放哪了?如果放在vue-cli里面,随着后期维护,就会越来越大,这不就毁了吗。我看了一下官方的描述说模板放在了另一个git仓库里,我也在github里找到了。我起初的时候为了独立维护模板,也是这样做的放在了别处,每次coodev发布时,用脚本同步过来,但我的方式虽然快,但是也就是现在模板数少还可以。因此我打算按需要拉取模板。
这个功能无疑是在vue-init文件里面,我发现有一个 var download = require('download-git-repo') ,在npm上查了一下,描述是这样“从节点下载并提取一个git存储库”,那么应该就是它了。
我的模板放在了github上的另一个仓库,https://github.com/grARM/coodev-temp-normal。现在想拉到coodev中只需要调用如下代码:
/** get code from github */
var loadNormalTmpl = function(cb){
download('grARM/coodev-temp-normal', proPath, function (err) {
if(err){
console.log('err', err);
}
cb && cb(err);
});
}
其中proPath是我的工程目录,这样就比我之前的递归文件拷贝高端了不少。
三、交互式命令
既然可以从别处拉模板,那么我的coodev一下子就可以精简很多,我以后可以拥有一大堆模板,都放在github上,我想拉哪一个,就拉哪一个。我还需要给用户提供交互式的命令。在vue-init中也是有这个例子的。 var inquirer = require('inquirer')
'inquirer'是一个提供交互式命令的npm包,地址: https://www.npmjs.com/package/inquirer。这个库在Github的examples文件夹里有详细的例子。每一个问答都会被封装到answers里。
inquirer.prompt([{
type: 'list',
message: 'which template do you need:',
name: 'template',
choices: ['normal', 'wap', 'h5']
}]).then(function (answers) {
console.log(answers)
done();
})
如图:

总结:
就这样,我就在vue-cli中学习了3招:命令管理、按需拉取模板、交互式命令。
接下来就是处理不同的主流后端模板引擎的支持了。
我想写一个前端开发工具(三):优化!从vue-cli学了几招的更多相关文章
- 我想写一个前端开发工具(一):在npm发布模块
有必要说说我为什么要开始写这个,正文从下面的第一条开始 我最近忙于公司的项目,一直没有抽出时间来写文章.本来想每个月写一片文章,保质保量,无奈上个月没有坚持. 这段时间有点忙,主要是由于公司业务调整, ...
- 超高速前端开发工具——Emmet
[由于 CSDN 不支持富文本编辑器写的文章迁移到 Markdown 编辑器中修改,已重发了一个重新排版的版本, 新版链接:http://blog.csdn.net/ys743276112/artic ...
- Web前端开发工具总结
前端开发工具: web前端开发乃及其它的相关开发, 推荐sublime text, webstorm(jetbrains公司系列产品)这两个的原因在于,有个技术叫emmet, http://docs. ...
- 动手写一个Remoting接口测试工具(附源码下载)
基于.NET开发分布式系统,经常用到Remoting技术.在测试驱动开发流行的今天,如果针对分布式系统中的每个Remoting接口的每个方法都要写详细的测试脚本,无疑非常浪费时间.所以,我想写一个能自 ...
- sublime 前端开发工具
http://code.kpman.cc/2014/10/14/sublime-text-3-mac-%E6%8C%87%E5%8D%97/ gif 屏幕录制:http://recordit.co/ ...
- 用 nodejs 写一个命令行工具 :创建 react 组件的命令行工具
用 nodejs 写一个命令行工具 :创建 react 组件的命令行工具 前言 上周,同事抱怨说 react 怎么不能像 angular 那样,使用命令行工具来生成一个组件.对呀,平时工作时,想要创建 ...
- 【翻译】我钟爱的Visual Studio前端开发工具/扩展
原文:[翻译]我钟爱的Visual Studio前端开发工具/扩展 怎么样让Visual Studio更好地编写HTML5, CSS3, JavaScript, jQuery,换句话说就是如何更好地做 ...
- 【前端开发工具】WijmoJS 2018 v3 正式发布,全面支持Angular7
WijmoJS(前端开发工具包)2018年度第三个大版本已经正式发布,本次更新除了全面支持Angular7之外,还允许用户使用Web Workers在前端更高效地导出PDF.智能的分组表头属性.全新的 ...
- 前端开发工具icestar
前端开发工具icestar 最近忙里偷闲,把之前的mock工具进行了全面的重构,最大的改变就是换了个名称icestar,icestar意思就是"爱死他",首先他的预想并不只是替代m ...
随机推荐
- mac通过wine运行windows程序(将文件关联到windows程序notepad++)
windows程序功能强大且已经习惯使用了,用mac总感觉不给力,例如记事本工具Notepad++就非常优秀.下面介绍如何在mac系统下通过wine来安装使用notepadd++程序. 1.安装win ...
- Windows下的代码注入
木马和病毒的好坏很大程度上取决于它的隐蔽性,木马和病毒本质上也是在执行程序代码,如果采用独立进程的方式需要考虑隐藏进程否则很容易被发现,在编写这类程序的时候可以考虑将代码注入到其他进程中,借用其他进程 ...
- Css3新增背景属性
1.background-origin 背景的起始位置 background-origin: border-box || padding-box || content-box; 案例初始化: 代码: ...
- COGS 有标号的二分图计数系列
其实这三道题都是不错的……(虽然感觉第三题略套路了……) 分别写一下做法好了…… COGS2392 有标号的二分图计数 I 这个就很简单了,Noip难度. 显然可以直接认为黑点和白点分别位于二分图两侧 ...
- 文字编辑器FCKeditor 简介以及基本配置和使用方法
什么是FCKeditor FCKeditor是一个专门使用在网页上属于开放源代码的所见即所得文字编辑器.它志于轻量化,不需要太复杂的安装步骤即可使用.它可和PHP.JavaScript.ASP.ASP ...
- MongoDB 创建集合
createCollection() 方法 MongoDB db.createCollection(name, options) 是用来创建集合. 语法: 基本的 createCollection() ...
- Office - InfoPath
1. 移除隐藏空间后剩余的空白: http://social.technet.microsoft.com/Forums/sharepoint/zh-TW/3dea3014-f808-428b-b283 ...
- vue中全局引入bootstrap.css
1.首先在官网上下载bootstrap的压缩包(必须是官网上下载的) 将压缩包解压后引入在项目文件夹下面.如下图所示: 2.在main.js中引入 import './assets/bootstrap ...
- 【阿里云产品公测】ACE下上传文件永久存储实践
本帖主要内容: ;$,=VB:' 在阿里云的ACE下,我是如何实现让上传的文件永久保存的? ,%"!8T 本文以PHP为例,具体知识点如下: WD# 96V 第一,扩展服务“存储 ...
- JavaScript & jQuery Code Snippet
1. 按照每个object的Name属性对object对象集合进行排序: //sort a collection of objects by Name property function sortBy ...