vite-plugin-require-transform

A vite plugin that converts the code from require syntax to import

Why vite-plugin-require-transform

"require syntax" is supported when develop with Webpack cause it transformed it internally.

but when serve with Vite error "require is not defined" will show up.

This plugin amis to support require when serve with vite.

Install

yarn add -D vite-plugin-require-transform

or

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

Usage

// vite.config.(t|j)simport{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 */importrequireTransformfrom'vite-plugin-require-transform';exportdefaultdefineConfig({plugins: [// passing string type Regular expressionrequireTransform({}),],});// check the vite-plugin-require-transform params'type exporttypeVitePluginRequireTransformParamsType={//filter files that should enter the pluginfileRegex?: RegExp=/.ts$|.tsx$/,//prefix that would plugin into the requireSpecifier importPrefix? ='_vite_plugin_require_transform_': string,//to deal with the requireSpecifierimportPathHandler?: Function}

What vite-plugin-require-transform actually do

you can also check the test directory to see the cases.

case 1:

constcase1=require("case1");console.log("case1",case1)

will be transformed into

import_vite_plugin_require_transform_case1from"case1";constcase1=_vite_plugin_require_transform_case1;console.log("case1",case1);

case 2:

example A

constcase2A=location.host=='test' ? null : require("case2");if(location.host=='test1'){case2A.start();}case2A.stop();

will be transformed into

import{startas_vite_plugin_require_transform_case2start,stopas_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};constcase2A=location.host=='test' ? null : _vite_plugin_require_transform_case2;if(location.host=='test1'){case2A.start();}case2A.stop();

example B

constcase2B={test:require('test2B').Something}

will be transformed into

import{Somethingas_vite_plugin_require_transform_test2BSomething}from"test2B";constcase2B={test: _vite_plugin_require_transform_test2BSomething};

example C

constcase2c=require('test2C')case2c.forEach((item)=>{console.log('item',item)})

will be transformed into

import_vite_plugin_require_transform_test2Cfrom"test2C";constcase2c=_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.

//same path,different extensionconsttestCaseA=require("caseA.extA?aaa");consttestCaseB=require("caseA.extB?bbb");console.log("caseA",testCaseA)console.log("caseB",testCaseB)

so we need to make a importPathHandler to deal with the situtation

//check out __test__/indexglob("__test__/case3/*.ts",{ignore: "**/*transformed_result.ts"},async(err,files)=>{for(constfileoffiles){constfileContent=readFileSync(file,'utf-8');consttransformedContent=awaitvitePluginRequireTransform({importPathHandler: (requirePath: string)=>{returnrequirePath.replace('.','_').replace('?',"_");}}).transform(fileContent,file);writeFileSync(file.replace('.ts','_transformed_result.ts'),transformedContent.code);}})

will be transformed into

import_vite_plugin_require_transform_caseA_extB_bbbfrom"caseA.extB?bbb";import_vite_plugin_require_transform_caseA_extA_aaafrom"caseA.extA?aaa";//same path,different extensionconsttestCaseA=_vite_plugin_require_transform_caseA_extA_aaa;consttestCaseB=_vite_plugin_require_transform_caseA_extB_bbb;console.log("caseA",testCaseA);console.log("caseB",testCaseB);