Create?vite理解Vite項(xiàng)目創(chuàng)建流程及代碼實(shí)現(xiàn)

更新時(shí)間：2022年10月27日 14:25:31 作者：Harexs

這篇文章主要為大家介紹了Create?vite理解Vite項(xiàng)目創(chuàng)建流程及代碼實(shí)現(xiàn)，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

前言

繼上次閱讀create-vue后，本次接著來(lái)解析 create-vite, 得益于之前的閱讀經(jīng)驗(yàn), 本篇筆記將會(huì)著重講解代碼執(zhí)行流程以及函數(shù)的擴(kuò)展

最新的 create-vite 已經(jīng)升級(jí)為T(mén)s編譯了，為方便學(xué)習(xí)理解使用川哥提供的源碼倉(cāng)庫(kù)

monorepo

Vite和Vue都使用monorepo的形式管理代碼，將原本多代碼倉(cāng)庫(kù)變?yōu)閱未a倉(cāng)庫(kù)，每一個(gè)包對(duì)應(yīng)的就是一個(gè)項(xiàng)目，這些項(xiàng)目都具有相關(guān)性，但在邏輯上是獨(dú)立的。

主流程

入口文件

vite2/packages/create-vite/index.js

主要結(jié)構(gòu)

import fs from 'node:fs'
import path from 'node:path'
//...
 async function init() {
//...
  try {
    result = await prompts(
      [
       //省略若干選項(xiàng)代碼
      ],
      {
        onCancel: () => {
          throw new Error(red('?') + ' Operation cancelled')
        }
      }
    )
  } catch (cancelled) {
    console.log(cancelled.message)
    return
  }
      //若干處理代碼
 }
 init().catch((e) => {
  console.error(e)
 })

index.js 核心就是執(zhí)行 init這個(gè)異步函數(shù)，通過(guò)選項(xiàng)式對(duì)話取到配置變量后執(zhí)行操作

擴(kuò)展插件

import minimist from 'minimist'
import prompts from 'prompts'
import {
  blue,
  cyan,
  green,
  lightRed,
  magenta,
  red,
  reset,
  yellow
} from 'kolorist'

minimist 用于獲取命令行參數(shù)，用于跳過(guò)后續(xù)一些選項(xiàng)式對(duì)話

prompts 提供了選項(xiàng)式對(duì)話的命令行工具

kolorist 用來(lái)在命令行輸出不同顏色的字符

模板配置

const FRAMEWORKS = [
  {
    name: 'vanilla',
    color: yellow,
    variants: [
      {
        name: 'vanilla',
        display: 'JavaScript',
        color: yellow
      },
      {
        name: 'vanilla-ts',
        display: 'TypeScript',
        color: blue
      }
    ]
  },
  //若干代碼
]
const TEMPLATES = FRAMEWORKS.map(
  (f) => (f.variants && f.variants.map((v) => v.name)) || [f.name]
).reduce((a, b) => a.concat(b), [])

TEMPLATES 主要用來(lái)根據(jù)定義好的配置對(duì)象生成對(duì)應(yīng)后續(xù)template用到的數(shù)組

getProjectName

const getProjectName = () =>
  //path.resolve() 默認(rèn)返回當(dāng)前目錄
  //path.basename(path.resolve())  對(duì)應(yīng)得到的就是 當(dāng)前目錄名
    targetDir === '.' ? path.basename(path.resolve()) : targetDir

用于獲取項(xiàng)目名，值得一提的是 path.resolve() 默認(rèn)返回命令執(zhí)行的目錄，path.basename(path.resolve()) 就是獲取當(dāng)前目錄名

formatTargetDir

function formatTargetDir(targetDir) {
  return targetDir?.trim().replace(/\/+$/g, '')
}

將文本去空，并將末尾的 /斜杠去掉

npm包名驗(yàn)證和轉(zhuǎn)化

function toValidPackageName(projectName) {
  return projectName
    .trim()
    .toLowerCase()
    .replace(/\s+/g, '-')
    .replace(/^[._]/, '')
    .replace(/[^a-z0-9-~]+/g, '-')
}
function isValidPackageName(projectName) {
  return /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/.test(
    projectName
  )
}

用于驗(yàn)證是否符合package.json name 的格式以及轉(zhuǎn)換函數(shù)

取得模板目錄

 const templateDir = path.resolve(
    fileURLToPath(import.meta.url),
    '..',
    `template-${template}`
  )

通過(guò)resolve 拼接目錄名，根據(jù)用戶的選擇會(huì)生成對(duì)應(yīng)的比如 template-vue-ts

得到npm包管理器相關(guān)信息

const pkgInfo = pkgFromUserAgent(process.env.npm_config_user_agent)
  const pkgManager = pkgInfo ? pkgInfo.name : 'npm'
  function pkgFromUserAgent(userAgent) {
  if (!userAgent) return undefined
  const pkgSpec = userAgent.split(' ')[0]
  const pkgSpecArr = pkgSpec.split('/')
  return {
    name: pkgSpecArr[0],
    version: pkgSpecArr[1]
  }
}

process.env.npm_config_user_agent 會(huì)返回類似這樣的字符:

npm/6.7.5 xxxx/xxx xxx ，函數(shù)就是取出第一部分然后切割字符，得到對(duì)應(yīng)的包管理器以及版本

文件操作相關(guān)的函數(shù)

