https://github.com/vite-plugin/vite-require

Like Webpack's require
https://github.com/vite-plugin/vite-require

Last synced: 7 months ago
JSON representation

Like Webpack's require

• Host: GitHub
• URL: https://github.com/vite-plugin/vite-require
• Owner: vite-plugin
• License: mit
• Created: 2022-05-30T04:37:29.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-09-09T13:01:20.000Z (over 3 years ago)
• Last Synced: 2025-02-06T02:38:42.512Z (over 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 111 KB
• Stars: 9
• Watchers: 1
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# vite-require

Like Webpack's require

[![NPM version](https://img.shields.io/npm/v/vite-require.svg)](https://npmjs.org/package/vite-require)

[![NPM Downloads](https://img.shields.io/npm/dm/vite-require.svg)](https://npmjs.org/package/vite-require)

English | [简体中文](https://github.com/vite-plugin/vite-require/blob/main/README.zh-CN.md)

✅ dynamic-require similar to 👉 [Webpack](https://webpack.js.org/guides/dependency-management/#require-with-expression) `require('./foo/' + bar)`

📦 Out of the box  

🔨 Work only in the `vite serve` phase  

## Install

```bash

npm i vite-require -D

```

## Usage

```js

import { viteRequire } from 'vite-require'

export default {

  plugins: [

    viteRequire(/* options */)

  ]

}

```

## API

viteRequire([options])

```ts

export interface Options {

  extensions?: string[]

  filter?: (id: string) => false | void

  dynamic?: {

    /**

     * 1. `true` - Match all possibilities as much as possible, More like `webpack`

     * 2. `false` - It behaves more like `@rollup/plugin-dynamic-import-vars`

     * @default true

     */

    loose?: boolean

  }

}

```