快捷導(dǎo)航

利用node.js實(shí)現(xiàn)自動(dòng)生成前端項(xiàng)目組件的方法詳解

更新時(shí)間：2017年07月12日 11:27:19 作者：bleach

最近在學(xué)習(xí)用，基于nodejs的強(qiáng)大，我從原本的只寫(xiě)前端變成了寫(xiě)全棧。下面這篇文章主要給大家介紹了關(guān)于利用node.js實(shí)現(xiàn)自動(dòng)生成前端項(xiàng)目組件的相關(guān)資料，文中通過(guò)示例代碼介紹的非常詳細(xì)，需要的朋友們下面來(lái)一起看看吧。

本文主要給大家介紹了關(guān)于利用node.js實(shí)現(xiàn)自動(dòng)生成前端項(xiàng)目組件的相關(guān)內(nèi)容，分享出來(lái)供大家參考學(xué)習(xí)，下面話不多說(shuō)了，來(lái)一起看看詳細(xì)的介紹：

腳本編寫(xiě)背景

寫(xiě)這個(gè)小腳本的初衷是，項(xiàng)目本身添加一個(gè)組件太繁瑣了，比如我想要去建立一個(gè)login的組件，那么我需要手動(dòng)去IDE中，創(chuàng)建index.js(組件出口文件)，login.js(業(yè)務(wù)文件)，login.html，login.less這四個(gè)文件。因?yàn)槊總€(gè)組件都有一些輸出的代碼，還要把之前組件的那幾行拷貝過(guò)來(lái)，這種作業(yè)真的煩，于是乎寫(xiě)了一個(gè)小腳本去自動(dòng)完成這些功能。

PS:本腳本運(yùn)行環(huán)境是nodeV7以上，當(dāng)前時(shí)間2017/07，stable版本還是V6，最新的node版本為V8.1.3（LTS版本），如要運(yùn)行，請(qǐng)升級(jí)node版本為L(zhǎng)TS版本。

預(yù)期效果

在命令行輸入：node set login

在conponents文件夾下面自動(dòng)生成4個(gè)文件，并填寫(xiě)index.js , login.js的文件公共內(nèi)容。

如果輸入多層文件如： node set login/foo

則會(huì)先檢測(cè)conponents文件夾下是否存在login，如不存在，先創(chuàng)建login文件夾，然后創(chuàng)建foo的組件。本腳本主要使用nodejs的fs模塊來(lái)完成需求。

fs模塊
fs模塊用于對(duì)系統(tǒng)文件及目錄進(jìn)行讀寫(xiě)操作，本次主要用到的fs模塊的功能有：

fs.existsSync(path) 檢測(cè)文件夾是否存在，一個(gè)同步的API，只接受一個(gè)路徑參數(shù)，當(dāng)前版本異步的廢棄了。
fs.mkdir(path,callback) 創(chuàng)建文件夾，異步，兩個(gè)必填參數(shù)，路徑和回掉。
fs.readFileSync(path) 讀取文件，接受一個(gè)參數(shù)，文件路徑。
fs.writeFile(path,data,callback) 寫(xiě)文件，接受三個(gè)參數(shù)，文件路徑，向文件中寫(xiě)的數(shù)據(jù)，回掉。

代碼實(shí)施

流程圖

async function creatCpt() {
 try {
  await exists(); // 檢測(cè)文件夾
  await readFile(); // 讀取模板內(nèi)容
  await writeFile(await readFile()); //寫(xiě)入組件
 }
 catch (err) {
  console.error(err);
 }
}

獲取命令行參數(shù)

以node set login為例，想要?jiǎng)?chuàng)建一個(gè)login文件夾，首先先要獲取命令行當(dāng)中的login。在nodejs當(dāng)中，獲取命令行參數(shù)使用process.argv這條命令返回一個(gè)數(shù)組，第一個(gè)參數(shù)為nodejs.exe的應(yīng)用所在絕對(duì)路徑，第二個(gè)參數(shù)為當(dāng)前腳本所在的絕對(duì)路徑，之后所輸入的參數(shù)以空格分隔，如輸入node set aaa,得到：

檢測(cè)文件夾是否存在

let exists = function () {
 return new Promise((res) => {
  (async function () {
   for (let a of path) {
    fs.existsSync(basepath + a) ? basepath = `${basepath}${a}/` : await mkdir(a);
   }
   res(basepath);
  })()
 })
}

判斷是否存在文件夾，如果存在，重新拼接路徑繼續(xù)檢查，如不存在則生成文件夾。

創(chuàng)建文件夾

node set foo/bar

let mkdir = function (a) {
 return new Promise((res, rej) => {
  fs.mkdir(basepath + a, (err) => {
   if (err) rej(err);
   basepath = `${basepath}${a}/`
   res(basepath);
  });
 })
}

創(chuàng)建文件夾成功后，重新拼接路徑，以便于繼續(xù)查找。

讀取模板內(nèi)容

let reads = [`${basepath}cptTemp/index.js`, `${basepath}cptTemp/cptTemp.js`];//要讀取的文件

let readFile = function () {
 return new Promise((res) => {
  for (let a of reads) {
   let text = fs.readFileSync(a).toString();
   text = text.replace(/time/g, moment().format('YYYY/MM/DD'))
    .replace(/temp/g, name);
   file.push(text)
  }
  res(file);
 })
}

每個(gè)生成好的文件都需要一個(gè)創(chuàng)建的時(shí)間，及作者，包括文件的輸出，以及class等結(jié)構(gòu)，這些都是比較公用的，把他們寫(xiě)在模板當(dāng)中，然后讀取出來(lái)，替換其中的關(guān)鍵詞，如時(shí)間，組件名等。

生成文件并寫(xiě)入內(nèi)容

提前建立好要生成的文件和要讀取的文件。如：

let writes = [`${name}.js`, `${name}.html`, `${name}.less`, `index.js`];

let writeFile = function (file) {
 return new Promise((res, rej) => {
  (async function () {
   for (let a of writes) {
    await fs.writeFile(`${basepath}${a}`,
     a == writes[3] ? file[0] : a == writes[0] ? file[1] : '', (err) => {
      if (err) rej(err)
     })
   }
   res('succ');
  })()
 })
}