npm 包 @practo/manifest-revision-formatter-webpack 使用教程

前言

在 Web 开发中,我们常常需要对静态资源进行版本控制,比如将 style.css?v=1.0.0 转化为 style.css?v=1.0.1。而随着项目越来越大,手动修改静态资源版本号的难度也越来越大。这时候,我们可以使用 npm 包 @practo/manifest-revision-formatter-webpack 来自动生成静态资源版本号,并集成于 Webpack 构建流程中。

功能介绍

@practo/manifest-revision-formatter-webpack 是一个集成于 Webpack 的插件,它可以在 Webpack 构建成功后自动为生成的静态资源文件名添加版本号,并生成一个对应的版本清单文件,方便后续使用。

该插件支持以下功能:

  1. 根据使用者定义的规则生成新的静态资源文件名,如:app.[hash].js
  2. 生成一个版本清单文件,来记录静态资源文件名和版本号的对应关系
  3. 为所有匹配到的静态资源文件名添加版本号,包括 js、css、图片等

安装

该插件可以通过 npm 进行安装。

--- ------- ------------------------------------------- ----------

使用方法

在 Webpack 的配置文件中,我们可以通过以下方式引入该插件:

----- ------------------------------- - -------------------------------------------------------

-------------- - -
    -----
    ------- -
        --------- ------------------------
        -----
    --
    -------- -
        --- ---------------------------------
            --------- ----------------------
            ------- ---
            --------------- -----
            ------------ -----------
            ------------ ------------- ----------
            ------------------------ -----
            --------------------- -----------------------
        --
    -
--

以下是各个参数的解释:

  • **fileName**:清单文件的文件名,默认为 asset-manifest.json
  • **prefix**:添加前缀,默认为空字符串
  • **applyFileNames**:是否为静态资源文件名添加版本号,默认为 true
  • **ignorePaths**:忽略匹配到的文件路径,可以为字符串或正则表达式
  • **requireGenerateManifest**:是否为生成的文件自动生成一个调用文件,默认为 true
  • **generateManifestPath**:自动生成的调用文件路径,默认为 /src/utils/version.js

示例代码

以下是一个基本的 Webpack 配置示例:

----- ---- - ----------------
----- ------- - -------------------
----- ------------------------------- - -------------------------------------------------------

-------------- - -
  ------ -----------------
  ------- -
    --------- ------------------------
    ----- ----------------------- -------
  --
  -------- -
    --- ----------------------------------
    --- ---------------------------------
  -
--

在 Webpack 构建成功后,将会在 dist/ 目录下生成以下两个文件:

-----------------------------
-------------------

其中,YOUR_CHUNKHASH_CODE 为 Webpack 自动生成的代码块哈希值。asset-manifest.json 文件将包含类似以下内容:

-
    ------------ ---------------------------------
    ----------- --------------------------------
    ------------------ --------------------------
-

如果将 requireGenerateManifest 设置为 true,我们可以在 Webpack 配置文件中添加以下代码:

----- -- - --------------
----- ------------ - ----------------------- ------- -----------------------
-----------------
  ----------------------- ------ --------------
  ------- ------- ------------------------------- ----------
--

这将会在 /src/version.js 文件中生成类似以下内容:

------ ------- ---------------------------------------------------------------------------------------------------------------------------------------

我们可以在其他 JavaScript 文件中通过 import version from './version.js' 的方式引入该清单文件,来动态加载静态资源文件。

结语

@practo/manifest-revision-formatter-webpack 可以为我们自动生成静态资源版本号,并将版本信息存储到版本清单文件中。这对于项目的维护和发布是很有帮助的。在实际项目中,我们可以根据需要进行个性化的配置,以将插件的功能发挥到最大程度。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/600567ff81e8991b448e424e


