1.5.0 • Published 1 year ago
rollup-plugin-typescript-paths v1.5.0
rollup-plugin-typescript-paths
Rollup Plugin to automatically resolve path aliases set in the compilerOptions
section of tsconfig.json
.
Don't use it if you're already using rollup-plugin-typescript. This plugin is only for use cases where your TypeScript code has already been transpiled before rollup
runs.
For example, if you have
// tsconfig.json
{
"compilerOptions": {
// ...
"baseUrl": ".",
"paths": {
"@utils": ["src/helpers/utils"]
}
}
}
import { something } from '@utils';
Then this plugin will make sure that rollup knows how to resolve @utils
.
Features
- No config required. 😎
- Wildcards are supported. 💪
- Uses
nodeModuleNameResolver
from the Typescript API. 🤓
Installation
npm install --save-dev rollup-plugin-typescript-paths
Usage
import { typescriptPaths } from 'rollup-plugin-typescript-paths';
export default {
// ...
plugins: [typescriptPaths()],
};
Options
absolute
: Whether to resolve to absolute paths; defaults totrue
.nonRelative
: Whether to resolve non-relative paths based on tsconfig'sbaseUrl
, even if none of thepaths
are matched; defaults tofalse
.preserveExtensions
: Whether to preserve.ts
and.tsx
file extensions instead of having them changed to.js
; defaults tofalse
.tsConfigPath
: Custom path to yourtsconfig.json
. Use this if the plugin can't seem to find the correct one by itself.transform
: If the plugin successfully resolves a path, this function allows you to hook into the process and transform that path before it is returned.
License
MIT.