npm 包 gulp-rev-collector-param 使用教程

1. 简介

gulp-rev-collector-param 是一款非常实用的前端 npm 包,它可以帮助我们自动生成 hash 文件名,以及自动替换引用的文件路径。本篇文章将详细介绍该 npm 包的使用方法。

2. 安装

使用 npm 命令进行安装:

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

3. 使用方法

3.1 基本用法

3.1.1 生成 hash 文件名

在 gulpfile.js 文件中加入以下代码:

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

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

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

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

在命令行中使用 gulp 命令执行:

----

执行该命令后,gulp-rev-collector-param 会自动扫描你的资源文件,生成一个新的 rev-manifest.json 文件,该文件记录了新文件名与原文件名的对应关系。

3.1.2 替换引用路径

gulp-rev-collector-param 还可以自动替换引用文件路径,只需在 gulpfile.js 文件的 collector 任务中添加参数即可:

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

上述代码会自动将引用的文件名替换成带有 hash 的文件名,从而避免浏览器缓存问题。

3.2 参数介绍

在 gulpfile.js 文件的 collector 任务中,我们还可以添加其他的参数控制 gulp-rev-collector-param 的行为。

3.2.1 参数列表

以下是 gulp-rev-collector-param 支持的参数列表:

  • replaceReved:是否替换重命名的文件。 -- 类型:Boolean -- 默认值:false -- 示例代码:.pipe(collector({replaceReved:true}))

  • dirReplacements:自定义目录替换规则。 -- 类型:Object -- 示例代码:.pipe(collector({dirReplacements: { '/js': '/public/js' }}))

  • revSuffix:哈希值后缀。 -- 类型:String -- 默认值:无。 -- 示例代码:.pipe(collector({revSuffix: '_cdn'}))

  • extMap:文件扩展名映射表。 -- 类型:Object -- 示例代码:.pipe(collector({extMap: {'.*': '.php'}}))

3.2.2 参数说明

  • replaceReved:一般设置为 true,用于开启重命名文件自动替换功能。如果设置为 false,这将导致 gulp-rev-collector-param 只生成 hash 文件名,不做自动替换。

  • dirReplacements:自定义目录替换规则,可以为指定目录内的文件设置自定义路径。设置示例:.pipe(collector({dirReplacements: { '/js': '/public/js' }})),该示例会将 /js 目录下的所有资源替换为 /public/js。

  • revSuffix:哈希值后缀,用于控制文件名中哈希值的格式。设置示例:.pipe(collector({revSuffix: '_cdn'})),该示例会在哈希值后面添加 _cdn 后缀。

  • extMap:为扩展名映射表,用于控制文件的文件类型,可选值有:.* /html /css /js。设置示例:.pipe(collector({extMap: {'.*': '.php'}})),该示例将所有文件扩展名替换为 .php。

4. 总结

通过本文的介绍,我们可以看到 gulp-rev-collector-param 在前端项目中的实际应用。这个 npm 包不仅可以方便地生成 hash 文件名,还可以自动替换路径,大大提高了前端开发的效率。如果您在项目中需要自动化生成 hash 文件名,并自动替换路径,则可以考虑使用本文介绍的 npm 包。

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