write函數(shù) 寫(xiě)入文件

const write = (file, content) => {
  const targetPath = renameFiles[file]
    ? path.join(root, renameFiles[file])
    : path.join(root, file)
  if (content) {
    fs.writeFileSync(targetPath, content)
  } else {
    copy(path.join(templateDir, file), targetPath)
  }
}

targetPath先匹配.gitignore，否則直接使用參數(shù)的file值。然后根據(jù)是否傳遞了 content參數(shù)執(zhí)行寫(xiě)入和復(fù)制 template目錄下文件兩個(gè)操作

copy函數(shù) 復(fù)制文件

function copy(src, dest) {
  const stat = fs.statSync(src)
  if (stat.isDirectory()) {
    copyDir(src, dest)
  } else {
    fs.copyFileSync(src, dest)
  }
}

判斷文件信息，目錄則執(zhí)行 copyDir函數(shù)，否則調(diào)用 fs 下的 copyFileSync

copyDir 復(fù)制目錄

function copyDir(srcDir, destDir) {
  fs.mkdirSync(destDir, { recursive: true })
  for (const file of fs.readdirSync(srcDir)) {
    const srcFile = path.resolve(srcDir, file)
    const destFile = path.resolve(destDir, file)
    copy(srcFile, destFile)
  }
}

創(chuàng)建目標(biāo)文件夾，然后遍歷源文件夾依次將文件 copy過(guò)去

emptyDir 清空目錄

function emptyDir(dir) {
  if (!fs.existsSync(dir)) {
    return
  }
  for (const file of fs.readdirSync(dir)) {
    fs.rmSync(path.resolve(dir, file), { recursive: true, force: true })
  }
}

將目錄變?yōu)榭漳夸洝Ｏ扰袛嗄夸浭欠翊嬖冢?再遍歷執(zhí)行刪除操作

isEmpty 判斷目錄為空

function isEmpty(path) {
  const files = fs.readdirSync(path)
  return files.length === 0 || (files.length === 1 && files[0] === '.git')
}

通過(guò)fs.readdirSync 得到目錄返回的數(shù)組長(zhǎng)度進(jìn)行判斷

核心代碼

const { framework, overwrite, packageName, variant } = result
  const root = path.join(cwd, targetDir)
//檢查是否可寫(xiě)入
  if (overwrite) {
    emptyDir(root)
  } else if (!fs.existsSync(root)) {
    fs.mkdirSync(root, { recursive: true })
  }
  // determine template
  template = variant || framework || template
  console.log(`\nScaffolding project in ${root}...`)
//得到模板目錄
  const templateDir = path.resolve(
    fileURLToPath(import.meta.url),
    '..',
    `template-${template}`
  )
  const write = (file, content) => {
   //寫(xiě)文件函數(shù)
  }
  const files = fs.readdirSync(templateDir) //得到模板目錄下文件信息
  //將默認(rèn)目錄中非package.json 的文件 復(fù)制到 templateDir中
  for (const file of files.filter((f) => f !== 'package.json')) {
    write(file) //不傳 content 執(zhí)行 copy操作
  }
//得到模板目錄中的 package.json內(nèi)容
  const pkg = JSON.parse(
    fs.readFileSync(path.join(templateDir, `package.json`), 'utf-8')
  )
  pkg.name = packageName || getProjectName()
// 修改name 后 寫(xiě)入 package.json 到 templateDir中中
  write('package.json', JSON.stringify(pkg, null, 2))
//得到對(duì)應(yīng)包管理器的 信息 然后回顯
  const pkgInfo = pkgFromUserAgent(process.env.npm_config_user_agent)
  const pkgManager = pkgInfo ? pkgInfo.name : 'npm'
  console.log(`\nDone. Now run:\n`)
  if (root !== cwd) {
    console.log(`  cd ${path.relative(cwd, root)}`)
  }
  switch (pkgManager) {
    case 'yarn':
      console.log('  yarn')
      console.log('  yarn dev')
      break
    default:
      console.log(`  ${pkgManager} install`)
      console.log(`  ${pkgManager} run dev`)
      break
  }
  console.log()

這一步總體流程如下：

檢查目錄是否可寫(xiě)入
得到對(duì)應(yīng)的模板目錄
寫(xiě)入模板目錄的文件到用戶的目錄中
取得包管理器信息回返顯示提示信息

總結(jié)

path.resolve 是相對(duì)于當(dāng)前工作目錄返回路徑

path.join 是根據(jù)path字符串片段拼接返回一個(gè)路徑需要注意區(qū)別

至此代碼和流程就分析完畢了，相對(duì)于create-vue, create-vite要簡(jiǎn)單一點(diǎn)點(diǎn)

對(duì)于不懂或者不了解的地方，復(fù)現(xiàn)或者嘗試重寫(xiě)進(jìn)行舉一反三是加深認(rèn)知和學(xué)習(xí) 更好的方式，光是看和閱讀領(lǐng)悟還是不夠的！

寫(xiě)了個(gè)練習(xí)用的小工具，可以用來(lái)快捷的生成Vue模板頁(yè)面

create-harexs-tp

以上就是Create vite理解Vite項(xiàng)目創(chuàng)建流程及代碼實(shí)現(xiàn)的詳細(xì)內(nèi)容，更多關(guān)于Create vite 項(xiàng)目創(chuàng)建流程的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: