Skip to content

liuyunhe/vite-plugin-string-converter

Repository files navigation

Vite Plugin String Converter

Converts text files to modules. Such as .vs, .fs, .vert, .frag, .glsl, wgsl etc.

import fragment from './fragment.glsl'
console.log(fragment)

Preface

Most cases, you don't need this plugin.

vite already supports suffix ?raw, import as string.

import fragment from './fragment.glsl?raw'

Installation

npm install --save-dev @shepardliu/vite-plugin-string-converter

Usage

// vite.config.js
import vitePluginString from '@shepardliu/vite-plugin-string-converter'

export default {
  plugins: [
    vitePluginString()
  ]
}

Options

vitePluginString(options)
{
  /* Default */
  include: [
    '**/*.vs',
    '**/*.fs',
    '**/*.vert',
    '**/*.frag',
    '**/*.glsl',
    '**/*.wgsl',
  ],

  /* Default: undefined */
  exclude: 'node_modules/**',

  /* Default: true */
  // if true, using logic from rollup-plugin-glsl
  compress: true,

  // if a function, will instead of default compress function
  // returns string|Promise<string>
  compress(code) {
    return code.replace(/\n/g, '')
  }
}

About

A vite plugin of transforming string to modules

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published