如何自己搭一個腳手架

jlanglang 發布于2019-08-23 13:08 / 1792人閱讀

摘要：二賬號注冊賬號登錄添加用戶信息到注冊表主體內容寫代碼準備工作做齊了，開始打開終端，初始化項目這個是一個簡單的腳手架張鑫這個是一個簡單的腳手架張鑫項目的結構就基本出來了。

前言

做前端也有三四年了，自己帶了個五人前端小團隊，第一次寫腳手架，也是第一次寫分享文章。文筆太差，勿噴、勿噴、勿噴    
每次人肉搬運代碼的時候，就想自己能不能給團隊做一個跟vue-cli一樣的腳手架？想了很久，苦于各種原因一直沒有實施。
正好最近不忙，此時不搞，更待何時！開搞，網上查文檔，gitHub扒vue-cli的源碼，坑哧吭哧的搗鼓了兩天……成了。拿出來分享一下吧。

準備工作 一、gitHub新建組織和倉庫

這個不難，一張圖概括，按照提示步驟填寫信息就好了。如下圖，我創建了一個叫template-organization的組織。

組織創建完之后，就可以在template-organization這個組織下創建新的倉庫demo-template

重點來了，https://api.github.com/users/...,獲取template-organization這個組織下的所有倉庫信息。

二、npm賬號

