摸魚心法第一章——和配置文件說拜拜
為了能摸魚我們團隊做了容器化，但是帶來的問題是服務配置文件很麻煩，然后大家在群里進行了“親切友好”的溝通圖片圖片圖片圖片對比就對比，簡單對比下獨立配置中心和k8s作為配
Babel是一個比較龐大的項目，其子工程就有至少140個(如 babel/plugins/presets/lerna/babel-loader等)，產出的子工具已經是前端開發的基礎設施，對開發效率、代碼質量等有非常高的要求。
在本文中，我們將了解Babel是怎樣進行項目管理的。
圖片
本文從工程管理、代碼管理、文檔管理、質量管理四個方面對Babel項目管理進行拆解分析。
Babel是典型的monorepo項目，即單倉庫項目，所有的子模塊在同一個倉庫里。Babel目前有140+個子模塊，在工程管理部分，需要解決以下問題：
工程管理部分主要使用lerna、yarn等工具。
Babel是多人協作開發的開源項目，如何保證代碼風格一致，Babel使用的是社區常見的解決方案。
該模塊主要使用eslint、prettier等工具。
Babel的迭代速度很快、涉及的模塊很多，該模塊解決版本發布后如何自動更新相關文檔等問題。
該模塊主要使用lerna等工具。
Babel的產品是前端開發的基礎設施，該模塊主要保證Babel的產出是高質量的。
該模塊主要使用jest、git blame等工具。
Babel使用monorepo模式進行工程管理。
monorepo(monolithic repository)，指的是單倉庫代碼，將多個項目代碼存儲在一個倉庫里。另外有一種模式是multirepo，指的是多倉庫代碼(one-repository-per-module)，不同的項目分布在不同的倉庫里。React、Babel、Jest、Vue、Angular均采用monorepo進行項目管理。
典型的monorepo結構是：
├── packages| ├── pkg1| | ├── package.json| ├── pkg2| | ├── package.json├── package.json這是Babel源碼的目錄結構：
├─ lerna.json├─ package.json└─ packages/ # 這里將存放所有子項目目錄 ├─ README.md ├─ babel-cli ├─ babel-code-frame ├─ babel-compat-data ├─ babel-core ├─ babel-generator ├─ babel-helper-annotate-as-pure ├─ babel-helper-builder-binary-assignment-operator-visitor ├─ babel-helper-builder-react-jsx ├─ ...而rollup則采取了multirepo的模式：
├─ rollup ├─ package.json ├─ ...├─ plugins ├─ package.json ├─ ...├─ awesome ├─ package.json ├─ ...├─ rollup-starter-lib ├─ package.json ├─ ...├─ rollup-plugin-babel ├─ package.json ├─ ...├─ rollup-plugin-commonjs ├─ package.json ├─ ...multirepo和monorepo是兩種不同的理念。
multirepo允許多元化發展，每個模塊獨立實現自己的構建、單元測試、依賴管理等。monorepo抹平了模塊間的很多差異，通過集中管理和高度集成化的工具，減少開發和溝通時的成本。monorepo最大的問題可能就是不能管理占用空間太大的項目了。
所以，還是要根據項目的實際需求出發選擇用哪種項目管理模式。
lerna是基于git/npm/yarn等的工作流提效工具，用于維護monorepo。它是Babel 開發過程中提升開發效率產出的工具。
lerna本身也是一個monorepo的項目，并且，lerna為monorepo項目提供了如下支持:
lerna提供了一系列命令用于monorepo項目初始化、添加子項目、查看項目信息等。
lerna支持為monorepo項目統一管理公共依賴、自動安裝各個子項目的依賴、自動創建子模塊符號鏈接等。
lerna可以根據項目代碼的變動情況，發現影響的子項目范圍，在發布時提供語義化版本推薦等，極大提升了monorepo項目的版本管理效率。
lerna官網有對各種命令各種用法的詳細介紹，這些命令可以分為：項目管理、依賴管理、版本管理三大類。
圖片
lerna有一批通用參數，所有子命令均可以使用。
--concurrency
當lerna將任務并行執行時，需要使用多少線程(默認為邏輯CPU內核數)。
lerna publish --concurrency 1--loglevel<silent|error|warn|success|info|verbose|silly>
要報告什么級別的日志。如果失敗，所有日志都寫到當前工作目錄中的lerna-debug.log中。
任何高于該設置的日志都會顯示出來。默認值是"info"。
--max-buffer<bytes>
為每個底層進程調用設置的最大緩沖區長度。例如，當有人希望在運行lerna import的同時導入包含大量提交的倉庫時，就是它出場的時候了。在這種情況下，內置的緩沖區長度可能不夠。
--no-progress
禁用進度條。在CLI環境中總是這樣。
--no-sort
默認情況下，所有任務都按照拓撲排序的順序在包上執行，以尊重所討論的包的依賴關系。在不保證lerna調用一致的情況下，以最努力的方式打破循環。
如果只有少量的包有許多依賴項，或者某些包執行的時間長得不成比例，拓撲排序可能會導致并發瓶頸。--no-sort配置項禁用排序，而是以最大并發的任意順序執行任務。
如果您運行多個watch命令，該配置項也會有所幫助。因為lerna run將按照拓撲排序的順序執行命令，所以在繼續執行之前可能會等待某個命令。當您運行"watch"命令時會阻塞執行，因為他們通常不會結束。
--reject-cycles
如果（在bootstrap、exec、publish或run中）發現循環，則立即失敗。
lerna bootstrap --reject-cycles只包含名稱與給定通配符匹配的包。
lerna exec --scope my-component -- ls -la lerna run --scope toolbar-* test lerna run --scope package-1 --scope *-2 lint排除名稱與給定通配符匹配的包。
lerna exec --ignore package-{1,2,5} -- ls -la lerna run --ignore package-1 test lerna run --ignore package-@(1|2) --ignore package-3 lint排除私有的包。默認情況下是包含它們的。
只包含自指定ref以來已經改變的包。如果沒有傳遞ref，它默認為最近的標記。
# 列出自最新標記以來發生變化的包的內容 $ lerna exec --since -- ls -la # 為自“master”以來所有發生更改的包運行測試 $ lerna run test --since master # 列出自“某個分支”以來發生變化的所有包 $ lerna ls --since some-branch在CI中使用時，如果您可以獲得PR將要進入的目標分支，那么它將特別有用，因為您可以將其作為--since配置項的ref。這對于進入master和feature分支的PR來說很有效。
當使用--since運行命令時，排除所有傳遞的被依賴項，覆蓋默認的“changed”算法。
如果沒有--since該參數時無效的，會拋出錯誤。
在運行命令時包括所有傳遞的被依賴項，無視--scope、--ignore或--since。
在運行命令時包括所有傳遞依賴項，無視--scope、--ignore或--since。
與接受--scope(bootstrap、clean、ls、run、exec)的任何命令組合使用。確保對任何作用域的包（通過--scope或--ignore）的所有依賴項（和dev依賴項）也進行操作。
注意：這將會覆蓋--scope和--ignore。
例如，如果一個匹配了--ignore的包被另一個正在引導的包所以來，那么它仍會照常工作。
當您想要“設置”一個依賴于其他正在設置的包其中的一個包時，這是非常有用的。
lerna bootstrap --scope my-component --include-dependencies # my-component 及其所有依賴項將被引導lerna bootstrap --scope "package-*" --ignore "package-util-*" --include-dependencies # 所有匹配 "package-util-*" 的包將被忽略，除非它們依賴于名稱匹配 "package-*" 的包lerna exec --since --include-merged-tags -- ls -la在使用--since命令時，它包含來自合并分支的標記。這只有在從feature分支進行大量發布時才有用，通常情況下不推薦這樣做。
以下是lerna的主要目錄結構（省略了一些文件和文件夾）：
lerna├─ CHANGELOG.md -- 更新日志├─ README.md -- 文檔├─ commands -- 核心子模塊├─ core -- 核心子模塊├─ utils -- 核心子模塊├─ lerna.json -- lerna 配置文件├─ package-lock.json -- 依賴聲明├─ package.json -- 依賴聲明├─ scripts -- 內置腳本└─ yarn.lock -- 依賴聲明有趣的是，lerna本身也是用lerna進行開發管理的。它是一個monorepo項目，其各個子項目分布在lerna/commands/*、core/*、utils/*目錄下。
另外，在源碼中，經常會看到名稱為@lerna/command的子項目，如lerna/core/lerna/index.js的內容是：
const cli = require("@lerna/cli");const addCmd = require("@lerna/add/command");const bootstrapCmd = require("@lerna/bootstrap/command");const changedCmd = require("@lerna/changed/command");const cleanCmd = require("@lerna/clean/command");const createCmd = require("@lerna/create/command");const diffCmd = require("@lerna/diff/command");const execCmd = require("@lerna/exec/command");const importCmd = require("@lerna/import/command");const infoCmd = require("@lerna/info/command");const initCmd = require("@lerna/init/command");const linkCmd = require("@lerna/link/command");const listCmd = require("@lerna/list/command");const publishCmd = require("@lerna/publish/command");const runCmd = require("@lerna/run/command");const versionCmd = require("@lerna/version/command");這些子項目分布在lerna/commands/*、core/*、utils/*下，截至本文截稿時，lerna有61個子項目。
以下是各子項目分布：
圖片
lerna命令注冊工作集中在lerna/core/lerna/*路徑下。
lerna/core/lerna/package.json
該文件的bin字段定義了lerna命令：
"bin": { "lerna": "cli.js" }lerna/core/lerna/cli.js
該文件描述了命令行的執行入口：
#!/usr/bin/env node "use strict"; /* eslint-disable import/no-dynamic-require, global-require */ const importLocal = require("import-local"); if (importLocal(__filename)) { require("npmlog").info("cli", "using local version of lerna"); } else { require(".")(process.argv.slice(2)); }該文件為命令行引入了所有lerna指令：
"use strict";const cli = require("@lerna/cli");const addCmd = require("@lerna/add/command");const bootstrapCmd = require("@lerna/bootstrap/command");const changedCmd = require("@lerna/changed/command");const cleanCmd = require("@lerna/clean/command");const createCmd = require("@lerna/create/command");const diffCmd = require("@lerna/diff/command");const execCmd = require("@lerna/exec/command");const importCmd = require("@lerna/import/command");const infoCmd = require("@lerna/info/command");const initCmd = require("@lerna/init/command");const linkCmd = require("@lerna/link/command");const listCmd = require("@lerna/list/command");const publishCmd = require("@lerna/publish/command");const runCmd = require("@lerna/run/command");const versionCmd = require("@lerna/version/command");const pkg = require("./package.json");module.exports = main;function main(argv) {const context = { lernaVersion: pkg.version,};return cli() .command(addCmd) .command(bootstrapCmd) .command(changedCmd) .command(cleanCmd) .command(createCmd) .command(diffCmd) .command(execCmd) .command(importCmd) .command(infoCmd) .command(initCmd) .command(linkCmd) .command(listCmd) .command(publishCmd) .command(runCmd) .command(versionCmd) .parse(argv, context);}lerna的子命令均繼承自Command類，比如lerna init命令定義為：
const { Command } = require("@lerna/command");class InitCommand extends Command { ...}Command類定義在@lerna/command，位于lerna/core/command目錄。
有一些寫法值得借鑒，比如個別方法需要InitCommand的實例自行定義，否則拋錯，InitCommand類的定義如下：
class InitCommand extends Command { ... initialize() { throw new ValidationError(this.name, "initialize() needs to be implemented."); } execute() { throw new ValidationError(this.name, "execute() needs to be implemented."); }}上文提到，lerna/core/lerna/cli.js描述了命令行的執行入口：
#!/usr/bin/env node"use strict";/* eslint-disable import/no-dynamic-require, global-require */const importLocal = require("import-local");if (importLocal(__filename)) { require("npmlog").info("cli", "using local version of lerna");} else { require(".")(process.argv.slice(2));}其中，import-local的作用是，實現本地開發版本和生產版本的切換。import-local/index.js的內容是：
'use strict';const path = require('path');const resolveCwd = require('resolve-cwd');const pkgDir = require('pkg-dir');module.exports = filename => { const globalDir = pkgDir.sync(path.dirname(filename)); const relativePath = path.relative(globalDir, filename); const pkg = require(path.join(globalDir, 'package.json')); const localFile = resolveCwd.silent(path.join(pkg.name, relativePath)); const localNodeModules = path.join(process.cwd(), 'node_modules'); const filenameInLocalNodeModules = !path.relative(localNodeModules, filename).startsWith('..'); // Use path.relative() to detect local package installation, // because __filename's case is inconsistent on Windows // Can use === when targeting Node.js 8 // See https://github.com/nodejs/node/issues/6624 return !filenameInLocalNodeModules && localFile && path.relative(localFile, filename) !== '' && require(localFile);};Babel使用lerna進行依賴管理。其中，lerna自己實現了一套依賴管理機制，也支持基于yarn的依賴管理。這里主要介紹lerna的hoisting。
子模塊相同的依賴可以通過依賴提升（hoisting），將相同的依賴安裝在根目錄下，本地包之間用軟連接實現。
該命令執行時，會在每個子項目下面，各自安裝其中package.json聲明的依賴。
這樣會有一個問題，相同的依賴會被重復安裝，除了占用更多空間外，依賴安裝速度也受影響。
--hoist標記時，lerna bootstrap會識別子項目下名稱和版本號相同的依賴，并將其安裝在根目錄的node_modules下，子項目的node_modules會生成軟連接。
這樣節省了空間，也減少了依賴安裝的耗時。
當在項目中聲明yarn作為依賴安裝的底層依賴，如：
{ "npmClient": "yarn", "useWorkspaces": true, }package.json
{ "workspaces": [ "packages/*" ] }相對于lerna，yarn提供了更強大的依賴分析能力、hoisting算法。而且，默認情況下，yarn會開啟hoist功能，也可以設置nohoist關閉該功能：
{ "workspaces": { "packages": [ "Packages/*", ], "nohoist": [ "**" ] } }lerna中廣泛使用了git命令用于內部工作，這里列舉了lerna中使用的git命令。
git initgit rev-parsegit describegit rev-listgit taggit loggit configgit diff-indexgit --versiongit showgit amgit resetgit ls-filesgit diff-treegit commitgit ls-remotegit checkoutgit pushgit addgit remotegit show-ref沒有必要逐個介紹git命令，我們選取幾個不是很常見的git命令介紹，了解其作用、lerna哪些命令用到了它們。
解析提交、分支、標簽等引用，獲取對應的SHA-1值。
校驗是否為有效的引用或表達式。
生成git對象的唯一標識符。
下面是一個git rev-parse命令的執行結果案例：
$ git rev-parse HEADf7f6d6f2b6b47eb8c4cf4b8bf5f83e0b8028c031getCurrentSHA() { return this.execSync("git", ["rev-parse", "HEAD"]);}getWorkspaceRoot() { return this.execSync("git", ["rev-parse", "--show-toplevel"]);}找到最接近當前提交的標簽。
根據最接近的標簽以及提交的SHA-1值生成一個描述字符串。
可以幫助識別當前提交相對于標簽的距離，以及提交是否是基于標簽進行的修改。
下面是一個git describe命令的執行結果案例：
$ git describepolaris-release-1.0.0-c12345export function getLastCommit(execOpts?: ExecOptions) { if (hasTags(execOpts)) { log.silly("getLastTagInBranch", ""); return childProcess.execSync("git", ["describe", "--tags", "--abbrev=0"], execOpts); } log.silly("getFirstCommit", ""); return childProcess.execSync("git", ["rev-list", "--max-parents=0", "HEAD"], execOpts);}git rev-list
列出提交對象的哈希值，可以按時間、作者、提交者等順序進行排序。
支持使用范圍、分支、標簽等參數來限制輸出的提交范圍。
下面是一個git rev-list命令的執行結果案例：
$ git rev-list HEADf7f6d6f2b6b47eb8c4cf4b8bf5f83e0b8028c031a3d8b4e1c2e1d0a9b8c6e5f7d6a4b3e8a1b2c3d4這里git rev-list HEAD將列出當前HEAD指向的提交及其之前的所有提交的 SHA-1 哈希值。
export function getLastCommit(execOpts?: ExecOptions) { if (hasTags(execOpts)) { log.silly("getLastTagInBranch", ""); return childProcess.execSync("git", ["describe", "--tags", "--abbrev=0"], execOpts); } log.silly("getFirstCommit", ""); return childProcess.execSync("git", ["rev-list", "--max-parents=0", "HEAD"], execOpts);}git diff-index
檢查暫存區（index）和當前工作目錄之間的差異。
可以與不同的選項一起使用，以便輸出不同格式的差異信息。
下面是一個git diff-index命令的執行結果案例：
$ git diff-index HEAD:100644 100644 bcd1234... 0123456... M file.txt這里git diff-index HEAD將顯示當前提交（HEAD）和工作目錄之間的差異。
export class ImportCommand extends Command<ImportCommandOptions> { ... if (this.execSync("git", ["diff-index", "HEAD"])) { throw new ValidationError("ECHANGES", "Local repository has un-committed changes"); } ...}git diff-tree
比較兩個樹對象之間的差異，例如提交對象和樹對象之間的差異。
可以用于查看提交之間的差異，文件的更改等信息。
下面是一個git diff-tree命令的執行結果案例：
$ git diff-tree HEAD~2 HEAD100644 blob a3d8b4e1c2e1d0a9b8c6e5f7d6a4b3e8a1b2c3d4 file.txtexport async function getProjectsWithTaggedPackages( projectNodes: ProjectGraphProjectNodeWithPackage[], projectFileMap: ProjectFileMap, execOpts: ExecOptions): Promise<ProjectGraphProjectNodeWithPackage[]> { log.silly("getTaggedPackages", ""); // @see https://stackoverflow.com/a/424142/5707 // FIXME: --root is only necessary for tests :P const result = await childProcess.exec( "git", ["diff-tree", "--name-only", "--no-commit-id", "--root", "-r", "-c", "HEAD"], execOpts ); const stdout: string = result.stdout; const files = new Set(stdout.split("/n")); return projectNodes.filter((node) => projectFileMap[node.name]?.some((file) => files.has(file.file)));}git show-ref
列出git倉庫中的所有引用及其對應的提交哈希值。
可以用于查看分支、標簽等引用的信息。
下面是一個git show-ref命令的執行結果案例：
$ git show-refa3d8b4e1c2e1d0a9b8c6e5f7d6a4b3e8a1b2c3d4 HEADa3d8b4e1c2e1d0a9b8c6e5f7d6a4b3e8a1b2c3d4 refs/heads/mainf7f6d6f2b6b47eb8c4cf4b8bf5f83e0b8028c031 refs/tags/v1.0.0export function remoteBranchExists(gitRemote: string, branch: string, opts: ExecOptions) { log.silly("remoteBranchExists", ""); const remoteBranch = `${gitRemote}/${branch}`; try { childProcess.execSync("git", ["show-ref", "--verify", `refs/remotes/${remoteBranch}`], opts); return true; } catch (e) { return false; }}本文鏈接：http://m.www897cc.com/showinfo-26-91828-0.html深入理解Babel - 項目管理工具Lerna解析
聲明：本網頁內容旨在傳播知識，若有侵權等問題請及時與本網聯系，我們將在第一時間刪除處理。郵件：2376512515@qq.com
上一篇： 淺談CSS權重計算規則，你學會了嗎？
Copyright ? 2016-2023 天津谷騏科技有限公司 版權所有 sitemap.xml
違法及侵權請聯系：2376512515@qq.com 津ICP備18001702號
津公網安備 12010102000574號