猜你喜欢

  • npm 包 server-timings 使用教程

    前端性能提升一直是 Web 开发者关注的焦点,其中一个关键点就是在前端代码和后端服务之间进行交互时如何优化网络请求的效率和速度。一个重要的指标就是请求的响应时间,而 server-timings 就是...

    3 年前
  • npm 包 @subosito/eslint-config-recommended 使用教程

    在前端开发中,我们常常需要确保代码的质量和可维护性。ESLint 是一个非常强大的静态代码分析工具,它可以帮助我们在代码编写过程中发现潜在的问题并提供修复建议。在 ESLint 的基础上,@subos...

    3 年前
  • npm 包 @zestic/persistence-buffer 使用教程

    在前端开发中,我们通常需要通过不同的方式存储和获取数据。在某些情况下,我们需要将数据存储在浏览器本地以便下次访问时使用。@zestic/persistence-buffer 是一款 npm 包,提供了...

    3 年前
  • npm 包 html-text-generator 使用教程

    HTML-Text-Generator 是一个在 Node.js 平台上使用的 npm 包,它可以将 HTML 标记转换成纯文本字符串。它非常适合前端开发中,需要将 HTML 内容转换成纯文本的场景,...

    3 年前
  • npm 包 at-ui-style 使用教程

    在前端开发中,界面设计和样式的重要性不言而喻。为了减少重复的工作、提高开发效率,npm 包成为前端工程化的必不可少的工具。at-ui-style 是一个非常优秀的前端 UI 库,本文将介绍 at-ui...

    3 年前
  • npm 包 react-native-rhtitleinput 使用教程

    在 React Native 开发中,文本输入框是不可或缺的一部分,而 react-native-rhtitleinput 是一种 React Native 推出的文本输入框组件,可以快速便捷地创建出...

    3 年前
  • npm 包 gulp-filenames-to-txt 使用教程

    简介 在前端开发中,页面资源文件是必不可少的。使用一些工具来帮助创建资源文件列表,可以提高我们的开发效率。gulp-filenames-to-txt 就是一个简单易用的 gulp 插件,可以将文件名输...

    3 年前
  • npm 包 gulp-tempos 使用教程

    概述 gulp-tempos 是一种基于 Gulp 构建系统的前端构建工具,它的主要目标是方便快捷地将多种文件类型转换为 JavaScript 程序代码以及将多个 JavaScript 程序代码合并为...

    3 年前
  • npm 包 tempos 使用教程

    npm 包 tempos 使用教程 tempos 是一个 npm 包,它是一个轻量级的 JavaScript 时间工具,它可以用来解析、访问和操作日期、时间、日期范围以及相对时间,支持国际化、时区等,...

    3 年前
  • NPM 包 `vedio` 使用教程

    在 Web 开发中,嵌入视频是很常见的需求。而使用 NPM 包来解决这个问题,不仅可以更高效地实现嵌入视频这个功能,还有其它很多的好处,比如可以避免浏览器兼容问题,可以更好地管理项目的依赖等等。

    3 年前
  • npm 包 v-spot-ws 使用教程

    什么是 v-spot-ws v-spot-ws 是一个基于 webSocket 协议的客户端库,用于开发实时交互应用程序。 它可以减少前端与后端之间的沟通,同时也可以实现实时数据传递、即时通讯等功能。

    3 年前
  • npm 包 kml-static-server 使用教程

    在前端开发过程中,很多时候我们需要在本地开启一个静态服务器来查看和调试网页。而 kml-static-server 就是一款基于 Node.js 的静态服务器工具,用于启动本地静态服务器和浏览器热加载...

    3 年前
  • npm 包 leancloud-sdk 使用教程

    前言 随着 Web 应用不断发展,前端技术越来越成熟,前端开发的重要性也越来越受到重视。而 leancloud-sdk 就是一款优秀的 npm 包,可以方便地将应用的数据管理在 LeanCloud 服...

    3 年前
  • npm 包 ng4-quill-editor 使用教程

    简介 ng4-quill-editor 是一个 Angular4.x 的富文本编辑器,它使用了 Quill.js 库来实现,支持多种功能的富文本编辑,如加粗、斜体、下划线、字体、字号、颜色、列表等等,...

    3 年前
  • npm 包 ng4-quoll-editor 使用教程

    在前端开发中,使用编辑器是必不可少的一部分。而 ng4-quoll-editor 是一个能够在 Angular 4 和 5 项目中使用的富文本编辑器,它提供了许多有用的功能,如颜色选择器、表格生成器等...

    3 年前
  • npm 包 @ineedthis/resolve 使用教程

    简介 在前端开发中,我们常常需要在代码中引用其他库或者模块,但是这些库或者模块可能来自于不同的路径,或者是不同的操作系统。为了解决这个问题,我们可以使用 @ineedthis/resolve 这个 n...

    3 年前
  • npm 包 react-native-cosser 使用教程

    在前端开发中,使用现有的 npm 包可以提高开发效率和质量。而在移动应用开发中,React Native 是一个非常流行的解决方案。本文将介绍一款名为 react-native-cosser 的 np...

    3 年前
  • NPM包Chef-Layout使用教程

    简介 Chef-Layout 是一个基于Flexbox的布局框架,可以用于快速构建响应式的前端页面。它使用Sass编写,并可以从NPM中获取和安装。 安装 使用npm 安装 chef-layout -...

    3 年前
  • npm包paypal-braintree-sdk-client使用教程

    前言 PayPal和Braintree是国际上非常流行的支付平台,其中Braintree是PayPal旗下的一家支付服务商,为大量企业和商家提供支付解决方案。如果你正在开发一个电子商务网站或者一个线上...

    3 年前
  • npm包simplecartsample使用教程

    前言 在前端开发中,经常需要使用购物车的功能。为了方便起见,我们可以使用简便的npm包 simplecartsample。 simplecartsample 是一个轻量级,易于使用的购物车库。

    3 年前

相关推荐

    暂无文章