# babel-plugin-import-replacement

> replace import path by customize rules

Latest version **1.0.1** (published 2021-11-12) · ISC license · 0 weekly downloads

## Install

```sh
npm install babel-plugin-import-replacement
pnpm add babel-plugin-import-replacement
yarn add babel-plugin-import-replacement
bun add babel-plugin-import-replacement
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-11-12 |
| First published | 2021-11-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 10.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | BuggMaker |
| Maintainers | bugmaker |
| Keywords | babel, plugin, import, replace, rename |

## Links

- npm: https://www.npmjs.com/package/babel-plugin-import-replacement
- Repository: https://github.com/BuggMaker/babel-plugin-import-replacement
- Homepage: https://github.com/BuggMaker/babel-plugin-import-replacement#readme
- Issues: https://github.com/BuggMaker/babel-plugin-import-replacement/issues
- npm.io page: https://npm.io/package/babel-plugin-import-replacement

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2021-11-12
- 1.0.0-beta.1 — 2021-11-12

## README

# babel-plugin-import-replacement

Replace import path by customize rules.

[中文](https://github.com/BuggMaker/babel-plugin-import-replacement/blob/master/README_zh.md#babel-plugin-import-replacement)

## Installation

```sh
npm install babel-plugin-import-replacement --save-dev
```

## Example

### js file

```js
import React from 'react';
import defaultMember from 'module-name0';
import * as name from 'module-name1';
import { member } from 'module-name2';
import 'module-name3';
import utils from ' my-utils';
```

### babel.config.js

```js
module.exports = {
  plugins: [
    [
      require.resolve('babel-plugin-import-replacement'),
      {
        rules: [
          {
            match: 'react',
            replacement: 'rax',
          },
          {
            match: /module\-name/,
            replacement: 'another-module',
          },
          {
            match: /my-utils/,
            replacement: (source) => {
              if (typeof window !== 'undefined') {
                return `${source}/dist/web`;
              } else {
                return `${source}/dist/default`;
              }
            },
          },
        ],
      },
    ],
  ],
};
```

### Transformed Code

```js
"use strict";
var _rax = require("rax");
var _rax2 = _interopRequireDefault(_rax);
var _anotherModule = require("another-module0");
var _anotherModule2 = _interopRequireDefault(_anotherModule);
var _anotherModule3 = require("another-module1");
var name = _interopRequireWildcard(_anotherModule3);
var _anotherModule4 = require("another-module2");
require("another-module3");
var _default = require(" my-utils/dist/default");
var _default2 = _interopRequireDefault(_default);
function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) newObj[key] = obj[key]; } } newObj.default = obj; return newObj; } }
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }'
```

## API

### rules

`array`

Rules for defining the replacement of import paths, which can be multiple.

#### match

- `string`
- `RegExp`

#### replacement

- `string`
- `(source:string) => string`
  - source: matching import path
  - return: replaced path

### debug

`boolean`

Defines whether to enable debug mode. When enabled, the console will print the matching import path and the replacement path. The default value is `false`. `

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