gem-hunter

Refurbish

Features

Installation

npm install refurbish
# or
pnpm i refurbish
# or
yarn add refurbish

npm install refui

Usage

Bun

# bunfig.toml

[serve.static]
plugins = ["refurbish/bun", ...other plugins]

Vite

// vite.config.js
import { defineConfig } from 'vite';
import { refurbish } from 'refurbish/vite';

export default defineConfig({
	plugins: [
		refurbish(),
		// ... other plugins
	],
});

Rollup

// rollup.config.js
import { refurbish } from 'refurbish/rollup';

export default {
	plugins: [
		refurbish(),
		// ... other plugins
	],
};

Webpack

// webpack.config.js
import { Refurbish } from 'refurbish/webpack';

export default {
	// ...
	plugins: [
		new Refurbish(),
		// ... other plugins
	],
};

Rspack

// rspack.config.js
import { Refurbish } from 'refurbish/webpack';

export default {
	// ...
	plugins: [
		new Refurbish(),
		// ... other plugins
	],
};

Options

refurbish({
	// File patterns to include (default: ['**/*.jsx', '**/*.tsx', '**/*.mdx'])
	include: ['**/*.jsx', '**/*.tsx'],

	// File patterns to exclude
	exclude: ['**/node_modules/**'],

	// Import source for HMR setup function (default: 'refui/hmr')
	importSource: 'refui/hmr',

	// Explicitly enable/disable the plugin.
	// Default: enabled in development, disabled in production.
	enabled: true
})

new Refurbish({
	// File patterns to include (default: ['**/*.jsx', '**/*.tsx', '**/*.mdx'])
	include: ['**/*.jsx', '**/*.tsx'],

	// File patterns to exclude
	exclude: ['**/node_modules/**'],

	// Import source for HMR setup function (default: 'refui/hmr')
	importSource: 'refui/hmr',

	// Explicitly enable/disable the plugin.
	// Default: enabled in development, disabled in production.
	enabled: true
})

Options Details

License