Back to Rolldown

Tsconfig

packages/rolldown/src/options/docs/tsconfig.md

1.1.13.6 KB
Original Source

Options

Auto-discovery mode (true)

When set to true, Rolldown enables auto-discovery mode. For each module, both the resolver and transformer search upward from the module's directory, starting at the nearest tsconfig.json. If it has references, Rolldown checks each referenced project's files/include/exclude and uses the first one that matches the file. If no reference matches, it checks the tsconfig.json's own files/include/exclude. If the file matches neither, Rolldown continues upward to the next tsconfig.json and repeats. If no tsconfig.json matches the file, it falls back to the outermost (topmost) one found, not the nearest one.

If the tsconfig has references, Rolldown resolves them the way TypeScript does: a referenced project that includes the file takes precedence over the root, and the first matching reference wins. Each referenced project uses its own allowJs, so a .js/.jsx/.mjs/.cjs file is only included by projects that enable it. If no referenced project includes the file, Rolldown falls back to the root's own files/include/exclude. A solution-style root (only references with an explicit empty files/include, as Vite scaffolds) has no file patterns of its own, so once none of its references match either, it does not own the file, and discovery continues in the parent directories as described above.

js
export default {
  tsconfig: true,
};
Explicit path (string)

Specifies the path to a specific TypeScript configuration file. You may provide a relative path (resolved relative to cwd) or an absolute path.

If the tsconfig has references, this mode behaves like auto-discovery mode for reference resolution.

js
export default {
  tsconfig: './tsconfig.json',
};
js
export default {
  tsconfig: '/absolute/path/to/tsconfig.json',
};

:::tip Rolldown respects references and include/exclude patterns in tsconfig, while esbuild does not. If you need esbuild-compatible behavior, specify a tsconfig without references. You can use extends to share the options between the two. :::

What's used from tsconfig

When a tsconfig is resolved, Rolldown uses different parts for different purposes:

Resolver

Uses the following for module path mapping:

  • compilerOptions.paths: Path mapping for module resolution
  • compilerOptions.baseUrl: Base directory for path resolution
Transformer

Uses select compiler options including:

  • jsx: JSX transformation mode
  • experimentalDecorators: Enable decorator support
  • emitDecoratorMetadata: Emit decorator metadata
  • verbatimModuleSyntax: Module syntax preservation
  • useDefineForClassFields: Class field semantics
  • And other TypeScript-specific options
Example
json
{
  "compilerOptions": {
    "target": "ES2020",
    "module": "ESNext",
    "jsx": "react-jsx",
    "baseUrl": ".",
    "paths": {
      "@/*": ["src/*"],
      "@components/*": ["src/components/*"]
    }
  }
}

With this configuration:

  • JSX will use React's automatic runtime
  • Path aliases like @/utils will resolve to src/utils

Priority

Top-level transform options always take precedence over tsconfig settings:

js
export default {
  tsconfig: './tsconfig.json', // Has jsx: 'react-jsx'
  transform: {
    jsx: {
      mode: 'classic', // This takes precedence
    },
  },
};

:::tip For TypeScript projects, it's recommended to use tsconfig: true for auto-discovery or specify an explicit path to ensure consistent compilation behavior and enable path mapping. :::