@takinabradley/htmlbunplugin
v1.0.9
Published
A quick and dirty analogue to HtmlWebpackPlugin for Bun's bundler.
Downloads
45
Readme
HtmlBunPlugin
A quick and dirty analogue to HtmlWebpackPlugin for Bun's bundler.
Installation
bun install @takinabradley/htmlbunpluginUsage
In a build file, import the HtmlBunPlugin factory, and add it to the plugin list when you run Bun.build:
// build.js in root of project
import HtmlBunPlugin from '@takinabradley/htmlbunplugin'
import templateHtmlPath from './src/index.html'
Bun.build({
entrypoints: ['src/index.js'],
outdir: './out',
plugins: [HtmlBunPlugin({
// Accepts an optional config object
filename: 'whatever-you-want.html', // defaults to index.html
title: 'My App', // defaults to 'Bun App'
template: templateHtmlPath // provide a template .html file to inject scripts and title into
publicPath: './' // the base path that the entrypoint will be fetched from, defaults to './'
})]
})Assuming ./src/index.html looked like the following:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head>
<body>
<h1>This is my template file!</h1>
</body>
</html>The above code would output a whatever-you-want.html in the ./out directory that looks like this:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
<!-- The following <script> tags added via HTMLBunPlugin -->
<script src='./index.js' defer></script>
<!-- End of HtmlBunPlugin script tags -->
<!-- The following <title> added via HtmlBunPlugin -->
<title>My App</title>
</head>
<body>
<h1>This is my template file!</h1>
</body>
</html>Contributing
Building
If you'd like to help contribute to additional features, you can build a new version of the plugin from src/ with the following command:
bun build.bun.tsMake sure you install dependencies first with
bun installThis project was created using bun init in bun v1.0.1. Bun is a fast all-in-one JavaScript runtime.