rollup-plugin-typescript-paths-vtn
v1.2.3
Published
Rollup Plugin to automatically resolve path aliases set in the compilerOptions section of tsconfig.json.
Downloads
5
Readme
rollup-plugin-typescript-paths
Rollup Plugin to automatically resolve path aliases set in the compilerOptions
section of tsconfig.json
. It assumes that your Typescript code has already been transpiled before being rolled up (if that's not the case, you should probably use rollup-plugin-typescript).
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
tsConfigPath
: Custom path to yourtsconfig.json
. Use this if the plugin can't seem to find the correct one by itself.absolute
: Whether to resolve to absolute paths or not; defaults totrue
.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.