# esbuild-plugin-alias

> esbuild plugin for path aliases

Latest version **0.2.1** (published 2021-11-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install esbuild-plugin-alias
pnpm add esbuild-plugin-alias
yarn add esbuild-plugin-alias
bun add esbuild-plugin-alias
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2021-11-11 |
| First published | 2021-02-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Igor Adamenko |
| Maintainers | igoradamenko |
| Keywords | esbuild, alias, plugin |

## Links

- npm: https://www.npmjs.com/package/esbuild-plugin-alias
- Repository: https://github.com/igoradamenko/esbuild-plugin-alias
- Homepage: https://github.com/igoradamenko/esbuild-plugin-alias#readme
- Issues: https://github.com/igoradamenko/esbuild-plugin-alias/issues
- npm.io page: https://npm.io/package/esbuild-plugin-alias

## Alternatives

- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads

## Recent versions

- 0.2.1 (latest) — 2021-11-11
- 0.2.0 — 2021-10-04
- 0.1.2 — 2021-02-12
- 0.1.1 — 2021-02-12
- 0.1.0 — 2021-02-11

## README

# esbuild-plugin-alias

[![npm](https://img.shields.io/npm/v/esbuild-plugin-alias.svg)](https://www.npmjs.com/package/esbuild-plugin-alias)

[esbuild](https://github.com/evanw/esbuild) plugin for path aliases.


## Rationale

Sometimes it's useful to have dynamic imports that resolves into different files depending on some conditions 
(e.g. env variables).


## Installation

```sh
npm install --save-dev esbuild-plugin-alias
```


## Usage

Define plugin in the `plugins` section of esbuild config like this:

```js
const esbuild = require('esbuild');
const alias = require('esbuild-plugin-alias');

esbuild.build({
  // ...
  plugins: [
    alias({
      'imported-path': '/home/user/lib/src/resolved-path',
    }),
  ],
})
```

**Note:** esbuild requires resolved paths to be absolute. So, make sure that values in plugin's config object are
absolute paths.

If you need to find a path to an installed dep, you may use `require.resolve`. E.g.:

```js
alias({
  'react-dom': process.env.NODE_ENV === 'dev' 
    ? require.resolve('@hot-loader/react-dom')
    : require.resolve('react-dom'),
}),
```


## Example

Having this input file:

```js
// src/app.js
import settings from 'settings.env';

console.log(settings);
```

And esbuild config like this:

```js
// config/build.js
const path = require('path');
const esbuild = require('esbuild');
const alias = require('esbuild-plugin-alias');

esbuild.build({
  entryPoints: ['in.js'],
  bundle: true,
  outfile: 'out.js',
  plugins: [
    alias({
      'settings.env': path.resolve(__dirname, `../src/settings.${process.env.NODE_ENV}.js`),
    }),
  ],
}).catch(err => process.exit(1));
```

You will get `src/settings.dev.js` loaded instead of `settings.env` when `NODE_ENV` equals `dev`.

Check [test/](test) for more detailed example.

---
_Source: https://npm.io/package/esbuild-plugin-alias · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
