@wroud/vite-plugin-asset-resolver
Version:
A Vite plugin for custom asset resolution, mapping 'dist' to 'src' directories and resolving files like SVG, images, and other resources. Supports multiple directory aliases and file extensions for flexible module resolution.
61 lines (41 loc) • 1.82 kB
Markdown
[![ESM-only package][package]][package-url]
[![NPM version][npm]][npm-url]
[]: https://img.shields.io/badge/package-ESM--only-ffe536.svg
[]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[]: https://img.shields.io/npm/v/@wroud/vite-plugin-asset-resolver.svg
[]: https://npmjs.com/package/@wroud/vite-plugin-asset-resolver
`@wroud/vite-plugin-asset-resolver` is a flexible Vite plugin that resolves asset imports by mapping 'dist' directories to 'src' directories, supporting custom file extensions. It enables custom asset resolution when Vite’s default behavior fails, particularly for complex project structures.
- **Custom Asset Resolution**: Resolves asset imports (e.g., images, SVG) from `src` instead of `dist`.
- **Multiple Aliases**: Supports custom aliases for both `src` and `dist` directories.
- **Custom Extensions**: Allows configuring which file extensions should be resolved.
## Installation
Install via npm:
```sh
npm install @wroud/vite-plugin-asset-resolver
```
Install via yarn:
```sh
yarn add @wroud/vite-plugin-asset-resolver
```
## Documentation
For detailed usage and API reference, visit the [documentation site](https://wroud.dev).
## Example
```ts
import { defineConfig } from "vite";
import { assetResolverPlugin } from "@wroud/vite-plugin-asset-resolver";
export default defineConfig({
plugins: [
assetResolverPlugin({
dist: ["dist", "build"],
src: ["src", "source"],
extensions: [".svg", ".png", ".jpg"],
}),
],
});
```
All notable changes to this project will be documented in the [CHANGELOG](./CHANGELOG.md) file.
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.