vite-plugin-tsc

@wroud/vite-plugin-tsc

@wroud/vite-plugin-tsc brings the TypeScript compiler (tsc) to Vite. Vite's default esbuild pipeline skips type checking, so this plugin can run tsc to surface type errors during development or builds. It can also transpile TypeScript files that Vite then bundles, keeping all Vite features intact. The plugin supports TypeScript project references.

Use Cases

• Type checking: Run tsc in the background to catch type errors that esbuild ignores.
• Transpilation: Transpile TypeScript files with tsc and let Vite bundle the output.

Features

• Transpilation: Automatically transpiles TypeScript code using tsc.
• Project References: Supports TypeScript project references.
• Background Type Checking: Performs type checking in the background without blocking Vite, allowing for a smoother development experience.
• Watch Mode: Supports watch mode for continuous development.
• Easy Integration: Simple to add to your Vite project.

Installation

Install via npm:

npm install @wroud/vite-plugin-tsc

Install via yarn:

yarn add @wroud/vite-plugin-tsc

Documentation

For detailed usage and API reference, visit the documentation site.

Example - Transpilation

import { defineConfig } from "vite";
import { tscPlugin } from "@wroud/vite-plugin-tsc";

export default defineConfig({
  plugins: [
    tscPlugin({
      tscArgs: ["-b"],
      // Enable prebuild to ensure dependencies are built before Vite starts bundling
      prebuild: true, // Recommended for projects with TypeScript project references
    }),
  ],
});

Example - Type Checking Only

import { defineConfig } from "vite";
import { tscPlugin } from "@wroud/vite-plugin-tsc";

export default defineConfig({
  plugins: [
    tscPlugin({
      tscArgs: ["--project", "tsconfig.json"],
      // Prebuild is not needed for type checking only
      prebuild: false, // Skip prebuilding for faster startup
      enableOverlay: true, // Show errors in Vite overlay
    }),
  ],
});

Changelog

All notable changes to this project will be documented in the CHANGELOG file.

License

This project is licensed under the MIT License. See the LICENSE file for details.