@fallen_leaves/esbuild-plugin-html
v1.0.5
Published
An esbuild html-template that uses ejs as a template engine
Downloads
7
Maintainers
fallen_leavesReadme
使用ejs作为模板引擎的esbuild html模板插件
安装
npm install -D @fallen_leaves/esbuild-plugin-html
使用
如果设置format: 'esm', js文件会以<script type="module" src="output/output.js"></script>模式加载
// esbuild.config.js
import { build } from 'esbuild'
import esbuildPluginHtml from '@fallen_leaves/esbuild-plugin-html'
build({
entryPoints: ['src/main.js'],
outfile: 'output/static/main.js',
format: 'iife', // 'esm'
bundle: true,
sourcemap: true,
plugins: [
esbuildPluginHtml({
template: 'public/index.html',
minify: true,
compile: true,
filename: 'output/index.html',
renderData: {
title: 'title'
},
publicPath: './'
})
]
})配置项
template
Type: String
Default: <!DOCTYPE html><html lang="en">.....
html模板字符串或者模板文件绝对路径，支持ejs语法。例如：
// 1.文件路径
esbuildPluginHtml({
template: 'public/index.html'
})
// 2.模板字符串
esbuildPluginHtml({
template: `
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title><%= title%></title>
</head>
<body>
<div id="app"></div>
</body>
</html>
`
})minify
Type: Boolean | MinifyOptions
Default: true
是否对html文本内容进行压缩。详细配置请查看MinifyOptions
// 1.布尔值控制
esbuildPluginHtml({
minify: false // true
})
// 2.详细配置
esbuildPluginHtml({
minify: {
collapseWhitespace: true,
collapseInlineTagWhitespace: true,
removeComments: true,
...
}
})filename
Type: String
Default: 'index.html'
模板文件输出路径及文件名称。
esbuildPluginHtml({
filename: './path/to/output.html'
})compile
Type: Boolean
Default: true
是否编辑ejs语法，配合renderData字段使用。
renderData
Type: Record<string, any>
Default: {}
设置要注入给ejs模板的数据。使用方法见
esbuildPluginHtml({
compile: true, // false
renderData: {
title: '鸡你太美'
}
})原始模板：
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title><%= title%></title>
</head>
<body>
<div id="app"></div>
</body>
</html>输出后：
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>鸡你太美</title>
</head>
<body>
<div id="app"></div>
</body>
</html>publicPath
Type: String
Default: '/'
设置输出后script、link标签的公共路径
esbuildPluginHtml({
publicPath: 'https://www.cdn-domain.com/'
})输出结果：
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>title</title>
<link rel="stylesheet" href="https://www.cdn-domain.com/output/static/main.css">
<link href="https://www.cdn-domain.com/output/static/main.css.map">
<link href="https://www.cdn-domain.com/output/static/main.js.map">
</head>
<body>
<div id="app"></div>
<script src="https://www.cdn-domain.com/output/static/main.js"></script>
</body>
</html>preload
Type: LinkItem[]
Default: false
预加载地址列表
type LinkItem = {
href: string // 预加载地址
as: 'script' | 'stylesheet' | 'map' | 'icon' // 预加载文件用途
iconType?: string //.e.g 'image/png'
enableESM?: boolean // 默认 false, 如果为 true, 编译后为<script type="module">
}esbuildPluginHtml({
preload: [{
href: 'https://www.cdn-domain.com/static/sdk.js'
as: 'script',
enableESM: true
}]
})输出结果：
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>title</title>
</head>
<body>
<div id="app"></div>
<script type="module" src="https://www.cdn-domain.com/output/static/main.js"></script>
</body>
</html>chunks
Type: string[] | undefined
Default: undefined
当使用splitting: true时，选择要加载的chunk列表, 不设置chunks或者值为[]时，则加载全部输出结果
// esbuild.config.js
import { build } from 'esbuild'
import esbuildPluginHtml from '@fallen_leaves/esbuild-plugin-html'
build({
entryPoints: ['src/main.js'],
outdir: 'output/static',
format: 'esm',
bundle: true,
sourcemap: true,
splitting: true,
plugins: [
esbuildPluginHtml({
template: 'public/index.html',
filename: 'output/index.html',
chunks: ['main', 'async-module']
})
]
})源码：
// async-module.js
export default asyncModule = 'async module'
// main.js
const asyncModule = (async () => await import('./async-module.js'))()
asyncModule.then(res => {
console.log(res.default)
})输出结果：
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>title</title>
</head>
<body>
<div id="app"></div>
<script type="module" src="path/to/main.js"></script>
<script type="module" src="path/to/async-module.js"></script>
</body>
</html>