开发一个前端项目初始化的CLI

场景

搭建环境是开发工作的第一步,但是根据项目不同,虽然可能有些大同小异的改变,但是在项目之间,项目本身的模块之间有很多共性的东西,把这些东西提取出来不但是工(tou)程(lan)化的需求,也是一个总体把握工程的反思。

cli

cli - command-line interface 也就是命令行命令,如果没接触过cmd或者linux的terminal的话,理解成用文本命令来控制的计算机的即可。

准备

  • nodejs 版本随意,es6看你心情
  • 假设任务如下
    某实际项目初始化的时候需要两个参数:名称、ID
    输入后其他参数根据该参数进行生成,我们的任务是创建一个脚本,接受这两个参数,再加一个生成的路径,执行cli后可以生成一个web项目。

目标

  • 设计工作目录
  • 引入需要的文件
  • 创建脚手架

实现

  • 设计一个工作目录的文件夹结构
[project-name]
- html 
- icons
- js
- css
manifest.json
  • 安装fs-extra
cmd执行: npm install --save fs-extra //安装一个fs的扩展包,方便开发
  • 创建一个脚本文件起名Generator.js
module.exports = class Generator{
  constructor(){
    this.name = "default";  //项目名称
    this.path = ""; //创建的路径
    this.id   = 0; //项目需要参数(ID为例)
    this.files  = [
      '',
      'html',
      'icons',
      'js',
      'css'
    ]; //创建的文件夹
  }
  setName(name){
    this.name = name;
  };
  getName(name){
    return this.name;
  };
  ... //其他get和set方法略
}
  • 添加创建文件夹的功能
addfolder(){
    let __self = this;
    __self.files.forEach(function(value, index, array) {
      fs.ensureDirSync(__self.filepath + "/" + value);
      //翻翻上面,`this.files`中作者偷了个懒
    });
}
  • 引入不需要设置的静态资源文件
constructor(){
  ...
  this.js = [
      'aaa.js',
      'jquery-3.2.1.min.js',
      'bbb.js'
    ]
  ...
  addfiles(){
    ...
    __self.js.forEach(function(value,index,array){
      fs.copySync(global.enter + '/resource/'+value, filepath + "/js/"+value);
    });
    ...
  }
}
  • 引入自定义文件(json为例)
    我的做法是先创建一个default.json然后读到程序中,根据传入的参数进行替换,生成所需的json
constructor(){
  this.defaultJSON = require(global.enter + '/resource/defaultmanifest.json');
  //global.enter是因为我使用了electron所以用了一个global变量,自己写的时候按需修改即可
}
...
setJson(){
  let __self = this;
    __self.defaultJSON.appId = __self.id; 
}
...

最后

cmd执行: node Generator.js 

你会得到:

image.png

好处

  • 以后不用再配置了,两秒新建一个工程,比如reset.css什么的引用,大家自由发挥
  • 再也不怕配的乱七八糟,项目里一卡车的冗余文件了

鸽...

  • 如何命令行接受参数
  • 如何在electron中使用
附赠代码,不保证能运行
//Generator.js
const fs = require('fs-extra');

module.exports = class Project{
  constructor(){
    this.defaultJSON = require(global.enter + '/resource/defaultmanifest.json');
    this.name = "default";
    this.path = "";
    this.id   = 0;
    this.files  = [
      '',
      'html',
      'icons',
      'js',
      'css'
    ];
    this.js = [
      'ccc.js',
      'jquery-3.2.1.min.js',
      'aaa.js'
    ]
  };
  setName(name){
    this.name = name;
  };
  getName(name){
    return this.name;
  };
  setPath(path){
    this.path = path;
  };
  getPath(){
    return this.path;
  };
  setID(id){
    this.id = id;
  }
  setJson(){
    let __self = this;
    __self.defaultJSON.appId            = __self.id;
    __self.defaultJSON.appName          = "" + __self.name;
  };
  newProject(name,path,id){
    this.init(name,path,id);
    let __self   = this;
    let filepath = __self.path  + "/" + __self.name ;

    __self.files.forEach(function(value, index, array) {
      fs.ensureDirSync(filepath + "/" + value);
    });

    fs.writeJsonSync( filepath +'/manifest.json', __self.defaultJSON);

    __self.js.forEach(function(value,index,array){
      fs.copySync(global.enter + '/resource/'+value, filepath + "/js/"+value);
    });
  };
  init(name,path,id){
    this.setName(name);
    this.setPath(path);
    this.setID(id);
    this.setJson();
  }
}

转载请注明出处

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

推荐阅读更多精彩内容