Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/aleclarson/vite-tsconfig-paths

Support for TypeScript's path mapping in Vite
https://github.com/aleclarson/vite-tsconfig-paths

Last synced: 14 days ago
JSON representation

Support for TypeScript's path mapping in Vite

Awesome Lists containing this project

README 

        
👋 Check out [Radashi](https://github.com/radashi-org/radashi), my latest endeavor.



Radashi



---



 



# vite-tsconfig-paths



[![npm](https://img.shields.io/npm/v/vite-tsconfig-paths.svg)](https://www.npmjs.com/package/vite-tsconfig-paths)

[![Code style: Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)



Give [`vite`] the ability to resolve imports using TypeScript's path mapping.



[`vite`]: https://github.com/vitejs/vite



## Install



```sh

pnpm add -D vite-tsconfig-paths

```



```sh

npm install --save-dev vite-tsconfig-paths

```



```sh

yarn add -D vite-tsconfig-paths

```



## Setup



1. Ensure the project either has `"type": "module"` set or that the Vite config is renamed to `vite.config.mjs` / `vite.config.mts` depending on whether TypeScript is used



2. Inject `vite-tsconfig-paths` in the Vite config



   ```ts

   import { defineConfig } from 'vite'

   import tsconfigPaths from 'vite-tsconfig-paths'



   export default defineConfig({

     plugins: [tsconfigPaths()],

   })

   ```



### ⚠️ CSS imports are not supported.



Due to a Vite limitation, CSS files (and CSS dialects) cannot be resolved with this plugin.



This is being tracked in [#30](https://github.com/aleclarson/vite-tsconfig-paths/issues/30).



### ⚠️ Non-TypeScript modules need special configuration.



To enable path resolution in non-TypeScript modules (e.g. `.vue`, `.svelte`, `.mdx`), you must set the `allowJs` option to true in your `tsconfig.json` file.



```json

{

  "compilerOptions": {

    "allowJs": true

  }

}

```



**Alternative:** If you prefer to avoid `allowJs` or it didn't help, passing `loose: true` to the plugin constructor should work.



```ts

tsconfigPaths({ loose: true })

```



### ⚠️ TSConfigs are not watched.



You should restart Vite when you make changes to a tsconfig file; particularly these settings: `include`, `exclude`, `compilerOptions.paths`, and `compilerOptions.baseUrl`.



This is being tracked in [#17](https://github.com/aleclarson/vite-tsconfig-paths/issues/17) (contributions welcome).



 



## Plugin Options



You pass these options when calling the plugin constructor in your Vite config.



> [!WARNING]

> You should try using the plugin without *any* of these options, and only set them when you know you need them.



```ts

import { defineConfig } from 'vite'

import tsconfigPaths from 'vite-tsconfig-paths'



export default defineConfig({

  plugins: [tsconfigPaths({ /* options go here */ })],

})

```



#### `root: string`



The directory to search for `tsconfig.json` files.



The default value of this option depends on whether `projects` is defined. If it is, then the [Vite project root](https://vitejs.dev/config/shared-options.html#root) is used. Otherwise, Vite's [`searchForWorkspaceRoot`](https://vitejs.dev/guide/api-javascript.html#searchforworkspaceroot) function is used.



#### `projects: string[]`



If you have an esoteric setup, you _might_ need this option to specify where your tsconfig files are located. The paths within are relative to the `root` option.



If defined, the `root` directory won't be searched for tsconfig files. You should **always** try using just the `root` option first, because this option is more brittle.



#### `loose: boolean`



Disable strictness that limits path resolution to TypeScript and JavaScript importers. In other words, when `loose: true` is used, any file that gets transpiled into JavaScript will have its imports resolved by this plugin.



For example, this is useful if you want imports in Vue templates to be resolved, but don't want to use `allowJs` in your tsconfig.



#### `parseNative: boolean`



Enable use of the [`tsconfck.parseNative`](https://github.com/dominikg/tsconfck/blob/main/docs/api.md#parsenative) function, which delegates the loading of tsconfig files to the TypeScript compiler. You'll probably never need this, but I added it just in case.



> [!WARNING]

> This option can slow down Vite's startup time by as much as 600ms, due to the size of the TypeScript compiler. Only use it when necessary.



#### `ignoreConfigErrors: boolean`



When true, parsing errors encountered while loading tsconfig files will be ignored.



This is useful if you have a monorepo with multiple tsconfig files, and you don't want to see errors for the ones that aren't relevant to the current project.



#### `skip: (dir: string) => boolean`



A function that determines which directories to skip when searching for tsconfig.json files.



While `.git` and `node_modules` directories are always skipped, this option allows you to skip additional directories, which is useful in large monorepos to improve performance.



 



## TSConfig Options



### allowJs



If your tsconfig file has `"allowJs": true` in it, path resolution will be expanded beyond TypeScript importers. The following extensions will have their imports resolved by this plugin: `.vue`, `.svelte`, `.mdx`, `.mjs`, `.js`, `.jsx`



If you believe another file extension should be supported by default, please open an issue or pull request.



 



### baseUrl



If the `baseUrl` is defined, it gets prepended to all bare imports, and its resolution will take precedence over node_modules. This is also how TypeScript does it.



Say the `baseUrl` is `../root` and you import `react`. This plugin will use `../root/react` if it exists. If not found, then `react` is resolved normally. The `baseUrl` is relative to the project root (where `tsconfig.json` lives).



 



### include/exclude



The `include` and `exclude` tsconfig options are respected.



Internally, [globrex](https://github.com/terkelg/globrex) is used for glob matching.



 



## Troubleshooting



The `DEBUG` environment variable can be used to figure out why this plugin isn't working as you may have expected.



```sh

DEBUG=vite-tsconfig-paths yarn vite

```



Also, check out the [Troubleshooting](https://github.com/aleclarson/vite-tsconfig-paths/wiki/Troubleshooting) wiki page for more guidance.