Skip to content
Select documentation version
Navigation
On this page

Compiling TypeScript for Deployment

Watt provides TypeScript support across different capabilities with varying compilation approaches depending on the type of application you’re building.

Server-Side Capabilities

For server-side capabilities like @platformatic/node, @platformatic/gateway, @platformatic/service and @platformatic/db, TypeScript support is provided through Node.js native type stripping:

These capabilities leverage Node.js’s built-in ability to execute TypeScript files directly by stripping type annotations at runtime.

Frontend Capabilities

For frontend capabilities like @platformatic/next and @platformatic/vite, TypeScript compilation is handled by the underlying frontend technology:

  • Next.js: Built-in TypeScript support with automatic compilation
  • Vite: Native TypeScript support through esbuild
  • Astro: Integrated TypeScript compilation
  • Remix: Built-in TypeScript support

Development Workflow

During development, no special compilation steps are required. Platformatic automatically handles TypeScript execution:

  • For @platformatic/node: If a application.commands.build is defined in your configuration or a build script exists in package.json, the build step will be executed automatically
  • For frontend capabilities: Development servers handle TypeScript compilation transparently

Production Deployment

For production deployments, you must compile TypeScript before starting your application:

For @platformatic/node and Frontend Capabilities

  1. Build your application:

    wattpm build
  2. Start the production server:

    wattpm start

Important Notes

  • Always run wattpm build before wattpm start in production environments
  • The build process will compile TypeScript files and prepare your application for production
  • Ensure all TypeScript dependencies are properly installed before building
  • For frontend capabilities, the build process includes bundling, optimization, and asset generation

Best Practices

  • Use TypeScript configuration files (tsconfig.json) to customize compilation settings
  • Enable strict mode for better type safety
  • Configure proper module resolution for your target environment
  • Test your built application in a production-like environment before deployment

Platformatic provides a recommended TypeScript configuration through the @platformatic/tsconfig package. You can use it by extending it in your tsconfig.json:

{
  "extends": "@platformatic/tsconfig",
  "compilerOptions": {
    "outDir": "./dist"
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "dist"]
}

The recommended configuration uses these settings:

{
  "compilerOptions": {
    // General settings
    "target": "ESNext",
    "lib": ["ESNext"],
    // Module settings
    "module": "NodeNext",
    "moduleResolution": "NodeNext",
    "skipLibCheck": true,
    "esModuleInterop": true,
    "allowSyntheticDefaultImports": true,
    "allowImportingTsExtensions": true,
    "rewriteRelativeImportExtensions": true,
    "allowJs": false,
    // Language settings
    "strict": true,
    "strictNullChecks": true,
    "noImplicitAny": true,
    "noUnusedLocals": true,
    "noUnusedParameters": true,
    "useUnknownInCatchVariables": false,
    // Transpilation settings
    "jsx": "preserve",
    "removeComments": true,
    "newLine": "lf"
  }
}

Note: The outDir option is purposely left unset in the base configuration due to TypeScript issue #29172. You should set it explicitly in your project’s tsconfig.json as shown in the example above.

Reading time
2 min read
View as
Markdown
Contribute
Edit this page