項(xiàng)目代碼組織：Polyrepo vs. Monorepo

項(xiàng)目代碼組織主要有兩種方式：

1. Polyrepo: 將項(xiàng)目代碼分散在不同的倉庫中。這是當(dāng)前的標(biāo)準(zhǔn)做法，多個(gè)團(tuán)隊(duì)分別擁有自己的倉庫、構(gòu)建產(chǎn)物和流水線，擁有自主權(quán)。
2. Monorepo: 將所有項(xiàng)目代碼集中在一個(gè)倉庫中。項(xiàng)目被劃分為應(yīng)用程序和包，方便代碼復(fù)用和共享標(biāo)準(zhǔn)功能，有助于統(tǒng)一第三方包版本、遞歸構(gòu)建依賴項(xiàng)的源代碼以及使用相同的工具進(jìn)行CI/CD流水線。

許多大型科技公司都使用Monorepo，例如Yandex。Monorepo有助于在團(tuán)隊(duì)和業(yè)務(wù)部門之間共享創(chuàng)意和最佳實(shí)踐。更多關(guān)于Monorepo和相關(guān)工具的信息，請(qǐng)?jiān)L問http://m.miracleart.cn/link/b01ccf4f29b57b0b1bdb9407050db28d。本文將重點(diǎn)介紹使用PNPM構(gòu)建Monorepo的簡(jiǎn)單方案。

PNPM使用工作區(qū)(workspaces)來整合單個(gè)倉庫中的多個(gè)項(xiàng)目。

環(huán)境搭建

首先，創(chuàng)建一個(gè)空文件夾作為新的Monorepo項(xiàng)目。在倉庫內(nèi)初始化PNPM：

pnpm init

然后，創(chuàng)建一個(gè)pnpm-workspace.yaml文件，描述包文件夾：

// pnpm-workspace.yaml

packages:
  - 'packages/**'
  - 'apps/**'

/packages文件夾存放共享庫，/apps文件夾存放應(yīng)用程序（例如，獨(dú)立的React Native移動(dòng)應(yīng)用程序和使用相同組件或連接庫與API服務(wù)器通信的Web應(yīng)用程序）。

本文將使用一個(gè)Telegram發(fā)布機(jī)器人為例，其源代碼位于GitHub：http://m.miracleart.cn/link/8164ca2fe04767628ac1c6813e8a0867。下載并解壓到/apps/publish-bot文件夾，然后運(yùn)行安裝命令：

pnpm install

創(chuàng)建Telegram工具包

在/packages文件夾中創(chuàng)建一個(gè)名為telegram-utils的文件夾，初始化PNPM和TypeScript：

pnpm init && pnpm add -D typescript && pnpm tsc --init

該包將提供一個(gè)函數(shù)，用于組合來自所有消息（文本、視頻和照片）的文本和標(biāo)題。需要安裝Telegraf包：

pnpm add telegraf

所有源代碼都應(yīng)位于/src目錄中。為了方便功能分組，建議創(chuàng)建不同的文件夾。組合文本的功能位于/texts文件夾中，代碼如下：

// packages/telegram-utils/src/texts/combineTexts.ts

import { Message } from 'telegraf/types';
import { FmtString, join } from 'telegraf/format';

type GroupedMessages = {
    photos: Array<Message.PhotoMessage>;
    videos: Array<Message.VideoMessage>;
    text: Array<Message.TextMessage>;
};

export const combineTexts = ({ photos, videos, text }: GroupedMessages) => {
    const photoTexts = photos
        .map(photo => photo.caption ? new FmtString(photo.caption, photo.caption_entities) : undefined)
        .filter((t): t is Required<FmtString> => t !== undefined);

    const videoTexts = videos
        .map(video => video.caption ? new FmtString(video.caption, video.caption_entities) : undefined)
        .filter((t): t is Required<FmtString> => t !== undefined);

    const allTexts = [];

    if (text.length) allTexts.push(join(text.map(t => new FmtString(t.text, t.entities))), '\n');
    if (photoTexts.length) allTexts.push(join(photoTexts, '\n'));
    if (videoTexts.length) allTexts.push(join(videoTexts, '\n'));

    return join(allTexts, '\n');
};

代碼說明：

