@rollup/plugin-html 使用及原理介绍

2024-03-29 05:04

本文主要是介绍@rollup/plugin-html 使用及原理介绍,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

@rollup/plugin-html 使用及原理介绍

一款用于自动创建 html 文件并导入 rollup 打包文件进行展示的插件。

安装

npm install @rollup/plugin-html -D

使用

import html  from '@rollup/plugin-html';module.exports = {input: 'index.js',output: {file: 'dist.js',},plugins: [html()]
};

在打包生成文件的同级目录中生成一个 index.html 文件,并自动引入打包文件。

<!doctype html>
<html lang="en"><head><meta charset="utf-8"><title>Rollup Bundle</title></head><body><script src="dist.js" type="module"></script></body>
</html>

配置

attributes

Type: Object

Default: { html: { lang: 'en' }, link: null, script: null }

为 html、link、script 标签添加额外属性。

通过 key-value 的形式来添加标签属性,分别代表了 html 元素中的 属性名 和 值。

对于输出格式是 esm 的,会自动在 script 中添加 {type: ‘module’}属性。

fileName

Type: String

Default: 'index.html'

定义生成的 html 文件名。

meta

Type: Array[...object]

Default: [{ charset: 'utf-8' }]

用于定义 html 文件中 meta 元素的属性。

publicPath

Type: String

Default: ''

TODO 不确定

title

Type: String

Default: 'Rollup Bundle'

声明 html 文件的 title 值。

template

Type: Function

Default: internal function
Returns: String

用于自定义生成 html 文件。函数的格式如下:

const template = ({ attributes, bundle, files, publicPath, title }) => { ... }
  • attributes:获取到传递给插件的参数
  • bundle:包含 AssetInfo 或者 ChunkInfo 的对象。
  • files:AssetInfo 或者 ChunkInfo 中 isEntry 为 true 的文件,及资源文件(isAsset: true) 的文件
  • publicPath:传递的 publicPath 值。
  • title: 传递的 title 值

默认的 html 模板是

<!DOCTYPE html>
<html ${attributes}><head>${metas}<title>${title}</title>${links}</head><body>${scripts}</body>
</html>

之后会根据传参自动填充上去。

支持输出的格式

该插件默认支持 esm (es), iife, 和 umd 格式。如果是其他格式,可以在 template 配置中手动定义如何解析。

amd

使用 requireJS 语法,只允许一个 script 标签。如果导出多个文件,那么需要通过一个代理文件来导入。RequireJs 的使用需要手动引入一个依赖 https://requirejs.org/docs/start.html

system

首先需要一个独立的 script 标签,里边必须先包含了 s.js 这个加载器。之后才能使用:

<script>System.import('./batman.js')</script>

原理

在 generateBundle 钩子中调用 emitFile 生成一个 html 文件。

async generateBundle(output, bundle) {...const htmlFile: EmittedAsset = {type: 'asset',source,name: 'Rollup HTML Asset',fileName};this.emitFile(htmlFile);
}

模板生成:

const defaultTemplate = async ({attributes,files,meta,publicPath,title
}: RollupHtmlTemplateOptions) => {// 给入口文件生成 script 标签const scripts = (files.js || []).map(({ fileName }) => {const attrs = makeHtmlAttributes(attributes.script);return `<script src="${publicPath}${fileName}"${attrs}></script>`;}).join('\n');// 给入口资源文件生成 link 标签const links = (files.css || []).map(({ fileName }) => {const attrs = makeHtmlAttributes(attributes.link);return `<link href="${publicPath}${fileName}" rel="stylesheet"${attrs}>`;}).join('\n');// 生成 meta 标签const metas = meta.map((input) => {const attrs = makeHtmlAttributes(input);return `<meta${attrs}>`;}).join('\n');return `
<!doctype html>
<html${makeHtmlAttributes(attributes.html)}><head>${metas}<title>${title}</title>${links}</head><body>${scripts}</body>
</html>`;
};

这篇关于@rollup/plugin-html 使用及原理介绍的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/857667

相关文章

使用Docker构建Python Flask程序的详细教程

《使用Docker构建PythonFlask程序的详细教程》在当今的软件开发领域,容器化技术正变得越来越流行,而Docker无疑是其中的佼佼者,本文我们就来聊聊如何使用Docker构建一个简单的Py... 目录引言一、准备工作二、创建 Flask 应用程序三、创建 dockerfile四、构建 Docker

Python使用vllm处理多模态数据的预处理技巧

《Python使用vllm处理多模态数据的预处理技巧》本文深入探讨了在Python环境下使用vLLM处理多模态数据的预处理技巧,我们将从基础概念出发,详细讲解文本、图像、音频等多模态数据的预处理方法,... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核

Python使用pip工具实现包自动更新的多种方法

《Python使用pip工具实现包自动更新的多种方法》本文深入探讨了使用Python的pip工具实现包自动更新的各种方法和技术,我们将从基础概念开始,逐步介绍手动更新方法、自动化脚本编写、结合CI/C... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核

Conda与Python venv虚拟环境的区别与使用方法详解

《Conda与Pythonvenv虚拟环境的区别与使用方法详解》随着Python社区的成长,虚拟环境的概念和技术也在不断发展,:本文主要介绍Conda与Pythonvenv虚拟环境的区别与使用... 目录前言一、Conda 与 python venv 的核心区别1. Conda 的特点2. Python v

Spring Boot中WebSocket常用使用方法详解

《SpringBoot中WebSocket常用使用方法详解》本文从WebSocket的基础概念出发,详细介绍了SpringBoot集成WebSocket的步骤,并重点讲解了常用的使用方法,包括简单消... 目录一、WebSocket基础概念1.1 什么是WebSocket1.2 WebSocket与HTTP

C#中Guid类使用小结

《C#中Guid类使用小结》本文主要介绍了C#中Guid类用于生成和操作128位的唯一标识符,用于数据库主键及分布式系统,支持通过NewGuid、Parse等方法生成,感兴趣的可以了解一下... 目录前言一、什么是 Guid二、生成 Guid1. 使用 Guid.NewGuid() 方法2. 从字符串创建

Python使用python-can实现合并BLF文件

《Python使用python-can实现合并BLF文件》python-can库是Python生态中专注于CAN总线通信与数据处理的强大工具,本文将使用python-can为BLF文件合并提供高效灵活... 目录一、python-can 库:CAN 数据处理的利器二、BLF 文件合并核心代码解析1. 基础合

Python使用OpenCV实现获取视频时长的小工具

《Python使用OpenCV实现获取视频时长的小工具》在处理视频数据时,获取视频的时长是一项常见且基础的需求,本文将详细介绍如何使用Python和OpenCV获取视频时长,并对每一行代码进行深入解析... 目录一、代码实现二、代码解析1. 导入 OpenCV 库2. 定义获取视频时长的函数3. 打开视频文

Spring IoC 容器的使用详解(最新整理)

《SpringIoC容器的使用详解(最新整理)》文章介绍了Spring框架中的应用分层思想与IoC容器原理,通过分层解耦业务逻辑、数据访问等模块,IoC容器利用@Component注解管理Bean... 目录1. 应用分层2. IoC 的介绍3. IoC 容器的使用3.1. bean 的存储3.2. 方法注

Python内置函数之classmethod函数使用详解

《Python内置函数之classmethod函数使用详解》:本文主要介绍Python内置函数之classmethod函数使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地... 目录1. 类方法定义与基本语法2. 类方法 vs 实例方法 vs 静态方法3. 核心特性与用法(1编程客