npm 包 Broccoli-Timepiece 使用教程

前言

在前端开发中,构建工具是必不可少的一部分。而 Broccoli-Timepiece 正是一个基于 Broccoli 的构建工具,专为实现静态资源版本控制而设计。本文将介绍如何使用该工具,以便更好地管理和维护项目。

安装

使用 npm 进行安装:

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

使用说明

API

Timepiece

  • new Timepiece(inputNode: BroccoliNode, options: BroccoliTimepieceOptions)

选项:

  • versionsDir:存放版本信息的目录,相对于 Broccoli 输出目录的路径,默认为 ./versions
  • getVersionKey(fileName: string, hash: string): string:通过文件名和哈希值生成版本号的函数,默认为 (fileName, hash) => ${fileName}-${hash}``。
  • online:boolean:是否将版本控制输出到 JS 文件中,默认为 false

示例代码:

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

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

命令行工具

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

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

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

示例

在这个示例中,我们会构建一个简单的前端项目,并使用 Broccoli-Timepiece 进行版本控制。

目录结构

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

安装依赖

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

Brocfile.js

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

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

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

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

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

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

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

index.html

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

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

其中,使用 {{url}} 标记标签里的 URL,表示使用版本控制后的路径,以保证静态资源更新时能够自动获取最新的版本。

使用命令行工具

输出版本控制信息到 JS 文件

执行如下命令:

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

它会将版本控制信息输出到 {root}/build/version.js

启动一个 HTTP 服务器

执行如下命令:

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

然后在浏览器里访问 http://localhost:8080/ 即可看到页面。此时你可以将 app 目录下的静态资源任意更改,然后再次刷新浏览器,即可发现它们已经被更新了。

结语

对于多人协同开发、多次迭代更新的中大型前端项目,使用 Broccoli-Timepiece 进行版本控制可以大大提高开发效率和减少错误产生的可能性。欢迎读者使用本工具,如果有任何反馈或建议,也欢迎在评论区留言!

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


猜你喜欢

  • npm 包 broccoli-toga 使用教程

    npm 是一个全球最大的软件包管理器,它为 JavaScript 开发人员提供了方便和便捷的包管理服务。而 broccoli-toga 是一个前端构建工具,它能够帮助开发人员更加高效地构建、打包和优化...

    4 年前
  • npm 包 broccoli-tornado 使用教程

    什么是 broccoli-tornado Broccoli-tornado 是一个基于 Node.js 的构建工具,可以帮助开发人员更高效地构建前端项目,包括但不限于 HTML、CSS、JavaScr...

    4 年前
  • npm 包 broccoli-tree-to-json 使用教程

    介绍 Broccoli 是一个快速、可靠的前端构建工具,受到了很多开发者的喜爱。其中最大的一个优势就是它非常适合用于大型项目的构建,因为它采用了增量编译的方式,保证了每次构建的速度和效率。

    4 年前
  • npm 包 brita 使用教程

    介绍 brita 是一个 npm 包,提供了一些在开发前端项目时常见的、易于操作的工具函数,例如「类型判断」、「对象深拷贝」、「数组去重」等。使用 brita 可以提高前端开发效率,避免重复造轮子。

    4 年前
  • npm 包 brite 使用教程

    什么是 brite? brite 是一款用于前端 UI 开发的 npm 包,它提供了大量的 UI 组件和样式,以及通用的 UI 动效。 brite 的名字来自于 “bright”,即“明亮的”,同时也...

    4 年前
  • npm 包 britecharts-srcmods 使用教程

    前言 britecharts-srcmods 是一个强大的 npm 包,用于在前端展示各种可视化图表。它包含了众多实用的功能,包括但不限于热力图、柱状图、饼图等等。

    4 年前
  • npm 包 browser-module-concat 使用教程

    当我们需要将多个前端模块打包成一个文件以减少网络请求时,我们会使用前端模块化工具如 webpack 或者 rollup。然而这些工具可能会产生一些不必要的开销,因为它们需要将所有模块加载到内存中,并维...

    4 年前
  • npm 包 browserstack-test 使用教程

    什么是 browserstack-test browserstack-test 是一个 npm 包,用于在 BrowserStack 平台上进行自动化测试。该平台支持各种浏览器和设备,可以很好地模拟真...

    4 年前
  • npm 包 browser-node-slack 使用教程

    介绍 browser-node-slack 是一个 npm 包,用于将来自浏览器或 Node.js 应用程序的消息发送到 Slack 频道。它基于 Slack 应用程序的 Webhook API,并通...

    4 年前
  • npm 包 browser-networking 使用教程

    简介 在前端开发中,经常需要使用一些网络请求的操作。以往的方式往往需要手动通过 ajax 或 fetch 网络请求,而这些操作需要大量的代码来实现。 近年来,随着 Node.js 技术的发展,推出了一...

    4 年前
  • npm 包 browser-notifications 使用教程

    什么是 browser-notifications browser-notifications 是一个基于 Web Notification API 的 JavaScript 模块,用于在浏览器中实现...

    4 年前
  • npm 包 browser-orm 使用教程

    在前端开发中,我们时常需要使用到 ORM(Object-Relational Mapping)。ORM 是一种通过将数据模型映射至数据库结构的技术,以便于使用。在 Node.js 生态系统中,有一个广...

    4 年前
  • npm 包 browser-notif 使用教程

    browser-notif 是一个可以轻松实现浏览器端通知功能的 NPM 包。使用这个包,你可以非常简单地在网页中实现通知的推送、显示等功能,让你的网站变得更加用户友好。

    4 年前
  • npm 包 browserstack-protractor 使用教程

    browserstack-protractor 是基于 Protractor 和 BrowserStack 的一个 npm 包,它可以实现在 BrowserStack 上进行 E2E 测试。

    4 年前
  • npm 包 browserstack-select 使用教程

    介绍 browserstack-select 是一个 npm 包,它可以帮助开发者在 BrowserStack 平台上进行自动化测试。该包允许您使用不同的版本和浏览器来运行测试,以确保您的应用程序在各...

    4 年前
  • npm 包 browserstacklocal 使用教程

    前言 前端开发中,我们需要对页面在不同的浏览器中进行测试,为了实现这个功能,我们可以使用 BrowserStack,它是一款提供云端交叉浏览器测试的工具。在使用 BrowserStack 进行测试的过...

    4 年前
  • npm 包 browserstack-testem-integration 使用教程

    前言 在开发前端项目中,我们会经常涉及到测试和部署的工作。而在测试环节中,跨浏览器和跨设备的测试是必要的。BrowserStack 是一款跨平台的测试工具,可以用来快速、可靠地在多种设备和浏览器上运行...

    4 年前
  • npm 包 browserstack-wrapper 使用教程

    简介 browserstack-wrapper 是一个用于在 BrowserStack 自动化测试中集成 Selenium Webdriver 的 npm 包。它非常易于使用,可以帮助开发者在不同的操...

    4 年前
  • npm 包 broccoli-traceur 使用教程

    前言 随着前端技术的发展,JavaScript 成为了前端开发的重要语言。而 npm 作为 JavaScript 的包管理器,极大地方便了开发者的工作。在众多 npm 包中,broccoli-trac...

    4 年前
  • npm 包 broccoli-tree-traverser 使用教程

    什么是 broccolo-tree-traverser Broccoli-tree-traverser 是一个 NPM 包,它提供的是对 Broccoli 的树结构进行遍历的模块。

    4 年前

相关推荐

    暂无文章