vite-plugin-require-transform - GitLite

KO | EN

gitlite — search

#ai #golang #go #machine-learning #rust #linux #macos #awesome #cli #awesome-list #security #pytorch #mcp #open-source

vite-plugin-require-transform

(★ 86)

A plugin for vite that convert from require syntax to import

파일 탐색기

최종 버전 다운로드 (.zip)

- - index.ts
  - index_transformed_result.ts
- - exampleA.ts
  - exampleA_transformed_result.ts
  - exampleB.ts
  - exampleB_transformed_result.ts
  - exampleC.ts
  - exampleC_transformed_result.ts
- - index.ts
  - index_transformed_result.ts
- - index.ts
  - index_transformed_result.ts
- index.ts
- index.ts
.gitignore
.npmrc
package.json
README.md
tsconfig.json
yarn.lock

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/WarrenJones/vite-plugin-require-transform

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd vite-plugin-require-transform

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

yarn add -D vite-plugin-require-transform

이 명령어를 터미널에 그대로 입력해 실행하세요.

npm i vite-plugin-require-transform --save-dev

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# vite-plugin-require-transform

[![NPM](https://nodei.co/npm/vite-plugin-require-transform.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/vite-plugin-require-transform/)

[![npm version](https://img.shields.io/npm/v/vite-plugin-require-transform.svg)](https://www.npmjs.com/package/vite-plugin-require-transform)
A  vite plugin that converts  the code from require syntax to import

## Why vite-plugin-require-transform

<b>"require syntax"</b> is  supported when develop with <b>Webpack</b> cause it transformed it internally.

but when serve with <b>Vite</b> error <b>"require is not defined" </b>will show up.

This plugin  amis to support require when serve with vite.

## Install

```bash
yarn add -D vite-plugin-require-transform
```
or 
```bash
npm i vite-plugin-require-transform --save-dev
```
## Usage
```typescript
// vite.config.(t|j)s

import { defineConfig } from 'vite';

/**
 * @param match
 * Regular expression in string or Regexp type,
 *  or a match predicate  (this: vite transform context, code: string, id: file name string) => void
 * @returns transformed code
 */
import requireTransform from 'vite-plugin-require-transform';

export default defineConfig({
  plugins: [
    // passing string type Regular expression
    requireTransform({}),
  ],
});

// check the vite-plugin-require-transform params'type 
export type VitePluginRequireTransformParamsType = {
	//filter files that should enter the plugin
	fileRegex?: RegExp = /.ts$|.tsx$/ ,
	//prefix that would plugin into the requireSpecifier 
	importPrefix? = '_vite_plugin_require_transform_': string,
	//to deal with the requireSpecifier
	importPathHandler?: Function
}
```

## What vite-plugin-require-transform actually do 
you can also check the __test__ directory to see the cases.
### case 1:
```typescript
const case1 = require("case1");
console.log("case1", case1)
```
will be transformed into 
``` typescript
import _vite_plugin_require_transform_case1 from "case1";
const case1 = _vite_plugin_require_transform_case1;
console.log("case1", case1);
```

### case 2:
#### example A
```typescript
const case2A = location.host == 'test' ? null : require("case2");

if(location.host == 'test1' ){
    case2A.start();
}

case2A.stop();
```
will be transformed into 
``` typescript
import { start as _vite_plugin_require_transform_case2start, stop as _vite_plugin_require_transform_case2stop } from "case2";
const _vite_plugin_require_transform_case2 = {
  start: _vite_plugin_require_transform_case2start,
  stop: _vite_plugin_require_transform_case2stop
};
const case2A = location.host == 'test' ? null : _vite_plugin_require_transform_case2;

if (location.host == 'test1') {
  case2A.start();
}

case2A.stop();
```

#### example B
``` typescript
const case2B = {
    test:require('test2B').Something
}
```
will be transformed into 
``` typescript
import { Something as _vite_plugin_require_transform_test2BSomething } from "test2B";
const case2B = {
  test: _vite_plugin_require_transform_test2BSomething
};
```

#### example C
``` typescript
const case2c =require('test2C')

case2c.forEach((item)=>{
    console.log('item',item)
})
```
will be transformed into 
``` typescript
import _vite_plugin_require_transform_test2C from "test2C";
const case2c = _vite_plugin_require_transform_test2C;
case2c.forEach(item => {
  console.log('item', item);
});
```

### case 3:
when exist a case as same fileName,different extensions,by default it would be error cause the plugin only capture the path without extension.
``` typescript

//same path,different extension
const testCaseA = require("caseA.extA?aaa");
const testCaseB = require("caseA.extB?bbb");

console.log("caseA", testCaseA)
console.log("caseB", testCaseB)
```

so we need to make a importPathHandler to deal with the situtation
``` typescript 
//check out __test__/index
glob("__test__/case3/*.ts", {
    ignore: "**/*transformed_result.ts"
}, async (err, files) => {
    for (const file of files) {
        const fileContent = readFileSync(file, 'utf-8');
        const transformedContent = await vitePluginRequireTransform(
            {
                importPathHandler: (requirePath: string) => {
                    return requirePath.replace('.', '_').replace('?', "_");
                }
            }
        ).transform(fileContent, file);
        writeFileSync(file.replace('.ts', '_transformed_result.ts'), transformedContent.code);
    }
})  
```

will be transformed into

``` typescript
import _vite_plugin_require_transform_caseA_extB_bbb from "caseA.extB?bbb";
import _vite_plugin_require_transform_caseA_extA_aaa from "caseA.extA?aaa";
//same path,different extension
const testCaseA = _vite_plugin_require_transform_caseA_extA_aaa;
const testCaseB = _vite_plugin_require_transform_caseA_extB_bbb;
console.log("caseA", testCaseA);
console.log("caseB", testCaseB);
```