node.js - Automatisk transpilere TypeScript-pakker fra andre arbejdsområder i Turborepo


Jeg har en Turborepo-baseret monorepo, hvor jeg har en hoved-TypeScript-applikation (kaldet @myscope/tsapp), som bruger en anden TypeScript-pakke i samme repository (kaldet @myscope/tspackage). Du kan finde det eksempellager, jeg har oprettet til dette spørgsmål, her: https://github.com/sigalor/typescript-transpile-workspace-packages

Filen apps/tsapp/src/index.ts ser sådan ud:

import { sum } from "@myscope/tspackage";

console.log("The sum is:", sum(2, 3));

Og filen packages/tspackage/src/index.ts indeholder simpelthen dette:

export function sum(a: number, b: number): number {
  return a + b;
}

Nu kører npm run dev i roden af repositoryet resulterer i dette:

> [email  dev
> turbo run dev

• Packages in scope: @myscope/tsapp, @myscope/tsconfig, @myscope/tspackage
• Running dev in 3 packages
• Remote caching disabled
@myscope/tsapp:dev: cache bypass, force executing 0f1217618b24762f
@myscope/tsapp:dev: 
@myscope/tsapp:dev: > @myscope/[email  dev
@myscope/tsapp:dev: > tsc-watch --onSuccess "node ./dist"
@myscope/tsapp:dev: 
@myscope/tsapp:dev: 
@myscope/tsapp:dev: 12:32:26 - Starting compilation in watch mode...
@myscope/tsapp:dev: 
@myscope/tsapp:dev: 
@myscope/tsapp:dev: 12:32:27 - Found 0 errors. Watching for file changes.
@myscope/tsapp:dev: /home/cmd/typescript-transpile-workspace-packages/packages/tspackage/src/index.ts:1
@myscope/tsapp:dev: export function sum(a: number, b: number): number {
@myscope/tsapp:dev: ^^^^^^
@myscope/tsapp:dev: 
@myscope/tsapp:dev: SyntaxError: Unexpected token 'export'
@myscope/tsapp:dev:     at internalCompileFunction (node:internal/vm:73:18)
@myscope/tsapp:dev:     at wrapSafe (node:internal/modules/cjs/loader:1176:20)
@myscope/tsapp:dev:     at Module._compile (node:internal/modules/cjs/loader:1218:27)
@myscope/tsapp:dev:     at Module._extensions..js (node:internal/modules/cjs/loader:1308:10)
@myscope/tsapp:dev:     at Module.load (node:internal/modules/cjs/loader:1117:32)
@myscope/tsapp:dev:     at Module._load (node:internal/modules/cjs/loader:958:12)
@myscope/tsapp:dev:     at Module.require (node:internal/modules/cjs/loader:1141:19)
@myscope/tsapp:dev:     at require (node:internal/modules/cjs/helpers:110:18)
@myscope/tsapp:dev:     at Object.<anonymous> (/home/cmd/Downloads/typescript-transpile-workspace-packages/apps/tsapp/dist/index.js:3:19)
@myscope/tsapp:dev:     at Module._compile (node:internal/modules/cjs/loader:1254:14)
@myscope/tsapp:dev: 
@myscope/tsapp:dev: Node.js v18.16.0

Selvfølgelig er det klart for mig, hvorfor dette sker: Åbenlyst bliver @myscope/tspackage ikke transpileret af tsc-watch, så det kan ikke køres. Men hvordan kan jeg løse dette?

Indtil videre har jeg gjort det sådan, at jeg transpilerer @myscope/tspackage helt separat, se branch tspackage-transpiled i det repository, der er linket ovenfor. Men så er det meget besværligt, når jeg laver ændringer i @myscope/tspackage, fordi jeg først skal afslutte tsc-watch fra @myscope/tsapp, re-transpilere @myscope/tspackage og derefter starte tsc-watch igen.

Jeg bemærkede, at Next.js har muligheden transpilePackages, hvilket er præcis, hvad jeg vil, men selvfølgelig kun for Next.js/frontend-universet: https://github.com/vercel/turbo/blob/main/examples/basic/apps/web/next.config.js

Findes der en mulighed som denne også for standard TypeScript, så tsc (eller tsc-watch), som køres inden for @myscope/tsapp, også automatisk transpilerer @myscope/tspackage?

Svar #1

Lige nu bruger jeg et script i min pakke, som skal transpileres for at kunne kalde tsc under udvikling.

// package.json
{
  "main": "dist/index.js",
  "scripts": {
    "dev": "tsc --watch"
  }
}
// tsconfig.json
{
  "include": ["src"],
  "compilerOptions": {
    "preserveWatchOutput": true
  }
}

Det ville være rart, hvis dette var tilgængeligt i turborepo

Relaterede artikler