如何實現(xiàn)一個簡單的Node.js腳手架

hizengzeng 發(fā)布于2019-08-21 17:53 / 538人閱讀

摘要：目標開發(fā)一個簡單的腳手架，能夠提供給用戶進行安裝。在腳手架中使用腳本。具體用法如下具體展示效果如下對用戶文件進行讀寫操作通過上面的步驟，我們已經(jīng)能夠完成一個簡單的腳手架了。

原因

在工作中，需要開發(fā)一個腳手架，用于給相關(guān)用戶提供相關(guān)的開發(fā)便利性。

適合人群

對前端、Node操作有一定的了解，同時向了解腳手架開發(fā)過程或者需要自己實現(xiàn)一個腳手架的開發(fā)者。

目標

開發(fā)一個簡單的腳手架，能夠提供給用戶進行安裝。

能夠輸出相關(guān)提示。

對用戶文件進行讀寫操作。

在腳手架中使用Shell腳本。

更多與用戶交互和文件操作等進階內(nèi)容可以查看同系列第二篇：如何實現(xiàn)一個腳手架進階版（Vue-cli v2.9學(xué)習(xí)篇）

步驟 開發(fā)腳手架

腳手架的開發(fā)最開始過程與普通的前端項目相同，需要一個入口文件command.js和配置文件package.json。

與其他配置文件不同的是，你需要在command.js文件第一行增加如下聲明：

#! /usr/bin/env node

同時需要在package.json文件中加上一下一項：

{
  ...,
  "bin": {
       "cm-cli": "command.js"
   }
}

在配置文件中增加了此項后，只需要在配置文件根目錄下執(zhí)行npm link命令，即可使用cm-cli --help命令來查看加載的cm-cli腳手架。

如果你發(fā)布了你的腳手架，那么在其他用戶使用命令npm install -g cm-cli之后，便可以在全局下使用你的腳手架了。

對用戶進行提示

在對注釋和命令進行提示中，我們需要使用到commander包，使用npm install commander即可進行安裝。（如果NPM版本低于5，則需要添加--save參數(shù)保證更新package.json配置文件）。

commander是一個提供用戶命令行輸入和參數(shù)解析的強大功能。有需要的可以閱讀相關(guān)的庫文檔。在這里我介紹兩個用的最多的方法。

option

能夠初始化自定義的參數(shù)對象，設(shè)置關(guān)鍵字和描述，同時還可以設(shè)置讀取用戶輸入的參數(shù)。具體用法如下：

const commander = require("commander");

commander.version("1.0.0")
    .option("-a, --aaa", "aaaaa")
    .option("-b, --bbb", "bbbbb")
    .option("-c, --ccc [name]", "ccccc")
    .parse(process.argv);


if (commander.aaa) {
    console.log("aaa");
}

if (commander.bbb) {
    console.log("bbb");
}

if (commander.ccc) {
    console.log("ccc", commander.ccc);
}

具體展示如下：

command

該方法能夠在命令行增加一個命令。用戶在執(zhí)行此命令后，能夠執(zhí)行回調(diào)中的邏輯。具體用法如下：

commander
    .command("init ")
    .description("init extension project")
    .action((extensionId) => {
        console.log(`init Extension Project "${extensionId}"`);
        // todo something you need
    });

具體展示效果如下：

對用戶文件進行讀寫操作

通過上面的步驟，我們已經(jīng)能夠完成一個簡單的腳手架了。下面，我們需要讀取用戶配置，同時為用戶生成一些模板文件。

讀取文件

現(xiàn)在，我們需要讀取用戶的cm-cli.json配置文件來進行一些配置。

我們可以使用Node.js的fs文件模塊來對文件進度讀操作，由于此處沒有太多難點，因此略去。

寫入文件模板

我們提前將模板文件存儲在CDN上，再根據(jù)本地讀取到的相關(guān)腳手架配置文件來進行模板的下載。

注：腳手架中讀取的路徑為使用者使用時當前路徑，因此沒有辦法將模板文件存儲在腳手架中進行讀取。

