bun-plugin-glsl/build/index.d.ts

Import, inline (and minify) GLSL/WGSL shader files

import type { LoadingOptions } from '../plugin/src/types';
import type { BunPlugin } from 'bun';

/**
 * @typedef {Object} PluginOptions
 * @description Plugin config object
 * 
 * @property {RegExp}      include                 RegExp of file extensions to import
 * @property {boolean}     removeDuplicatedImports Automatically remove an already imported chunk
 * @property {boolean}     warnDuplicatedImports   Warn if the same chunk was imported multiple times
 * @property {string}      defaultExtension        Shader suffix to use when no extension is specified
 * @property {string}      importKeyword           Keyword used to import shader chunks
 * @property {Minify}      minify                  Minify output shader code
 * @property {boolean}     watch                   Recompile shader on change
 * @property {string}      root                    Directory for root imports
 * 
 * @default {
 *   include: /\.(glsl|wgsl|vert|frag|vs|fs)$/,
 *   removeDuplicatedImports: false,
 *   warnDuplicatedImports: true,
 *   defaultExtension: 'glsl',
 *   importKeyword: '#include',
 *   minify: false,
 *   watch: true,
 *   root: '/'
 * }
 */
export type PluginOptions = Partial<LoadingOptions> & {
  include?: RegExp;
  watch?: boolean;
};

/**
 * @function
 * @name glsl
 * @description Plugin entry point to import,
 * inline, (and minify) GLSL/WGSL shader files
 * 
 * @see {@link https://bun.sh/docs/runtime/plugins}
 * @link https://github.com/UstymUkhman/bun-plugin-glsl
 * 
 * @param {PluginOptions} options Plugin config object
 * 
 * @returns {BunPlugin} Bun plugin that converts shader code
 */
export default function ({
  removeDuplicatedImports,
  warnDuplicatedImports,
  defaultExtension,
  importKeyword,
  include,
  minify,
  watch,
  root
}?: PluginOptions): BunPlugin;