unplugin-raw

unplugin-raw

Transform file to a default-export string, and can be transformed by esbuild.

Installation

npm i -D unplugin-raw

npm i -D esbuild # Optional, if you want to transform TypeScript to JavaScript

Vite

// vite.config.ts
import Raw from 'unplugin-raw/vite'

export default defineConfig({
  plugins: [Raw()],
})

Rollup

// rollup.config.js
import Raw from 'unplugin-raw/rollup'

export default {
  plugins: [Raw()],
}

Rolldown

// rolldown.config.js
import Raw from 'unplugin-raw/rolldown'

export default {
  plugins: [Raw()],
}

esbuild

// esbuild.config.js
import { build } from 'esbuild'

build({
  plugins: [require('unplugin-raw/esbuild')()],
})

Options

export interface TransformOptions {
  /** @default [/\.[cm]?[jt]sx?$/] */
  include?: FilterPattern
  /** @default [/node_modules/] */
  exclude?: FilterPattern
  /** @default {} */
  options?: EsbuildTransformOptions
}

export interface Options {
  /** @default 'pre' */
  enforce?: 'pre' | 'post' | undefined
  /**
   * Transform
   * @default false
   */
  transform?: TransformOptions | boolean
}

Usage

import text from './js.js?raw'
import text2 from './jsx.jsx?raw'
import text3 from './ts.ts?raw'

// Import attributes (Rolldown doesn't support this syntax)
import text4 from './with.js' with { type: 'text' }

Sponsors

License

MIT License © 2023-PRESENT Kevin Deng