rollup-plugin-esbuild-resolve
v1.3.0
Published
Use rollup with the resolution algorithm implementation of esbuild.
Downloads
44
Maintainers
Readme
rollup-plugin-esbuild-resolve
Use rollup with the resolution algorithm implementation of esbuild.
This plugin replaces @rollup/plugin-node-resolve
and all rollup plugins which implement the TypeScript compilerOptions.paths
resolution algorithm.
Why
Esbuild has its own implementation of the node resolution algorithm and it also implements the compilerOptions.paths resolution algorithm introduced by TypeScript.
The implementation has also one speciality - its not reading just one tsconfig.json
file, its always reading the closest one from the importer file. This enables correct resolution of many interconnected projects, each one with their own tsconfig.json
.
Install
npm i rollup-plugin-esbuild-resolve -D
Usage
// rollup.config.js
import { esbuildResolve } from 'rollup-plugin-esbuild-resolve';
export default {
plugins: [
esbuildResolve({
// optional:
esbuild: {
// pass custom esbuild options here
}
}),
],
}
Note: This plugin can be used together with
@rollup/plugin-node-resolve
and other resultion plugins.
Options
rollup-plugin-esbuild-resolve
has only one optional
option:
esbuild
Here you can pass custom esbuilds build api options.
You can pass any options you like, but the options which are relevant for customizing the resolution algorithm are:
platform
: Customize the default values for various resolution related options.conditions
: Controls how theexports
field in apackage.json
is interpreted.ignoreAnnotations
: Controls whether hints for side effects like thesideEffects
field in apackage.json
or the inline/* @__PURE__ */
comment are respected.mainFields
: Controls which fields in apackage.json
are the entry point and in which order to check them.nodePaths
: Additional directories to check for modules.preserveSymlinks
: Controls whether symlinks should be preserved.resolveExtensions
: Controls which extensions in which order should be checked for a resolved file without extension.tsconfig
: Customize the name of thetsconfig.json
file which should be checked.absWorkingDir
: Customize the working directory.
Corresponding @rollup/plugin-node-resolve
options
| esbuild | node-resolve |
| ------------- | ------------- |
| conditions
| exportConditions
|
| mainFields
| mainFields
|
| nodePaths
| moduleDirectories
/ modulePaths
|
| resolveExtensions
| extensions
|
| absWorkingDir
| rootDir
|
License
MIT