vite-plugin-page-html

English | 中文

一个用于处理 HTML 页面的 Vite 插件，集成了多页面配置(MPA)、EJS 模板支持和 HTML 压缩功能。其多页面配置方式与 vue-cli 的pages选项 类似。

Features

- 📚 支持单页面 (SPA) 和多页面 (MPA) 模式
- 📡 自定义页面入口别名，轻松配置路径
- 🔑 支持共用或自定义 template 和 entry
- 🗳 支持 EJS 模板语法
- 🗜 提供 HTML 文件压缩功能
- 🔗 方便引入外部资源库 (CDN)

Why ?

虽然 Vite 原生支持多页应用，但它需要以html作为入口，这意味着必须存在这些html文件。

如果将html文件放置其他目录，那么在访问时需要添加多余的中间目录。与此同时在打包后的文件目录也存在多余的中间目录。

虽然目前也有一些Vite插件能够解决这些问题，但使用后并不能满足我之前的项目，所以便有了这个插件 vite-plugin-page-html。

Install

- node >= 14.x
- vite >= 2.x

``bash
npm install vite-plugin-page-html -D
`

Usage

在 html 中使用 EJS 模板语法, 比如 index.html :

> 说明：环境变量(含内建变量)可直接使用。<%= BASE_URL %>

`html













`

> 🚨 提醒：
> 若在 vite.config.js 中配置了 entry ，则应删除 html模板 内的入口script标签。(默认自动删除入口标签)

$3

单页应用配置，在 vite.config.js 中可随意指定 访问路径(page)、入口(entry)和 html(template)文件。

`js
// vite.config.js
import PageHtml from 'vite-plugin-page-html'

export default defineConfig({
plugins: [
// ... plugins
PageHtml({
page: 'index',
template: 'src/index.html',
title: 'Vue App',
}),
],
})
`

$3

多页应用配置，可通过配置 page 对象的 key 来指定访问路径，其他配置同 单页应用。

`js
// vite.config.js
import PageHtml from 'vite-plugin-page-html'

export default defineConfig({
plugins: [
// ... plugins
PageHtml({
template: 'src/index.html',
page: {
index: 'src/main.js',
about: {
entry: 'src/about/main.js',
title: 'About Page',
},
'product/list': {
entry: 'src/product/main.js',
template: 'src/product/index.html',
title: 'Product list',
},
},
}),
],
})
`

启动 dev serve 服务，并打开浏览器：

- http://localhost:3000/index.html
Use src/index.html as the template and src/main.js as the entry.
- http://localhost:3000/about.html
Use src/index.html as the template and src/about/main.js as the entry.
- http://localhost:3000/product/list.html
Use src/product/index.html as the template and src/product/main.js as the entry.

项目构建后的目录结构与开发保持一致：

`
├── dist
│ ├── assets
│ ├── favicon.ico
│ ├── index.html
│ ├── about.html
│ ├── product
│ │ └── list.html
│ └──
`

Configuration

`js
PageHtml(/ Options /)
`

$3

`typescript
PageHtml({
page: string | PageConfig;
entry?: string;
template?: string;
title?: string;
minify?: boolean | MinifyOptions;
ejsOptions?: EjsOptions;
inject?: InjectOptions
})
`

| property | default | description |
| ------------ | ------------- | ------------------------------------------------------------------------------------------------------------ |
| page | index | requred 页面配置项。若为string，则值为页面path。PageConfig 详见。 |
| entry | src/main.js | 入口文件路径 (注意： entry文件会自动添加到html内，不需要手动添加) |
| template | index.html | html文件路径（global） |
| title | - | 页面标题（global） |
| minify | false | 是否压缩html，MinifyOptions 详见 |
| ejsOptions | - | ejs 配置项, 详见 |
| inject | - | 需要注入 html ejs模板的数据. InjectOptions @see |

> 🚨 WARNING: 入口文件 entry 将会自动添加到 html 内，不需要手动写入，请删除。

$3

`typescript
interface InjectOptions {
/**
* @see https://cn.vitejs.dev/guide/api-plugin.html#vite-specific-hooks
*/
tags?: HtmlTagDescriptor[]
/**
* page data. Rendering via ejs : <%= pageHtmlVitePlugin.data %>
*/
data?: Record
}

interface HtmlTagDescriptor {
tag: string
attrs?: Record
children?: string | HtmlTagDescriptor[]
/**
* 默认： 'head-prepend'
*/
injectTo?: 'head' | 'body' | 'head-prepend' | 'body-prepend'
}
`

| property | type | default | description |
| -------- | --------------------- | ------- | ------------------------------------------------------------------------------- |
| tags | HtmlTagDescriptor[] | [] | 需要注入的标签列表. HtmlTagDescriptor |
| data | object | - | 需要注入的页面数据（global），通过ejs渲染。<%= pageHtmlVitePlugin.data %> |

$3

`typescript
{
[path: string]: string | PageOptions;
}
`

| property | default | description |
| -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| path | - | 单个页面配置项。
1. path 将作为输出路径
2. path的值若为string，则为入口文件路径。
PageOptions 详见。 |

$3

`typescript
{
entry: string;
template?: string;
title?: string;
inject?: InjectOptions;
}
`

| property | default | description |
| ---------- | ------------ | ------------------------------------------------------------------- |
| entry | - | required 页面入口文件路径 |
| template | index.html | 模板，默认为全局template |
| title | - | 标题，默认为全局title |
| inject | - | 需要注入 html ejs模板的数据. InjectOptions @see |

Externals

我们在优化项目打包时，一般会将常用的外部库通过外链的方式引入（CDN）。这可以减少构建时间，并且提高生产环境中页面加载速度。

目前 rollup 的 output.globals 仅在format 是 iife 或 umd 时有效。如果format 是 es 时就需要通过第三方插件将外部模块映射到全局变量。

我比较推荐 rollup-plugin-external-globals 和 vite-plugin-externals 这两款插件。

下面结合 rollup-plugin-external-globals 实现生产环境引入cdn文件库。

`html
// index.html










<% for (var i in pageHtmlVitePlugin.data.styles) { %>

<% } %>




<%- pageHtmlVitePlugin.data.injectScript %>


<% if(PROD) { %> <% for (var i in pageHtmlVitePlugin.data.scripts) { %>

<% } %> <% } %>


`

`js
// vite.config.js

import { defineConfig } from 'vite'
import PageHtml from 'vite-plugin-page-html'
import externalGlobals from 'rollup-plugin-external-globals'

export default defineConfig({
// ...
plugins: [
// ... plugins
PageHtml({
page: {
index: 'src/main.js',
about: {
entry: 'src/about/main.js',
title: '关于我们',
},
},
template: 'public/template.html',
inject: {
data: {
styles: ['https://cdn.jsdelivr.net/npm/element-ui@2.15.10/lib/theme-chalk/index.css'],
scripts: [
'https://cdn.jsdelivr.net/npm/vue@2.7.10/dist/vue.min.js',
'https://cdn.jsdelivr.net/npm/element-ui@2.15.10/lib/index.js',
'https://cdn.jsdelivr.net/npm/axios@0.24.0/dist/axios.min.js',
],
injectStyle: ,
injectScript:
},
},
}),
],
build: {
rollupOptions: {
plugins: [
externalGlobals({
vue: 'Vue',
axios: 'axios',
'element-ui': 'ELEMENT',
}),
],
},
},
})
``

License

MIT

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.