vite-plugin-import-rewriter/README_zh.md

重写 `import` 的 `vite` 插件

<h1 align="center">vite-plugin-import-rewriter</h1>

<p align="center">
  <a href="https://github.com/yuexiaoliang/vite-plugin-import-rewriter/blob/master/LICENSE">
    <img alt="GitHub" src="https://img.shields.io/github/license/yuexiaoliang/vite-plugin-import-rewriter?style=flat-square"/>
  </a>

  <a href="https://github.com/yuexiaoliang/vite-plugin-import-rewriter">
    <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/yuexiaoliang/vite-plugin-import-rewriter?style=flat-square"/>
  </a>
</p>

[English](README.md)

## 项目介绍

重写 `import` 的 `vite` 插件。

## 使用

1. 安装

```bash
yarn add -D vite-plugin-import-rewriter

# or

npm install -D vite-plugin-import-rewriter
```

2. 使用

```js
import path from 'path';
import { defineConfig } from 'vite';
import rewriter from 'vite-plugin-import-rewriter';

function getNewID(id: string, newID) {
  const basename = path.basename(id);
  return id.replace(basename, newID);
}

export default defineConfig({
  plugins: [
    rewriter({
      start: 'countrys/china-',
      sign: 'rewriter-prefix',

      methods: {
        toJS: (id: string) => {
          return id + '-js.js';
        },

        toChina: (id: string) => {
          const basename = path.basename(id);
          return id.replace(basename, 'china/' + basename);
        }
      },

      virtualModule: `
        export default (logs) => {
          logs.push('<p>this is <span>vite.config<b>.ts</b></span></p>');
        };
      `
    })
  ]
});
```

## Options

### **start**

- Type: `string`

- Default: `rewriter`

  导入的文件名开始位置拼接的值，然后去查找拼接后的模块，查找到则导入找到的模块，找不到则导入原模块。

  ```js
  // vite.config.js
  import rewriter from 'vite-plugin-import-rewriter';

  export default defineConfig({
    plugins: [
      rewriter({
        start: 'china/'
      })
    ]
  });

  // ------------ //

  // index.js
  // old
  import log from './log';
  // new
  import log from './china/log';
  ```

  or

  ```js
  // vite.config.js
  import rewriter from 'vite-plugin-import-rewriter';

  export default defineConfig({
    plugins: [
      rewriter({
        start: 'country/china-'
      })
    ]
  });

  // ------------ //

  // index.js
  // old
  import log from './log';
  // new
  import log from './country/china-log';
  ```

### **sign**

- Type: `string`

  如果配置了，只有指定标记的 `import` 才会经过插件重写，不指定则所有导入都会经过插件处理。

  ```js
  // vite.config.js
  import rewriter from 'vite-plugin-import-rewriter';

  export default defineConfig({
    plugins: [
      rewriter({
        sign: 'rewrite',
        start: 'country/china-'
      })
    ]
  });

  // ------------ //

  // index.js
  // old
  import log from './log?rewrite'; // 会经过插件处理
  import err from './err'; // 不会经过插件处理

  // new
  import log from './country/china-log';
  import err from './err';
  ```

### **methods**

- Type: `{ [key: string]: (id: string) => string; }`

  通过自定义的方法进行重写

  ```js
  // vite.config.js
  import path from 'path';
  import { defineConfig } from 'vite';
  import rewriter from 'vite-plugin-import-rewriter';

  export default defineConfig({
    plugins: [
      rewriter({
        start: 'countrys/china-',
        sign: 'rewriter-prefix',

        methods: {
          toJS: (id: string) => {
            return id + '-js.js';
          },

          toChina: (id: string) => {
            const basename = path.basename(id);
            return id.replace(basename, 'china/' + basename);
          }
        }
      })
    ]
  });

  // ------------ //

  // index.js
  // old
  import log1 from './src/log';
  import log2 from './src/log?rewriter-prefix=toJS';
  import log3 from './src/log?rewriter-prefix';
  import log4 from './src/log?rewriter-prefix=toChina';

  // new
  import log1 from './src/log';
  import log2 from './src/log.js';
  import log3 from './src/countrys/china-log';
  import log4 from './src/china/log';
  ```

### **virtualModule**

- Type: `string`

  规定一个虚拟的模块，再没有默认模块的情况下避免报错

  ```js
  // vite.config.js
  import path from 'path';
  import { defineConfig } from 'vite';
  import rewriter from 'vite-plugin-import-rewriter';

  export default defineConfig({
    plugins: [
      rewriter({
        start: 'countrys/china-',
        sign: 'rewriter-prefix',

        methods: {
          toChina: (id: string) => {
            const basename = path.basename(id);
            return id.replace(basename, 'china/' + basename);
          }
        },
        virtualModule: `
          export default (logs) => {
            logs.push('<p>this is <span>vite.config<b>.ts</b></span></p>');
          };
        `
      })
    ]
  });

  // ------------ //

  // index.js
  import log1 from './src/not-module?rewriter-prefix'; // ./src/china/not-module.ts
  import log2 from './src/not-module?rewriter-prefix=toChina'; // vite.config.ts ==> plugins.rewriter.virtualModule
  ```

## License

[License MIT](LICENSE)