下部の落とし穴のセクションを必ず読んでください。
注記:
libs
およびpackages
ディレクトリの外側になります。
pnpm dlx create-turbo@latest
Monorepo ディレクトリにpnpm-workspace.yaml
を作成します。
その中に下例を追加します:
packages: - "apps/*" - "libs/*"
これにより、すべてのリポジトリがapps
とlibs
内に存在することが pnpm に通知されます。libs またはpackages
(他の場所で見たように) libs
使用は重要ではないことに注意してください。
pnpm init
{ "name": "@repo/main", "version": "1.0.0", "scripts": {}, "keywords": [], "author": "", "license": "ISC" }
name:@repo/main
これは、これがアプリケーションのメイン エントリであることを示しています。特定の規則に従ったり、 @
プレフィックスを使用したりする必要はありません。これは、ローカル/リモート パッケージと区別したり、組織にグループ化しやすくしたりするために使用されます。
turbo.json
ファイルを作成します。 { "$schema": "//turbo.build/schema.json", "tasks": { "build": {}, "dev": { "cache": false, "persistent": true }, "start": { "dependsOn": ["^build"], "persistent": true }, "preview": { "cache": false, "persistent": true }, "db:migrate": {} } }
turbo.json ファイルは、turbo リポジトリにコマンドの解釈方法を指示します。tasks キー内にあるものはすべてtasks
all package.json にあるものと一致します。
例: dev
コマンドはturbo dev
によってトリガーされ、package.json 内でdev
が見つかったすべてのパッケージを実行します。turbo に含めない場合は実行されません。
apps
フォルダを作成するmkdir apps
apps
フォルダにリミックスアプリを作成する(または既存のアプリを移動する) npx create-remix --template edmundhung/remix-worker-template
Install any dependencies with npm
ように求められたら、いいえと答えます。
name
を@repo/my-remix-cloudflare-app
(またはあなたの名前) に変更します。 { - "name": "my-remix-cloudflare-app", + "name": "@repo/my-remix-cloudflare-app", "version": "1.0.0", "keywords": [], "author": "", "license": "ISC" }
apps/<app>/package.json
からルートのpackage.json
にコピーします。 { "name": "@repo/main", "version": "1.0.0", "scripts": {}, "keywords": [], "author": "", "license": "ISC", "dependencies": { "@markdoc/markdoc": "^0.4.0", "@remix-run/cloudflare": "^2.8.1", "@remix-run/cloudflare-pages": "^2.8.1", "@remix-run/react": "^2.8.1", "isbot": "^3.6.5", "react": "^18.2.0", "react-dom": "^18.2.0" }, "devDependencies": { "@cloudflare/workers-types": "^4.20240222.0", "@octokit/types": "^12.6.0", "@playwright/test": "^1.42.1", "@remix-run/dev": "^2.8.1", "@remix-run/eslint-config": "^2.8.1", "@tailwindcss/typography": "^0.5.10", "@types/react": "^18.2.64", "@types/react-dom": "^18.2.21", "autoprefixer": "^10.4.18", "concurrently": "^8.2.2", "cross-env": "^7.0.3", "eslint": "^8.57.0", "eslint-config-prettier": "^9.1.0", "husky": "^9.0.11", "lint-staged": "^15.2.2", "msw": "^2.2.3", "postcss": "^8.4.35", "prettier": "^3.2.5", "prettier-plugin-tailwindcss": "^0.5.12", "rimraf": "^5.0.5", "tailwindcss": "^3.4.1", "typescript": "^5.4.2", "vite": "^5.1.5", "vite-tsconfig-paths": "^4.3.1", "wrangler": "^3.32.0" } }
pnpm add turbo -D -w
-w
フラグは、pnpm にワークスペースのルートにインストールするように指示します。
scripts
にdev
コマンドを追加する
オプションにpackageManager
を追加する
{ "name": "@repo/main", "version": "1.0.0", "scripts": { "dev": "turbo dev" }, "keywords": [], "author": "", "license": "ISC", "packageManager": "[email protected]", "dependencies": { // omitted for brevity }, "devDependencies": { // omitted for brevity } }
pnpm dev
を実行してすべてが機能していることを確認するpnpm dev
mkdir -p libs/config libs/db libs/utils
src/index.ts
を追加します。 touch libs/config/src/index.ts libs/db/src/index.ts libs/utils/src/index.ts
libs/config/package.json
ファイルに次の内容を追加します。 { "name": "@repo/config", "version": "1.0.0", "type": "module", "exports": { ".": { "import": "./src/index.ts", "default": "./src/index.ts" } } }
libs/db/package.json
に対しても同じ操作を行います。 { "name": "@repo/db", "version": "1.0.0", "exports": { ".": { "import": "./src/index.ts", "default": "./src/index.ts" } } }
libs/utils/package.json
: { "name": "@repo/utils", "version": "1.0.0", "exports": { ".": { "import": "./src/index.ts", "default": "./src/index.ts" } } }
注:
pnpm add drizzle-orm drizle-kit --filter=@repo/db
ワークスペース レベルで Postgres をインストールします。 「落とし穴」セクションを参照してください。
pnma add postgres -w
注:
--filter=@repo/db
フラグは、pnpm にパッケージを db リポジトリに追加するように指示します。pnpm add dotenv -w
注記-w
フラグはpnpmにルートのpackage.jsonにインストールするように指示します。 pnpm add @repo/config -r --filter=!@repo/config
注記:
-r
フラグは、pnpm にパッケージをすべてのリポジトリに追加するように指示します。--filter=!
フラグは、pnpm に設定リポジトリを除外するように指示します。!
に注意してください pnpm がリポジトリからパッケージをプルしている場合は、プロジェクトのルートに.npmrc
ファイルを作成できます。
link-workspace-packages= true prefer-workspace-packages=true
tsconfig.json
を構成する
libs/config
内でtsconfig.lib.json
インスタンス化します。
touch "libs/config/tsconfig.base.lib.json"
{ "$schema": "//json.schemastore.org/tsconfig", "compilerOptions": { "lib": ["ES2022"], "module": "ESNext", "moduleResolution": "Bundler", "resolveJsonModule": true, "target": "ES2022", "strict": true, "esModuleInterop": true, "skipLibCheck": true, "forceConsistentCasingInFileNames": true, "allowImportingTsExtensions": true, "allowJs": true, "noUncheckedIndexedAccess": true, "noEmit": true, "incremental": true, "composite": false, "declaration": true, "declarationMap": true, "inlineSources": false, "isolatedModules": true, "noUnusedLocals": false, "noUnusedParameters": false, "preserveWatchOutput": true, "experimentalDecorators": true, "emitDecoratorMetadata": true, "sourceMap": true, } }
// libs/db/drizzle.config.ts (Yes, this one is at root of the db package, outside the src folder) // We don't want to export this file as this is ran at setup. import "dotenv/config"; // make sure to install dotenv package import { defineConfig } from "drizzle-kit"; export default defineConfig({ dialect: "postgresql", out: "./src/generated", schema: "./src/drizzle/schema.ts", dbCredentials: { url: process.env.DATABASE_URL!, }, // Print all statements verbose: true, // Always ask for confirmation strict: true, });
// libs/db/src/drizzle/schema.ts export const User = pgTable("User", { userId: char("userId", { length: 26 }).primaryKey().notNull(), subId: char("subId", { length: 36 }).notNull(), // We are not making this unique to support merging accounts in later // iterations email: text("email"), loginProvider: loginProviderEnum("loginProvider").array().notNull(), createdAt: timestamp("createdAt", { precision: 3, mode: "date" }).notNull(), updatedAt: timestamp("updatedAt", { precision: 3, mode: "date" }).notNull(), });
// libs/db/src/drizzle-client.ts import { drizzle, PostgresJsDatabase } from "drizzle-orm/postgres-js"; import postgres from "postgres"; import * as schema from "./schema"; export type DrizzleClient = PostgresJsDatabase<typeof schema>; let drizzleClient: DrizzleClient | undefined; type GetClientInput = { databaseUrl: string; env: string; mode?: "cloudflare" | "node"; }; declare var window: typeof globalThis; declare var self: typeof globalThis; export function getDrizzleClient(input: GetClientInput) { const { mode, env } = input; if (mode === "cloudflare") { return generateClient(input); } const globalObject = typeof globalThis !== "undefined" ? globalThis : typeof global !== "undefined" ? global : typeof window !== "undefined" ? window : self; if (env === "production") { drizzleClient = generateClient(input); } else if (globalObject) { if (!(globalObject as any).__db__) { (globalObject as any).__db__ = generateClient(input); } drizzleClient = (globalObject as any).__db__; } else { drizzleClient = generateClient(input); } return drizzleClient; } type GenerateClientInput = { databaseUrl: string; env: string; }; function generateClient(input: GenerateClientInput) { const { databaseUrl, env } = input; const isLoggingEnabled = env === "development"; // prepare: false for serverless try { const client = postgres(databaseUrl, { prepare: false }); const db = drizzle(client, { schema, logger: isLoggingEnabled }); return db; } catch (e) { console.log("ERROR", e); return undefined!; } }
// libs/db/src/drizzle/migrate.ts import { config } from "dotenv"; import { migrate } from "drizzle-orm/postgres-js/migrator"; import postgres from "postgres"; import { drizzle } from "drizzle-orm/postgres-js"; import "dotenv/config"; import path from "path"; config({ path: "../../../../apps/my-remix-cloudflare-app/.dev.vars" }); const ssl = process.env.ENVIRONMENT === "development" ? undefined : "require"; const databaseUrl = drizzle( postgres(`${process.env.DATABASE_URL}`, { ssl, max: 1 }) ); // Somehow the current starting path is /libs/db // Remember to have the DB running before running this script const migration = path.resolve("./src/generated"); const main = async () => { try { await migrate(databaseUrl, { migrationsFolder: migration, }); console.log("Migration complete"); } catch (error) { console.log(error); } process.exit(0); }; main();
これは移行後に実行する必备があります
そして、 src/index.ts
ファイルにクライアントとスキーマをエクスポートします。その他は特定の時間に実行されます。
// libs/db/src/index.ts export * from "./drizzle/drizzle-client"; export * from "./drizzle/schema "
package.json
に、 drizzle-kit generate
と、移行コマンドを実行するコードを追加します。
{ "name": "@repo/db", "version": "1.0.0", "main": "./src/index.ts", "module": "./src/index.ts", "types": "./src/index.ts", "scripts": { "db:generate": "drizzle-kit generate", "db:migrate": "dotenv tsx ./drizzle/migrate", }, "exports": { ".": { "import": "./src/index.ts", "default": "./src/index.ts" } }, "dependencies": { "@repo/configs": "workspace:^", "drizzle-kit": "^0.24.1", "drizzle-orm": "^0.33.0", }, "devDependencies": { "@types/node": "^22.5.0" } }
libs/db
とlibs/utils
に共有tsconfig.json
を使用するlibs/db
とlibs/utils
の tsconfig.json を作成します。
touch "libs/db/tsconfig.json" "libs/utils/tsconfig.json"
{ "extends": "@repo/configs/tsconfig.base.lib.json", "include": ["./src"], }
@repo/configs
が tsconfig.base.lib.json を参照するパスとして使用されていることを確認します。 pnpm add tsx -D --filter=@repo/db
libs/db
ディレクトリに空の.envを追加するtouch "libs/db/.env"
DATABASE_URL="postgresql://postgres:postgres@localhost:5432/postgres" NODE_ENV="development" MODE="node"
libs/db
リポジトリを追加する pnpm add @repo/db --filter=@repo/my-remix-cloudflare-app
これが機能しない場合は、 apps/my-remix-cloudflare-app
の package.json に移動し、依存関係を手動で追加します。
{ "name": "@repo/my-remix-cloudflare-app", "version": "1.0.0", "dependencies": { "@repo/db": "workspace:*" } }
バージョン フィールドのworkspace:*
に注意してください。これにより、pnpm はワークスペース内のパッケージの任意のバージョンを使用するように指示されます。
pnpm add,
おそらくworkspace:^
のようなものが表示されます。ローカル パッケージのバージョンを上げない限り、問題にはなりません。
これを手動で追加した場合は、プロジェクトのルートからpnpm install
実行します。
次のコードをlibs/utils/src/index.ts
ファイルに追加します。
// libs/utils/src/index.ts export function hellowWorld() { return "Hello World!"; }
pnpm add @repo/db --filter=@repo/my-remix-cloudflare-app
プロジェクトのルートにdocker-compose.yml
ファイルを作成します。
# Auto-generated docker-compose.yml file. version: '3.8' # Define services. services: postgres: image: postgres:latest restart: always environment: - POSTGRES_USER=postgres - POSTGRES_PASSWORD=postgres - POSTGRES_DB=postgres ports: - "5432:5432" volumes: - ./postgres-data:/var/lib/postgresql/data pgadmin: # To connect PG Admin, navigate to //localhost:8500 use: # host.docker.internal # postgres # (username) postgres # (password) postgres image: dpage/pgadmin4 ports: - "8500:80" environment: PGADMIN_DEFAULT_EMAIL: [email protected] PGADMIN_DEFAULT_PASSWORD: admin
docker-compose up -d
-d
フラグは、docker-compose にデタッチされた状態で実行するように指示し、ターミナルに再度アクセスできるようにします。
次に、libs/db リポジトリに移動して、 db:generate
実行します。
cd `./libs/db` && pnpm db:generate
db:generate
drizzle-kit generate
の別名であることに注意してください。
libs/db リポジトリに移動し (まだそこにない場合)、 db:generate
実行します。
cd `./libs/db` && pnpm db:migrate
db:migrate
dotenv tsx ./drizzle/migrate
のエイリアスであることに注意してください。 // apps/my-remix-cloudflare-app/app/routes/_index.tsx import type { LoaderFunctionArgs } from '@remix-run/cloudflare'; import { json, useLoaderData } from '@remix-run/react'; import { getDrizzleClient } from '@repo/db'; import { Markdown } from '~/components'; import { getFileContentWithCache } from '~/services/github.server'; import { parse } from '~/services/markdoc.server'; export async function loader({ context }: LoaderFunctionArgs) { const client = await getDrizzleClient({ databaseUrl: context.env.DATABASE_URL, env: 'development', mode: 'cloudflare', }); if (client) { const res = await client.query.User.findFirst(); console.log('res', res); } const content = await getFileContentWithCache(context, 'README.md'); return json( { content: parse(content), // user: firstUser, }, { headers: { 'Cache-Control': 'public, max-age=3600', }, }, ); } export default function Index() { const { content } = useLoaderData<typeof loader>(); return <Markdown content={content} />; }
DATABASE_URL="postgresql://postgres:postgres@localhost:5432/postgres"
docker-compose up -d
pnpm turbo dev
export const getLoadContext: GetLoadContext = async ({ context, request }) => { const isEnvEmpty = Object.keys(context.cloudflare.env).length === 0; const env = isEnvEmpty ? process.env : context.cloudflare.env; const sessionFlashSecret = env.SESSION_FLASH_SECRET; const flashStorage = createCookieSessionStorage({ cookie: { name: "__flash", httpOnly: true, maxAge: 60, path: "/", sameSite: "lax", secrets: [sessionFlashSecret], secure: true, }, }); return { ...context, cloudflare: { ...context.cloudflare, env, }, dispatch: (await dispatchWithContext({ env: env as unknown as Record<string, string>, request, })) as Dispatch, flashStorage, }; };
ディスパッチ コードが省略されていることに注意してください。詳細については、TypeScript 開発エクスペリエンスを 10 倍にする方法に関する私の記事をご覧ください。
ロード コンテキスト内のパッケージから TypeScript ファイルをインポートすると、 @repo/db
Vite は拡張子.ts
のファイルが不明であるというエラーを返し、そのファイルを処理する方法がわかりません。
コツは、 tsx
使用して、Vite を呼び出す前にロードすることです。これは、次の制限を克服するため重要です。
Cloudflare パッケージの依存関係と事前ビルド
まず第1 に、これは私が避けようとしていたステップでした。パッケージごとにビルド ステップを導入する有必要的があり、構成が増えることを意思していたからです。
pnpm add tsx -D --filter=@repo/my-remix-cloudflare-app
次に、 package.json
変更し、各リミックス スクリプトに tsx プロセスを追加する必要があります。
{ "name": "@repo/my-remix-cloudflare-app", "version": "1.0.0", "scripts": { // Other scripts omitted "build": "NODE_OPTIONS=\"--import tsx/esm\" remix vite:build", "dev": "NODE_OPTIONS=\"--import tsx/esm\" remix vite:dev", "start": "NODE_OPTIONS=\"--import tsx/esm\" wrangler pages dev ./build/client" } }
.npmrc
ファイルの作成コマンドラインを使用してローカル パッケージを追加するときに問題が発生する場合は、プロジェクトのルートに.npmrc
ファイルを作成できます。
link-workspace-packages= true prefer-workspace-packages=true
これにより、pnpm は最原始にワークスペース パッケージを采用するようになります。
ファイル内の.client
および.server
命名には注意してください。別のライブラリ内にある場合でも同様です。Remix はこれらを使用して、クライアント ファイルかサーバー ファイルかを判断します。プロジェクトはリポジトリごとにコンパイルされないため、インポート エラーが発生します。
以上です、皆さん!!!