npm 包 @doublepi/assets-manager 使用教程

阅读时长 4 分钟读完

简介

@doublepi/assets-manager 是一个基于 webpack 和 webpack-dev-server 的前端静态资源管理插件,可以帮助团队更加高效地管理项目中的静态资源,包括样式、脚本、图片、字体等。

与其他常见的前端静态资源管理插件相比,@doublepi/assets-manager 支持自定义路径别名、自动化处理 CSS 预处理器等高级功能,对复杂项目场景有着较好的适应性。

本文将介绍如何安装和使用 @doublepi/assets-manager。

安装

在项目根目录下运行以下命令:

配置

@doublepi/assets-manager 配置文件为 assets.config.js,需放置于项目根目录下。

以下是一个简单的配置示例:

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

配置文件主要包含两部分,一是开发环境配置,二是生产环境配置。

开发环境配置支持 webpack-dev-server 的常用配置选项,如 port 等,assets 部分定义了项目中要管理的各种类型的资源,包括类型(style、script、image 等)、源文件路径、目标文件路径等。

生产环境配置的区别在于增加了一项选项 hash,用于控制是否生成 hash。

使用

在项目的 package.json 中添加以下命令:

即可通过 npm start 启动开发服务器,npm run build 打包生产环境。

细节

@doublepi/assets-manager 对 webpack 和 webpack-dev-server 的底层配置进行了封装,主要包括以下细节:

  1. 支持路径别名,无需通过相对路径来引用资源文件,比如 import '@/styles/index.less'。

  2. 自动处理 CSS 预处理器,不再需要手动配置 loader。

  3. 自动根据 CSS 预处理器的变量定义生成供 JS 代码使用的常量。

  4. 支持自动添加浏览器前缀。

  5. 支持图片压缩和雪碧图。

  6. 使用 fast-source-map 以及 terser-js 进行代码压缩和 source map 生成。

总结

本文介绍了 @doublepi/assets-manager 的安装、配置和使用方法,并对其实现原理进行了一定的解释和说明。希望对大家在前端项目中的静态资源管理有所帮助。

详细的配置选项请查看官方文档:https://github.com/doublepi-projects/assets-manager。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005558081e8991b448d2aab

纠错
反馈