https://github.com/sxzz/unplugin-glob
Imports or exports files using glob match for ES Module.
https://github.com/sxzz/unplugin-glob
Last synced: 15 days ago
JSON representation
Imports or exports files using glob match for ES Module.
- Host: GitHub
- URL: https://github.com/sxzz/unplugin-glob
- Owner: sxzz
- License: mit
- Created: 2022-07-31T06:31:37.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-10T03:23:59.000Z (15 days ago)
- Last Synced: 2025-04-10T04:28:20.806Z (15 days ago)
- Language: TypeScript
- Homepage:
- Size: 422 KB
- Stars: 34
- Watchers: 1
- Forks: 5
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# unplugin-glob [](https://npmjs.com/package/unplugin-glob)
[](https://github.com/sxzz/unplugin-glob/actions/workflows/unit-test.yml)
Imports or exports files using glob match for ES Module.
# Features
- ⚡️ Supports Vite, Webpack, Vue CLI, Rollup, esbuild and more, powered by [unplugin](https://github.com/unjs/unplugin).
- 🦾 Full TypeScript support.
## Installation
```bash
npm i unplugin-glob
```
Vite
```ts
// vite.config.ts
import UnpluginGlob from 'unplugin-glob/vite'
export default defineConfig({
plugins: [UnpluginGlob()],
})
```
Rollup
```ts
// rollup.config.js
import UnpluginGlob from 'unplugin-glob/rollup'
export default {
plugins: [UnpluginGlob()],
}
```
esbuild
```ts
// esbuild.config.js
import { build } from 'esbuild'
build({
plugins: [require('unplugin-glob/esbuild')()],
})
```
Webpack
```ts
// webpack.config.js
module.exports = {
/* ... */
plugins: [require('unplugin-glob/webpack')()],
}
```
Vue CLI
```ts
// vue.config.js
module.exports = {
configureWebpack: {
plugins: [require('unplugin-glob/webpack')()],
},
}
```
## Usage
```ts
// To avoid type declaration conflicts, a name is needed for each directory.
import * as all from 'glob:name:./some-path/*.js'
console.log(all.sth)
export * from 'glob:name:./some-path/**'
```
## Configuration
```ts
Glob({
// targets to resolve
include: [/\.m?[jt]sx?$/],
exclude: options.exclude || [/\.d\.ts$/],
root: process.cwd(),
// Filepath to generate corresponding .d.ts files.
// Defaults to both './glob.d.ts' and 'glob-global.d.ts' when provided `true`.
// Set `false` to disable.
dts: false, // boolean or string
})
```
## Sponsors
## License
[MIT](./LICENSE) License © 2022-PRESENT [三咲智子](https://github.com/sxzz)