目次 (14)
[ブログ紹介] フロントエンド - アーキテクチャ
ブログを作るために何度もセットアップを試し、その過程で何度も挫折しました。さまざまな試行錯誤の末、monorepo構成にする方法が、プロジェクトを最もきれいに分けられて使いやすいという結論にたどり着きました。単純にフォルダ構成だけで機能を分けようとしたときはフォルダが細かく分かれすぎてしまい、かといってパッケージごとにリポジトリを分けようとすると、管理するのも他のアプリに適用するのも面倒です。特にエディター機能を含めようとするとコード量が増え、ドメインとコードが混ざりやすくなりました。一方で、1つのリポジトリの中でモジュールごとに分離する方法なら、自然とドメインとコードが分離され、再利用性や使いやすさ(開発者体験)まで確保できるという点で、確かにメリットがあると感じました。
1. Micro Frontendアーキテクチャと設定
以下は、ブログを作るときに使ったMonorepo構成です。

以前のフォルダ構成(tsconfigのReference機能を使用)
共通の設定をeslint.base.js、tsconfig.base.jsonにまとめ、各アプリとパッケージでそれをextendsする方式で使っていました。最適化のために、references属性を使って依存関係を作りました。ただ、最新バージョン(eslint v9.16)で設定していたところ参考資料が少なく、一部ごちゃごちゃに設定してしまった部分もあります。
├── apps/│ ├── storyBook/ # storybook│ ├── carrotBlogFront/ # Next.js アプリ (メインフロントエンド)│ └── carrotMobileApp/ # React Native アプリ ├── packages/│ ├── designSystem/ # tailwindベースのデザインシステム│ ├── editor/ # エディター│ ├── domain/ # ドメイン [Entity, FetchApi, Util]│ └── utils/ # 共通ユーティリティ├── preinstall.js # preinstallスクリプト├── pnpm-workspace.yaml # pnpmは別ファイルでワークスペースを定義├── package.json ├── turbo.json # ビルドパイプライン、task設定├── eslint.config.js # root eslint├── tsconfig.json # root tsconfig├── eslint.config.base.js # 共通eslint└── tsconfig.base.json # 共通tsconfig現在のフォルダ構成(Just in Time packagesを適用)
tsconfigとeslint設定の共通部分は、それぞれパッケージにして、より直感的に見つけて管理できるようにしました。
ついでに、以前はtsconfigをreferencesフィールドを活用して最適化していましたが、一人で開発している以上それほど大きなプロジェクトにはなりにくいので、使い勝手の面でより良いjust in time packages方式に変更しました。(referencesを削除)
最初にeslintを設定したときは、最新バージョンのeslintを使っていたため、使い方を調べながら適用していて、ごちゃごちゃに進めてしまった部分があります。そこで、turboRepoのdlx時に生成される基本設定に大部分を変更しました。
├── apps/│ ├── storyBook/ # storybook│ ├── carrotBlogFront/ # Next.js アプリ (メインフロントエンド)│ └── carrotMobileApp/ # React Native アプリ ├── packages/│ ├── designSystem/ # tailwindベースのデザインシステム│ ├── editor/ # エディター│ ├── domain/ # ドメイン [Entity, FetchApi, Util]│ ├── utils/ # 共通ユーティリティ│ ├── eslintConfig/ # eslint設定│ └── tsConfig/ # TypeScript設定├── preinstall.js # preinstallスクリプト├── pnpm-workspace.yaml # pnpmは別ファイルでワークスペースを定義├── package.json └── turbo.json # ビルドパイプライン、task設定// apps/*/package.json// pacckages/*/package.json{ "devDependencies": { "@yooncarrot/eslint-config": "workspace:*", "@yooncarrot/ts-config": "workspace:*", "eslint": "9.16.0" }}// packages/typescript-config/tsconfig.base.json{ "$schema": "https://json.schemastore.org/tsconfig", "compilerOptions": { "declaration": true, "declarationMap": true, "esModuleInterop": true, "isolatedModules": true, "composite": true, "lib": ["es2022", "DOM", "DOM.Iterable"], "module": "NodeNext", "moduleDetection": "force", "moduleResolution": "nodenext", "noUncheckedIndexedAccess": false, // indexでアクセスしてもundefinedが出ないように "resolveJsonModule": true, "skipLibCheck": true, "strict": true, "forceConsistentCasingInFileNames": true, "allowImportingTsExtensions": true, "emitDeclarationOnly": true, "target": "ES2022" }}// packages/exlint-config/base.jsimport js from "@eslint/js";import eslintConfigPrettier from "eslint-config-prettier";import turboPlugin from "eslint-plugin-turbo";import tseslint from "typescript-eslint";import onlyWarn from "eslint-plugin-only-warn";/** * A shared ESLint configuration for the repository. * * @type {import("eslint").Linter.Config[]} * */export const config = [ js.configs.recommended, eslintConfigPrettier, ...tseslint.configs.recommended, { plugins: { turbo: turboPlugin, }, rules: { "turbo/no-undeclared-env-vars": "off", "no-unused-vars": "off", "@typescript-eslint/no-unused-vars": [ // 未使用の変数にアンダースコア(_)のprefixを付ければエラーにならないよう設定 "error", { args: "all", argsIgnorePattern: "^_", caughtErrors: "all", caughtErrorsIgnorePattern: "^_", destructuredArrayIgnorePattern: "^_", varsIgnorePattern: "^_", ignoreRestSiblings: true, }, ], }, }, { plugins: { onlyWarn, }, }, { ignores: ["dist/**"], },];1.1 AppとPackage
ブログプロジェクトのAppは、Storybook、React Web、React Nativeの3つです。そしてパッケージは、Design System、Editor、Domain、Utilsの4つと、tsとESLintの設定のためのtsConfig、eslintConfigの2つで構成しました。
App
React Web
React Native
Storybook
Package
DesignSystem
Editor
Domain
Utils
tsConfig
esLintConfig
ここでDomainを別に分離した目的は、APIをもう少し体系的に使うためです。(ドメイン駆動開発のようなものを意識したわけではありません。)そして、Domainパッケージの役割は3つあります。
フロントで使うArticleやCategoryのようなEntityを定義し、バックエンドから受け取るDTOを定義してDTOをEntityに加工することで、AppではそのままEntityとして使えるようにする役割を担います。
また、RESTfulなAPIとして設計しましたが(成熟度レベル2程度)、[Get, /articles]のようなAPIを使うときに、より体系的にクエリパラメータを活用できるようAppから分離しました。そのため、共通のクエリパラメータはQueryStringFactoryのようなオブジェクトを作って規則的に管理できます。
ex) [Get, /articles?q=ブログ&sort=+createdAt-likes&category=Typescript&page=0&size=9] このAPIは「ブログ」を検索し、作成日の昇順・いいねの降順で並べたデータのうち、カテゴリーがTypescriptのものだけを取得するAPIです。このようにクエリ文字列が多いので、複数のAPIで共通して管理できればより良いと考えました。最後に、React Nativeでアプリとしても開発する必要があるので、APIの再利用を可能にします。
1.2 tsconfigの共有方法
Monorepoでモジュール間のtsconfigを共有する方法について説明します。以下の例は、実際にはNxを使ったときの例を持ってきたものです。ただ、turboRepoを使っても同じように設定するので、そのまま同じ例を使いました。tsconfigの共有方法ごとの違いをまとめました。Monorepoをセットアップするときにきっと役立つと思います。
区分 | 説明 | 型推論の速度 | ビルド方式 | 型ファイル | 配布 |
|---|---|---|---|---|---|
Project Reference | tsがパッケージ間の依存関係・ビルド順序を追跡 | 🟡 普通 (.tsbuildInfoを使用) | tsc --build tsc --watch(リアルタイム) | .d.ts .tsbuildinfo | ❌ |
Internal Package | ビルドせずにそのまま.tsファイルを利用 | 🟡 普通 | consumerのビルダーを使用 | .ts | ❌ |
Compiled Package | ソースコードをビルドして.js + .d.tsを出力 | 🟢 速い | ビルダーを使用 | .d.ts, .js | ✅ |
Publish Package | 外部公開用にビルドされたパッケージ | 🟢 速い | ビルダーを使用 | .d.ts, .js | ✅ |
Relative Imports(最も直感的な方法)
└─ . ├─ apps │ └─ exampleApp │ ├─ src │ │ └─ index.ts │ └─ tsconfig.json ├─ packages │ └─ exampleLib │ ├─ src │ │ └─ index.ts │ └─ tsconfig.json └─ tsconfig.base.json// apps/exampleApp/src/index.tsimport { add } from '../../../packages/exampleLib/src/index.ts';console.log(add(1,3));// tsconfig.base.json{ "compilerOptions": { "target": "ES2020", "module": "NodeNext", "strict": true, "moduleResolution": "NodeNext", "baseUrl": ".", "rootDir": "." }}// apps/exampleApp/tsconfig.json{ "extends": "../../tsconfig.base.json", "compilerOptions": { "outDir": "../../dist", "declaration": true }, "include": ["src/**/*"]}// packages/exampleLib/tsconfig.json{ "extends": "../../tsconfig.base.json", "compilerOptions": { "outDir": "../../dist", "declaration": true }, "include": ["src/**/*"]}依存関係の解決
相対パスを使って、パッケージ間を最も簡単につなげられる方法です。
ただし、コードベースの構成を変更すると、extendsのパスを一つひとつ修正しなければなりません。大きなワークスペースでは、この欠点がより目立つことがあります。
モジュール化
アプリとライブラリをそれぞれのフォルダに分離して、モジュール化を可能にしてくれます。そのため保守性も良くなり、ワークスペースも簡単に探索できます。
しかし、Typescriptの観点では全体が1つの統合されたプロジェクトとなり、型チェックにおいてパッケージ間の境界が存在しなくなります。
パフォーマンス
Typescriptの観点では全体が1つの統合されたプロジェクトになるため、ワークスペースが大きいと問題が生じることがあります。型チェックとコンパイルがすべてのモジュールを対象に行われるため、ビルド速度が遅くなり、エディターの反応性も低下する可能性があります。
Relative ImportsをPath Aliasesに切り替え。(可読性の改善)
Relative Importとの違い
tsconfig.base.json
pathsフィールドを追加
結論
import pathを短縮して可読性を向上
└─ . ├─ apps │ └─ exampleApp │ ├─ src │ │ └─ index.ts │ └─ tsconfig.json ├─ packages │ └─ exampleLib │ ├─ src │ │ └─ index.ts │ └─ tsconfig.json └─ tsconfig.base.json// tsconfig.base.json{ "compilerOptions": { "target": "ES2020", "module": "NodeNext", "strict": true, "moduleResolution": "NodeNext", "baseUrl": ".", "rootDir": "." "paths": { "@text-package/exampleLib": ["packages/exampleLib/src/index.ts"] } }}// apps/exampleApp/src/index.tsimport { add } from '@test-package/exampleLib';console.log(add(1,3));依存関係の解決
Path aliasを使うことで相対パスを使う必要がなくなり、コードベースの構成が変わってもtsconfig.base.jsonのpathsだけを変更すれば済みます。
モジュール化とパフォーマンスは変わりません。
tsconfigのReferenceを使用
要件:typescript v3.0以上
Relative Import + Path Aliasとの違い
root - package.json
scriptsにtsc --buildで
tsconfig.base.json
rootUrlを削除
compilerOptionsでcomposite:trueを設定 => incrementalがtrueになり、ビルド時に.tsbuildinfoが生成される
declaration関連の設定を追加
root - tsconfig.json
ファイルを追加
referencesフィールドを追加
app - tsconfig.json
declaration、outDirフィールドを削除
referencesフィールドを追加
packages - tsconfig.json
declaration、outDirフィールドを削除
結論
TypeScriptがモジュールごとに個別に管理
パフォーマンスの向上
型の依存関係を生成(ビルドの依存関係が生じ、tsが自動で計算)
└─ . ├─ apps │ └─ exampleApp │ ├─ src │ │ └─ index.ts │ └─ tsconfig.json ├─ packages │ └─ exampleLib │ ├─ src │ │ └─ index.ts │ └─ tsconfig.json ├─ tsconfig.json └─ tsconfig.base.json// apps/exampleApp/src/index.tsimport { add } from '@test-package/exampleLib';console.log(add(1,3));// tsconfig.base.json// ポイントはrootUrlの削除。{ "compilerOptions": { "target": "ES2020", "module": "NodeNext", "strict": true, "moduleResolution": "NodeNext", "composite": true, "declaration": true, "declarationMap": true, "sourceMap": true, "baseUrl": ".", "paths": { "@text-package/exampleLib": ["packages/exampleLib/src/index.ts"] } }}// tsconfig.json{ "files": [], "references": [{ "path": "./packages/exampleLib" }, { "path": "./apps/exampleApp" }]}// apps/exampleApp/tsconfig.json{ "extends": "../../tsconfig.base.json", "compilerOptions": { "rootDir": "src", }, "references": [{ "path": "../../packages/exampleLib" }], "include": ["src/**/*"]}// packages/exampleLib/tsconfig.json{ "extends": "../../tsconfig.base.json", "compilerOptions": { "rootDir": "src", }, "include": ["src/**/*"]}// packages/exampleLib/package.json{ "name": "test-package", ... "scripts": { "dev": "tsx --tsconfig tsconfig.base.json apps/exampleApp/src/index.ts", "build": "tsc --build", "clean": "tsc --build --clean", "typecheck": "tsc --build --emitDeclarationOnly" }}モジュール化
プロジェクト参照を使うと、各モジュールを独立させることができます。コンポーネント間の論理的な分離を強制します。これによりパッケージ間の分離レベルが向上し、依存関係はパッケージ単位で型チェックが行われます。
パフォーマンス
インクリメンタルビルド(incremental build)を使います。変更されたパッケージだけを再コンパイルするため、全体のビルドを繰り返す必要がありません。TypeScriptは.tsbuildinfoファイルを生成して変更を追跡し、これによって型チェックとコンパイルの速度を向上させます。規模の大きいワークスペースやCIパイプラインで役立ちます。(開発の利便性のため、--watchオプションを使ってリアルタイムに更新)
Reference + package manager
要件:Node.js v13.2.0以上
この方式は、app(consumer)からpackageのtsファイルを直接参照する方式です。そのため、トランスパイルの責任はconsumerにあります。もしconsumerがTypescriptをコンパイルして使えない場合、packageを使えなくなります。
tsconfig Reference使用との違い
tsconfig.base.json
baseUrlを削除
pathsを削除
app - package.json
privateフィールドを追加
packageをdependencyに追加
app - tsconfig.json
baseUrlフィールドを追加
package - package.json
privateフィールドを追加(単独で使用可能)
exportsフィールドを追加
package - tsconfig.json
compositeフィールドを追加
declarationフィールドを追加
main、typeを追加
workspaceを追加
pnpmはpnpm-workspace.yamlファイル
npm、yarnはroot - package.jsonのworkspacesフィールドを追加。
結論
TypeScriptのpath aliasではなく、package managerによってappとパッケージがつながる
モジュールを個別にパッケージングして管理
より厳格な環境分離
appで別途トランスパイル + バンドリング(appのビルド時にpackagesまで処理する必要がある)
└─ . ├─ apps │ └─ exampleApp │ ├─ src │ │ └─ index.ts │ └─ tsconfig.json ├─ packages │ └─ exampleLib │ ├─ src │ │ └─ index.ts │ └─ tsconfig.json ├─ pnpm-workspace.yaml ├─ tsconfig.json └─ tsconfig.base.json// pnpm-workspace.yamlpackages: - 'apps/*' - 'packages/*'// apps/exampleApp/tsconfig.json{ "compilerOptions": { "target": "ES2020", "module": "NodeNext", "strict": true, "moduleResolution": "NodeNext", "composite": true, "declaration": true, "declarationMap": true, "sourceMap": true, }}// apps/exampleApp/tsconfig.json{ "extends": "../../tsconfig.base.json", "compilerOptions": { "outDir": "dist", "rootDir": "src", "baseUrl": ".", "tsBuildInfoFile": "dist/tsconfig.tsbuildinfo" }, "references": [{ "path": "../../packages/exampleLib" }], "include": ["src/**/*"]}// packages/exampleLib/tsconfig.json{ "extends": "../../tsconfig.base.json", "compilerOptions": { "baseUrl": ".", "rootDir": "src", "outDir": "dist", "tsBuildInfoFile": "dist/tsconfig.tsbuildinfo" }, "include": ["src/**/*"]}// packages/exampleLib/package.json{ "name": "@text-package/exampleLib", ... "type": "module", "exports": { ".": { "types": "./src/index.ts", "import": "./src/index.ts", "default": "./src/index.ts" }, "./package.json": "./package.json" }, "main": "./src/index.ts", "types": "./src/index.ts", "module": "./src/index.ts"}// apps/exampleApp/package.json{ "name": "@yooncarrot/exampleApp", ... "dependencies": { "@test-package/exampleLib": "workspace:*" // NPMを使う場合は任意ですが、pnpmでは必ず明示する必要があります。 }}依存関係の解決
パッケージマネージャーのworkspaceを使い、パッケージの解決をパッケージマネージャーに委ねることで、TypeScriptから独立して動作します。
モジュール化
各パッケージの依存関係がpackage.jsonによって明確に定義されるため、直感的で理解しやすくなります。そして、exportするファイルを明示するので、そのファイルをimportするパッケージがトランスパイルとバンドリングの責任を負うことになり、より確実にモジュール化されます。
パフォーマンスは以前のReference方式と同じです。
Reference + package manager + Pre-buildingを使用(Compiled Packages)
Reference + Package Manager方式との違い
package - package.json
exportsのパスをビルドパスに修正(src/index.ts => dist/index.d.js..)
package.jsonまたはexampleLibのpackage.jsonのビルドスクリプトを適切に修正。
nxやturboRepoを使う場合は、そのmonorepoライブラリに合わせてパイプラインを修正。
結論
バンドリングの責任を各モジュールごとに持てる。(事前にビルドして提供するため)
Compiled Packagesはビルドしないと型が更新されないため、手間がかかることがある。(開発の利便性が下がる可能性)
大規模プロジェクトでは、pre-compile方式のほうが開発の利便性が良い場合がある(IDEの型推論の遅延が少なくなる)
└─ . ├─ apps │ └─ exampleApp │ ├─ ... │ ├─ package.json │ └─ tsconfig.json ├─ package.json ├─ packages │ └─ exampleLib │ ├─ dist │ │ ├─ index.d.ts │ │ ├─ index.d.ts.map │ │ ├─ index.js │ │ ├─ index.js.map │ │ └─ tsconfig.tsbuildinfo │ ├─ package.json │ ├─ src │ │ └─ index.ts │ └─ tsconfig.json ├─ pnpm-workspace.yaml ├─ tsconfig.base.json └─ tsconfig.json// packages/exampleApp/package.json{ "name": "@test-package/exampleLib", "version": "0.0.0", // 追加されたフィールド "private": true, // 追加されたフィールド "type": "module", "exports": { ".": { "types": "./dist/index.d.ts", // すべての./src/* => ./dist/*に変更(ビルドされたファイル) "import": "./dist/index.js", "default": "./dist/index.js" }, "./package.json": "./package.json" }, "main": "./dist/index.js", "types": "./dist/index.d.ts", "module": "./dist/index.js"}依存関係の解決
依存パッケージを事前にコンパイルすることで、appのバンドラーが事前にビルドされた出力物を使えるようになります。また、アプリケーションのバンドリング中にパッケージの依存関係をコンパイルする必要もなくなります。タスクパイプラインを作成する際に、パッケージが事前にコンパイルされるよう保証することで、ワークフローをより効率的にできます。
モジュール化
TypeScriptのソースファイルを直接参照する以前の方式に比べて、モジュール性が向上します。パッケージを事前にコンパイルしてパッケージングすれば、モノレポの外部への配布も可能です。
パフォーマンス
型チェックのパフォーマンスを向上させることができます。事前にコンパイルされた.d.tsファイルによって型情報があらかじめ生成されるため、プロジェクト参照を通じてTypeScriptのソースファイルを処理する代わりに、この型情報ファイルを直接活用できます。
Reference + package manager + package use path alias + (Just-in-TIme Packages)
要件:typescript 5.4以上、NodeJs 14.6以上
package(パッケージ)のtsconfigオプションのうち、compilerOptions.pathsはconsumerには適用されません。なぜなら、appのTypeScriptでトランスパイルされることを前提に動作するからです。
そのため、パッケージでpath aliasを使うと問題が起きますが、TypeScript 5.0からはNode.jsの14.6バージョンで追加されたsubPath機能でこれを解決できます。
monorepoにおけるJust-in-Timeパッケージは、appからパッケージのtsファイルを直接参照する方式です。つまり、型定義ファイル(.d.ts)や.tsbuildInfoファイルを参照しない方式です。メリットは、継続的にbuildしなくてもリアルタイムに反映される点です。
└─ . ├─ apps │ └─ exampleApp │ ├─ ... │ ├─ package.json │ └─ tsconfig.json ├─ package.json ├─ packages │ └─ exampleLib │ ├─ package.json │ ├─ src │ │ ├─ add.ts │ │ ├─ sub.ts │ │ └─ index.ts │ └─ tsconfig.json ├─ pnpm-workspace.yaml ├─ tsconfig.base.json └─ tsconfig.json// packages/exampleLib/package.json{ "name": "@test-package/exampleLib", "version": "0.0.0", // 追加されたフィールド "type": "module", "imports": { // 追加されたフィールド "#*": "./src/*" // package内部でpath aliasを使う場合。(node設定では@は使用不可) }, "exports": { // 追加されたフィールド ".": "./src/index.ts", "./add": "./src/add.ts", "./sub": "./src/sub.ts", }, ...}// packages/exampleLib/tsconfig.json{ "extends": ["../../tsconfig.base.json"], "compilerOptions": { "baseUrl": ".", "paths": { "#*": ["./src/*"] // package内部でpath aliasを使う場合、Just-in-Timeパッケージでは@は使用不可。 } }, "include": ["src/**/*"] ...}依存関係の解決
Packageモジュールでもpath aliasを使って型参照ができるようになります。(path aliasによる依存関係の問題が解決)
パフォーマンス
compiled packagesとしてパッケージをappで使うよりも、パフォーマンスは劣ります。しかし、IDEで型を表示する機能に多くのリソースが必要な大規模プロジェクトでなければ、開発者の開発体験はより良くなる可能性があります。
1.3 eslintの共有方法
ESLintの設定は、tsConfigの設定よりもはるかに管理しやすいです。コンパイルやバンドリングとはあまり関係がないからです。単純にeslintConfigパッケージで共通のeslint設定を作り、AppとPackageでimportして使いました。
// NextJs Appのeslint.config.jsimport {nextJsConfig} from "@yooncarrot/eslintConfig/next";/** @type {import("eslint").Linter.Config} */export default nextJsConfig;// esLintPackageパッケージのbase.jsexport const config = [ js.configs.recommended, eslintConfigPrettier, ...tseslint.configs.recommended, { plugins: { turbo: turboPlugin, }, rules: { "turbo/no-undeclared-env-vars": "off", "no-unused-vars": "off", "@typescript-eslint/no-unused-vars": [ "error", { args: "all", argsIgnorePattern: "^_", caughtErrors: "all", caughtErrorsIgnorePattern: "^_", destructuredArrayIgnorePattern: "^_", varsIgnorePattern: "^_", ignoreRestSiblings: true, }, ], }, }, { plugins: { onlyWarn, }, }, { ignores: ["dist/**"], },];// esLintConfigパッケージのnextjs.eslint.jsexport const nextJsConfig = [ ...baseConfig, js.configs.recommended, eslintConfigPrettier, ...tseslint.configs.recommended, { ...pluginReact.configs.flat.recommended, languageOptions: { ...pluginReact.configs.flat.recommended.languageOptions, globals: { ...globals.serviceworker, }, }, }, { plugins: { "@next/next": pluginNext, }, rules: { ...pluginNext.configs.recommended.rules, ...pluginNext.configs["core-web-vitals"].rules, // カスタムフォントを許可 "@next/next/no-page-custom-font": "off", }, }, { plugins: { "react-hooks": pluginReactHooks, }, settings: {react: {version: "detect"}}, rules: { ...pluginReactHooks.configs.recommended.rules, // React scope no longer necessary with new JSX transform. "react/react-in-jsx-scope": "off", }, },];2. 内部パッケージのコンパイル戦略
turborepoでは、internal packagesのコンパイル戦略を大きく3つに分けています。コンパイルしないJust-in-Time Packages、tsをコンパイルするCompiled Packages、NPMに公開するPublishable Packagesです。
2.1 Just-in-Time Packages
Just-in-Timeパッケージは、最小限の設定だけで済む方式です。なぜなら、パッケージ側で別途ビルドせず、Appのコンパイラーとバンドラーで一緒にビルドされるからです。つまり、コンパイルとバンドリングの設定がAppの設定の影響を受けます。そして、別途コンパイルしなくても、tsファイルを見てすぐに型推論されます。
メリット
Typescriptをそのままexportして使うため、appではパッケージのtsファイルを直接参照して使います。そのため、パッケージのファイルを修正すると変更がすぐに反映され、型推論されます。
appからパッケージを直接参照するため、別途buildスクリプトや設定が必要ありません。
デメリット・限界
tsファイルを直接参照する方式なので、consumer(主にapp)がtsを理解でき、ビルドできる必要があります。もしappがjsしか使えない場合は、compiled packages方式に変える必要があります。
パッケージはtsconfigでpath aliasを使えません。なぜなら、TypeScriptはコードを書いたパッケージの中でトランスパイルされると想定しているため、path aliasを別途認識できないからです。そのため、path aliasを使いたい場合は、Node.jsのsubPath機能を使う必要があります。
turborepoでpackageのビルド結果をキャッシュできないというデメリットがあります。なぜなら、packageを別途ビルドしないからです。そのため、packageが変わるとappも再ビルドする必要があります。
パッケージをtsのまま使うため、型エラーがあると、appでは本来知らなくてもいい型エラーまで把握しなければならないケースが出てくることがあります。
2.2 Compiled Packages
Compiledパッケージは、tsファイルをjsとd.tsファイルにコンパイルして使うパッケージです。通常は/distフォルダにコンパイル結果を出力し、エントリーポイント(entry point)として設定して使います。コンパイルするので、turborepoのビルドキャッシュ機能を活用できます。そのため、appでもpackageでも、ビルド時により速くビルドできます。
メリット
turborepoのビルドキャッシュ機能を活用できます。
デメリット・限界
通常はtscでコンパイル処理だけを行います。なぜなら、appのbundlerを使うからです。ただし、packageで静的ファイルを使う場合は、別途バンドリング作業が必要になることがあります。
Just-in-Timeパッケージより多くの設定が必要です。例えば、ポリフィル処理が必要なパッケージであれば、package.jsonにsideEffect属性を追加する必要があるからです。
2.3 Publishable Packages
Publishableパッケージは、NPMレジストリに公開して使うパッケージです。そのため、別途builderでビルドできる必要があります。つまり、compileとbundleの責任はパッケージにあります。最も堅牢にパッケージを作る方式です。appはnpm registryからパッケージをダウンロードして使う形になります。
3. フォルダ構成
フォルダ構成は、一般的によく使われる構成(Layered Architecture)を採用しました。NextJSアプリはFSDとも相性が良さそうだったのでFSDアーキテクチャも検討しましたが、新しく挑戦することがあまりにも多かったので、そっとしまっておきました。いくつかのアプリとパッケージのフォルダ構成を作ってみました。
3.1 NextJS(App Router)
└─ blog ├─ src │ ├─ app │ │ ... │ │ ├─ layout.ts │ │ ├─ page.ts │ │ ├─ action.ts │ │ ├─ error.ts │ │ ├─ loading.ts │ │ ├─ robots.ts │ │ └─ sitemap.ts │ ├─ components │ │ ├─ client │ │ └─ server │ └─ provider ├─ after_build.js ├─ eslint.config.js ├─ tsconfig.json ├─ postcss.config.js ├─ next.config.ts └─ package.json3.2 design-systemパッケージのフォルダ構成
└─ design-system ├─ src │ ├─ globals.css │ ├─ palette.css │ ├─ components │ │ ... │ │ ├─ Backdrop │ │ └─ BentoCard │ └─ motion ├─ eslint.config.js ├─ tsconfig.json ├─ postcss.config.js ├─ vite.config.ts └─ package.json3.3 editorパッケージのフォルダ構成
└─ editor ├─ src │ ├─ extensions │ ├─ hooks │ ├─ plugins │ └─ utils ├─ eslint.config.js ├─ tsconfig.json ├─ vite.config.ts └─ package.json参考資料
https://turbo.build/blog/you-might-not-need-typescript-project-references