• 函數(shù)輸入按類型分組的消息：照片、視頻或文本；
• 媒體消息應(yīng)轉(zhuǎn)換為包含標(biāo)題和標(biāo)題實(shí)體的FMT字符串。對(duì)于后續(xù)過濾，應(yīng)返回undefined；
• 分步連接文本數(shù)組，最終將所有文本組合成一條大消息。

創(chuàng)建/texts文件夾的索引文件：

pnpm init

在package.json文件中使用exports字段設(shè)置包功能的導(dǎo)出：

// pnpm-workspace.yaml

packages:
  - 'packages/**'
  - 'apps/**'

為了在應(yīng)用程序中識(shí)別Monorepo包，為所有包添加前綴@monorepo。重命名package.json文件中的telegram-utils包：

pnpm install

添加構(gòu)建腳本：

pnpm init && pnpm add -D typescript && pnpm tsc --init

完整的package.json文件：

pnpm add telegraf

配置TypeScript編譯器：?jiǎn)⒂迷隽烤幾g以節(jié)省構(gòu)建時(shí)間，僅處理更改的部分；啟用復(fù)合編譯以使用項(xiàng)目引用。將/src文件夾定義為rootDir，將包的outDir定義為/dist。更新后的tsconfig.json：

// packages/telegram-utils/src/texts/combineTexts.ts

import { Message } from 'telegraf/types';
import { FmtString, join } from 'telegraf/format';

type GroupedMessages = {
    photos: Array<Message.PhotoMessage>;
    videos: Array<Message.VideoMessage>;
    text: Array<Message.TextMessage>;
};

export const combineTexts = ({ photos, videos, text }: GroupedMessages) => {
    const photoTexts = photos
        .map(photo => photo.caption ? new FmtString(photo.caption, photo.caption_entities) : undefined)
        .filter((t): t is Required<FmtString> => t !== undefined);

    const videoTexts = videos
        .map(video => video.caption ? new FmtString(video.caption, video.caption_entities) : undefined)
        .filter((t): t is Required<FmtString> => t !== undefined);

    const allTexts = [];

    if (text.length) allTexts.push(join(text.map(t => new FmtString(t.text, t.entities))), '\n');
    if (photoTexts.length) allTexts.push(join(photoTexts, '\n'));
    if (videoTexts.length) allTexts.push(join(videoTexts, '\n'));

    return join(allTexts, '\n');
};

整合

回到/apps/publish-bot，將@monorepo/telegram-utils包添加到依賴項(xiàng)中。注意，不需要指定包版本，使用workspace:*表示：

// packages/telegram-utils/src/texts/index.ts

export * from './combineTexts';

安裝依賴項(xiàng)：

// packages/telegram-utils/package.json

"exports": {
    "./texts": {
        "import": "./src/texts/index.ts",
        "require": "./dist/texts/index.js"
    }
}

更新發(fā)布機(jī)器人的preview命令：

// packages/telegram-utils/package.json

"name": "@monorepo/telegram-utils"

更新/apps/publish-bot/tsconfig.json：

// packages/telegram-utils/package.json

"scripts": {
    "build": "tsc -p tsconfig.json"
}

構(gòu)建應(yīng)用代碼前，需要先構(gòu)建所有依賴項(xiàng)：

// packages/telegram-utils/package.json

{
    "name": "@monorepo/telegram-utils",
    "version": "1.0.0",
    "main": "index.js",
    "scripts": {
        "build": "tsc -p tsconfig.json"
    },
    "keywords": [],
    "license": "ISC",
    "exports": {
        "./texts": {
            "import": "./src/texts/index.ts",
            "require": "./dist/texts/index.js"
        }
    },
    "devDependencies": {
        "typescript": "^5.7.3"
    },
    "dependencies": {
        "telegraf": "^4.16.3"
    }
}

總結(jié)

現(xiàn)在，發(fā)布機(jī)器人使用內(nèi)部共享庫/包，并位于Monorepo中。這使得快速構(gòu)建新功能和在多個(gè)應(yīng)用程序中重用代碼成為可能。

圖片來自Unsplash的Gabriel Heinzer

以上是使用 PNPM 在 Monorepo 中構(gòu)建并運(yùn)行您的項(xiàng)目的詳細(xì)內(nèi)容。更多信息請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！