我們可以使用諸如request這種庫來幫助我們進行文件下載，簡化操作步驟。執(zhí)行npm install request`即可進行安裝。

注：在文件寫入時建議先判斷文件是否存在，再進行覆蓋。

使用Shell腳本

與Node.js提供的API函數(shù)來看，有些人更加傾向于使用Shell腳本來進行文件操作。幸運的是，我們也可以在我們的腳手架中引入node-cmd來啟用對Shell腳本的支持。執(zhí)行npm install node-cmd即可進行安裝。

具體示例如下：

commander
    .command("init ")
    .description("init extension project")
    .action((extensionId) => {
        id = extensionId;
        console.log(`init Extension Project "${extensionId}"`);

        cmd.get(
            `
            mkdir -p static/${extensionId}

            mkdir tmp
            mkdir tmp/source-file
            mkdir tmp/build-file
            curl -o tmp/source-file/index.js https://xxxxxxxx.com?filename=index.js
            touch tmp/source-file/index.css

            curl -o tmp/build-file/server.js https://xxxxxxxx.com?filename=server.js
            curl -o tmp/build-file/router.js https://xxxxxxxx.com?filename=router.js
            curl -o tmp/build-file/package.json https://xxxxxxxx.com?filename=package.json
            
            cp  tmp/source-file/* static/${extensionId}
            cp tmp/build-file/* ./
            rm -fr tmp
            npm install
            `,
            (err, data) => {
                console.log(data)
                if (!err) {
                    console.log("init success");
                    return;
                }

                console.error("init error");
            });
    });

我們可以快速的使用Shell腳本來進行文件夾的創(chuàng)建和文件模板的下載。

總結(jié)

腳手架想要在終端能夠快速執(zhí)行，可以在package.json配置文件中增加相關(guān)字段。

腳手架需要能夠讀取相關(guān)終端輸入，可以使用commander庫來快速開發(fā)。

腳手架需要能夠執(zhí)行Shell腳本，可以使用node-cmd庫來快速實現(xiàn)需求。

云服務(wù)器 GPU云服務(wù)器 js實現(xiàn)的簡單特效 node.js服務(wù)器如何部署到云上用c實現(xiàn)簡單的shell java實現(xiàn)簡單的web服務(wù)器

文章版權(quán)歸作者所有，未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請注明本文地址：http://systransis.cn/yun/90165.html

發(fā)表評論

登陸后可評論

0條評論

hizengzeng

男|高級講師

我要關(guān)注我要私信

TA的文章

tensorflow.contrib.layers

閱讀 2750·2023-04-25 22:15
第七屆電工專項如何進行焊接

閱讀 1816·2021-11-19 09:40
C語言中還有這些類型，別再說你不知道了！手把手帶你解鎖C語言中的自定義類型，讓你寫你所想。

閱讀 2161·2021-09-30 09:48
Aperture：$10.7/月/512MB內(nèi)存/4GB SSD空間/1TB流量/500Mbps端口

閱讀 3236·2021-09-03 10:36
ThomasHost：美國/法國/英國/加拿大KVM月付5美元起,支持Windows

閱讀 2037·2021-08-30 09:48
TMWhost：1核/2G/150G HDD/1T流量/200Mbps/澳門機房/季付$45

閱讀 1872·2021-08-24 10:00
《CSS世界》筆記一：流/元素/尺寸

閱讀 2739·2019-08-30 15:54
用純css實現(xiàn)Tab切換

閱讀 714·2019-08-30 15:54

成人国产在线小视频_日韩寡妇人妻调教在线播放_色成人www永久在线观看_2018国产精品久久_亚洲欧美高清在线30p_亚洲少妇综合一区_黄色在线播放国产_亚洲另类技巧小说校园_国产主播xx日韩_a级毛片在线免费

資訊專欄INFORMATION COLUMN

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺、長期優(yōu)惠，快來選購！

如何實現(xiàn)一個簡單的Node.js腳手架

相關(guān)文章

**如何實現(xiàn)一個腳手架進階版（Vue-cli v2.9學(xué)習(xí)篇）**

前端每周清單第 12 期：支付寶前端構(gòu)建工具發(fā)展、LinkedIn用Brotli加快網(wǎng)頁響應(yīng)速度、餓

**后端知識點總結(jié)——NODE.JS（高級）**

7月份前端資源分享

**開發(fā)一個 Parcel-vue 腳手架工具**

發(fā)表評論

0條評論

hizengzeng

男|高級講師

TA的文章

tensorflow.contrib.layers

第七屆電工專項如何進行焊接

C語言中還有這些類型，別再說你不知道了！手把手帶你解鎖C語言中的自定義類型，讓你寫你所想。

Aperture：$10.7/月/512MB內(nèi)存/4GB SSD空間/1TB流量/500Mbps端口

ThomasHost：美國/法國/英國/加拿大KVM月付5美元起,支持Windows

TMWhost：1核/2G/150G HDD/1T流量/200Mbps/澳門機房/季付$45

《CSS世界》筆記一：流/元素/尺寸

用純css實現(xiàn)Tab切換

最新活動

資訊專欄INFORMATION COLUMN

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺、長期優(yōu)惠，快來選購！

如何實現(xiàn)一個簡單的Node.js腳手架

相關(guān)文章

發(fā)表評論

0條評論

男|高級講師

TA的文章

最新活動

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺、長期優(yōu)惠，快來選購！