猜你喜欢

  • npm 包 nueah-net 使用教程

    npm 是一个非常重要的 Node.js 包管理器,可以通过它来方便地安装和管理各种 Node.js 模块和工具。这次我们要介绍的是一个 npm 包,名为 nueah-net。

    3 年前
  • npm 包 nueah-process 使用教程

    简介 nueah-process 是一个包含多个前端工具方法的 npm 包,可以帮助前端开发者更轻松地处理数据、字符串、时间等。本文将详细介绍如何使用这个 npm 包,在实践中掌握这些工具方法。

    3 年前
  • npm 包 @i2/runonpage 使用教程

    前言 在现代的 Web 开发中,前端技术与日俱增,我们的代码也逐渐变得越来越复杂。为了更高效地管理和组织代码,我们常常会使用各种工具和框架。在这些工具和框架的背后,有一个我们常常忽略的神秘的存在,那就...

    3 年前
  • npm 包 lluchmk-ng2-table 使用教程

    在前端开发中,表格是一个非常常见的组件。为了简化表格组件的开发和使用,我们可以使用现成的开源组件,其中 lluchmk-ng2-table 就是一个非常不错的选择。

    3 年前
  • npm 包 rollup-plugin-strip-prop-types 使用教程

    前言 在前端开发中,我们使用许多工具和技术来提高我们的开发效率。npm 包是其中一种非常重要的工具,它提供了许多好用的库和工具,让我们的开发变得更加简单。其中,rollup-plugin-strip-...

    3 年前
  • npm 包 Platzom-mtn 使用教程

    什么是 Platzom-mtn Platzom-mtn 是一个前端开发工具,包含多种字符串转换方法,可用于对字符串进行处理和操作。 如何安装 Platzom-mtn 要使用 Platzom-mtn,您...

    3 年前
  • npm 包 dfinity-tx 使用教程

    在使用区块链应用程序时,与区块链进行交互的事情之一是在区块链上执行事务。 dfinity-tx 是一个 Node.js 模块,这是与 Dfinity 区块链进行交互的一种方式。

    3 年前
  • npm 包 vue-auto-float-directive 使用教程

    vue-auto-float-directive 是一个 Vue 框架的 npm 包,该包提供了一种简单易用的方式,让页面中的某些元素可以随着用户的滚动而滑动或者固定在页面的某个位置上。

    3 年前
  • npm 包 get-own-property 的使用教程

    简介 get-own-property 是一个 npm 包,用于获取对象的自有属性。它可以帮助前端开发者更方便地处理对象属性。 安装 在终端或命令行窗口中,执行以下命令来安装 get-own-prop...

    3 年前
  • npm 包 kafka-observable 使用教程

    在前端开发中,处理流式数据是一个很常见的场景。Kafka 是一种流式数据平台,它可以处理海量消息并支持高吞吐量和高可靠性,因此在大规模互联网应用中得到了广泛应用。kafka-observable 是一...

    3 年前
  • npm 包 lintworm 使用教程

    什么是 lintworm? lintworm 是一种非常有用的 npm 包,它可以帮助程序员在编写代码时精确地遵循一系列代码风格和规范。lintworm 通过对代码进行一系列的静态分析,来发现代码中可...

    3 年前
  • npm 包 personity-report 使用教程

    介绍 在前端开发中,我们经常会使用各种 npm 包来帮助我们完成任务。其中,personity-report 是一个可以帮助我们生成人格报告的 npm 包,通过分析文本,自动生成一个与文本相关的人格描...

    3 年前
  • npm 包 react-recaptcha-dev 使用教程

    在前端开发中,有些功能需要借助第三方库来实现。recaptcha 是一种反人类行为识别技术,可以在网站提交表单时防止机器人自动提交。如果你使用 React 来开发网站,那么 react-recaptc...

    3 年前
  • npm 包 rollup-plugin-hash 使用教程

    前置知识 在学习 rollup-plugin-hash 之前,你需要具备以下知识: 熟悉 npm 管理包的基本操作 熟悉 Rollup 的基本使用方法 什么是 rollup-plugin-hash...

    3 年前
  • npm 包 thobitcore 使用教程

    介绍 thobitcore 是一个 Node.js 包,用于实现比特币和其他加密货币的钱包和区块链相关应用程序。它是一个高可扩展性的工具,提供了许多先进的功能,包括区块链解析、私钥管理、交易管理等等。

    3 年前
  • npm 包 vue-navigation-plugin 使用教程

    本文将为大家介绍一款名为 vue-navigation-plugin 的 npm 包,它提供了一种方便的方式来实现前端路由的管理和跳转。本文将详细介绍这个包的使用方法以及其背后的技术原理,帮助读者更好...

    3 年前
  • npm 包 @noticeable/remove-markdown 使用教程

    在前端开发中,我们经常需要将 Markdown 格式的文本转换为普通的文本或 HTML 格式,以便在网页中进行展示或处理。而 @noticeable/remove-markdown 是一款 npm 包...

    3 年前
  • npm 包 input-ip 使用教程

    在进行前端开发中,经常需要获取用户的 IP 地址。今天,我们将介绍一个名为 input-ip 的 npm 包,它可以帮助我们简单地获取用户的 IP 地址。 input-ip 如何工作 该 npm 包利...

    3 年前
  • npm 包 cbll 使用教程

    在前端开发中,我们通常需要使用一些第三方开源库来方便我们的开发。其中 Node.js 环境下的包管理工具 npm 可以帮我们快速下载和安装这些第三方库。 在本篇文章中,我们将介绍一个常用的 npm 包...

    3 年前
  • npm 包 homebridge-mqtt-door 使用教程

    随着物联网技术的发展,智能家居设备开始逐渐普及。然而,不同厂商生产的设备使用不同的通信协议,使得设备之间的不兼容问题也逐渐显现出来。为了解决这个问题,MQTT协议应运而生。

    3 年前

相关推荐

    暂无文章