** 注冊賬號：** 
    [https://www.npmjs.com/][2]
** 登錄： ** 
    npm login
** 添加用戶信息到注冊表 ** 
    npm adduser

主體內容 寫代碼

準備工作做齊了，開始coding……

 打開終端，初始化項目

$ `mkdir edu-test-cli`
$ `cd edu-test-cli/`
$ `npm init`
This utility will walk you through creating a package.json file.
It only covers the most common items, and tries to guess sensible defaults.

See `npm help json` for definitive documentation on these fields
and exactly what they do.

Use `npm install ` afterwards to install a package and
save it as a dependency in the package.json file.

Press ^C at any time to quit.
package name: (edu-test-cli) 
version: (1.0.0) 
description: 這個是一個簡單的腳手架
entry point: (index.js) 
test command: 
git repository: 
keywords: cli edu zhx
author: 張鑫
license: (ISC) MIT
About to write to /Users/zhangxin/study/edu-test-cli/package.json:

{
  "name": "edu-test-cli",
  "version": "1.0.0",
  "description": "這個是一個簡單的腳手架",
  "main": "index.js",
  "scripts": {
    "test": "echo "Error: no test specified" && exit 1"
  },
  "keywords": [
    "cli",
    "edu",
    "zhx"
  ],
  "author": "張鑫",
  "license": "MIT"
}


Is this ok? (yes) yes

項目的package.json結構就基本出來了。

 加入依賴的包

npm i chalk commander download-git-repo inquirer ora request --save

 修改package.json中配置，如下

{
  "name": "edu-test-cli",
  "version": "1.0.0",
  "description": "這個是一個簡單的腳手架",
  "preferGlobal": true,
  "bin": {
    "edu": "bin/edu"
  },
  "dependencies": {
    "chalk": "^1.1.3",
    "commander": "^2.9.0",
    "download-git-repo": "^1.1.0",
    "inquirer": "^6.2.0",
    "ora": "^3.0.0",
    "request": "^2.88.0"
  },
  "scripts": {
    "test": "echo "Error: no test specified" && exit 1"
  },
  "keywords": [
    "cli",
    "edu",
    "zhx"
  ],
  "author": "張鑫",
  "license": "MIT"
}

 項目結構，如下

>edu-test-cli
    |--bin
       |--edu
    |--lib
       |--list.js
       |--init.js
    |--package.json
    |--README.md

在bin目錄下新建 edu (沒有后綴),代碼如下

#!/usr/bin/env node
process.env.NODE_PATH = __dirname + "/../node_modules/"

const program = require("commander")

program
  .version(require("../package.json").version)
  .usage(" [options]")
program
  .command("list")
  .description("查看所有的模版")
  .alias("l")
  .action(() => {
    require("../lib/list")()
  })
program
  .command("init")
  .description("生成一個新項目")
  .alias("i")
  .action(() => {
    require("../lib/init")()
  })
program
  .parse(process.argv)

if(!program.args.length){
  program.help()
}

lib目錄下 init.js，代碼如下

const ora = require("ora")
const inquirer = require("inquirer")
const chalk = require("chalk")
const request = require("request")
const download = require("download-git-repo")

module.exports = () => {
  request({
    url: "https://api.github.com/users/template-organization/repos",
    headers: {
      "User-Agent": "edu-test-cli"
    }
  }, (err, res, body) =>{
    if (err) {
      console.log(chalk.red("查詢模版列表失敗"))
      console.log(chalk.red(err))
      process.exit();
    }

    const requestBody = JSON.parse(body)
    if (Array.isArray(requestBody)) {
      let tplNames = [];
      requestBody.forEach(repo => {
        tplNames.push(repo.name);
      })

      let promptList = [
        {
          type: "list",
          message: "請選擇模版",
          name: "tplName",
          choices: tplNames
        },
        {
          type: "input",
          message: "請輸入項目名字",
          name: "projectName",
          validate (val) {
            if (val !== "") {
              return true
            }
            return "項目名稱不能為空"
          }
        }
      ]
      inquirer.prompt(promptList).then(answers => {

        let ind = requestBody.find(function (ele) {
          return answers.tplName == ele.name;
        });
        let gitUrl = `${ind.full_name}#${ind.default_branch}`,
          defaultUrl = "./",
          projectUrl = `${defaultUrl}/${answers.projectName}`,
          spinner = ora("
 開始生成項目，請等待...");
          spinner.start();
        download(gitUrl, projectUrl, (error)=>{
          spinner.stop();
          if (error) {
            console.log("模版下載失敗……")
            console.log(error)
            process.exit()
          }
          console.log(chalk.green(`
 √ ${answers.projectName} 項目生成完畢!`))
          console.log(`
 cd ${answers.projectName} && npm install 
`)
        })
      })
    } else {
      console.error(requestBody.message)
    }
  })
}

lib目錄下的 list.js，代碼如下：

const request = require("request");
const chalk = require("chalk")
const ora = require("ora")
module.exports = () => {
  let spinner = ora("
 " + chalk.yellow("正在查詢模版列表，請等待..."));
  spinner.start();
  request({
    url: "https://api.github.com/users/template-organization/repos",
    headers: {
      "User-Agent": "edu-test-cli"
    }
  }, (err, res, body) => {
    spinner.stop();
    if (err) {
      console.log(chalk.red("查詢模版列表失敗"))
      console.log(chalk.red(err))
      process.exit();
    }
    const requestBody = JSON.parse(body)
    if (Array.isArray(requestBody)) {
      console.log()
      console.log(chalk.green("可用的模版列表："))
      console.log()
      requestBody.forEach(repo => {
        console.log(
        "  " + chalk.yellow("★") +
        "  " + chalk.blue(repo.name) +
        " - " + repo.description)
      })
    } else {
      console.error(requestBody.message)
    }
  })
}

到這里這個簡單的腳手架就開發完了。代碼都在這里，是不是很簡單呢？

開發、測試、發布

 開發時，可使用以下命令查看效果

node bin/edu list   查看所有可用的模版
node bin/edu init   把模版下載下來，作為初始項目進行開發

測試時，如何使用全局的 edu list/init 的命令呢？

npm link    ///只能自己本地使用。

 開發、測試完成，發布

npm publish  ///將包發布到npm上，所有人都可以安裝使用。

例子：
edu-test-cli> $ npm publish
+ edu-test-cli@1.1.0

使用方法

 安裝

npm install -g edu-test-cli

 查看模版列表

$ edu list

可用的模版列表：

  ★  demo-template - 這是一個關于移動端適配方案的示例項目。

 創建項目

$ edu init
? 請選擇模版 (Use arrow keys)
? demo-template 
  
? 請輸入項目名字

結尾

終于寫完了。寫文章比寫代碼還累。。。。。。

GPU云服務器云服務器如何買vps然后自己搭如何搭自己的云服務器如何自己建一個網站如何給自己開一個網站

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/99233.html

如何構建大型的前端項目

摘要：如何構建大型的前端項目搭建好項目的腳手架一般新開發一個項目時，我們會首先搭建好一個腳手架，然后才會開始寫代碼。組件化一般分為項目內的組件化和項目外的組件化。如何構建大型的前端項目 1. 搭建好項目的腳手架一般新開發一個項目時，我們會首先搭建好一個腳手架，然后才會開始寫代碼。一般腳手架都應當有以下的幾個功能：自動化構建代碼，比如打包、壓縮、上傳等功能本地開發與調試，并有熱替換與...

lykops 2019-08-29 16:56 評論0 收藏0
如何構建大型的前端項目

摘要：如何構建大型的前端項目搭建好項目的腳手架一般新開發一個項目時，我們會首先搭建好一個腳手架，然后才會開始寫代碼。組件化一般分為項目內的組件化和項目外的組件化。如何構建大型的前端項目 1. 搭建好項目的腳手架一般新開發一個項目時，我們會首先搭建好一個腳手架，然后才會開始寫代碼。一般腳手架都應當有以下的幾個功能：自動化構建代碼，比如打包、壓縮、上傳等功能本地開發與調試，并有熱替換與...

plokmju88 2019-08-23 12:18 評論0 收藏0
ELSE 技術周刊(2017.11.20期)

摘要：業界動態發布重大更新，新版本建立在一個全新的的引擎之上，速度是個月前的兩倍。值得一提的是，該特性并未加到中，而是作為單獨依賴包。過濾繞過速查表本篇文章的主要目的是給專業安全測試人員提供一份跨站腳本漏洞檢測指南。預計閱讀時間分鐘。業界動態 Introducing the New Firefox: Firefox Quantum FireFox 發布重大更新，新版本建立在一個全新的的引擎...

mindwind 2019-08-21 17:42 評論0 收藏0
前端之從零開始系列

摘要：只有動手，你才能真的理解作者的構思的巧妙只有動手，你才能真正掌握一門技術持續更新中項目地址求求求源碼系列跟一起學如何寫函數庫中高級前端面試手寫代碼無敵秘籍如何用不到行代碼寫一款屬于自己的類庫原理講解實現一個對象遵循規范實戰手摸手，帶你用擼 Do it yourself!!! 只有動手，你才能真的理解作者的構思的巧妙只有動手，你才能真正掌握一門技術持續更新中…… 項目地址 https...

Youngdze 2019-08-26 10:57 評論0 收藏0
從 0 到 1 再到 100, 搭建、編寫、構建一個前端項目

摘要：從到再到搭建編寫構建一個前端項目選擇現成的項目模板還是自己搭建項目骨架搭建一個前端項目的方式有兩種選擇現成的項目模板自己搭建項目骨架。使用版本控制系統管理源代碼項目搭建好后，需要一個版本控制系統來管理源代碼。從 0 到 1 再到 100, 搭建、編寫、構建一個前端項目 1. 選擇現成的項目模板還是自己搭建項目骨架搭建一個前端項目的方式有兩種：選擇現成的項目模板、自己搭建項目骨架。 ...

call_me_R 2019-08-23 13:43 評論0 收藏0