npm 包 bvd-version-tmp-of-directory-to-s3 使用教程

阅读时长 10 分钟读完

简介

bvd-version-tmp-of-directory-to-s3 是一款 npm 包,用于快速将一个目录下的所有文件打包并上传到 AWS S3,并生成版本号进行管理。

该包适用于前端开发中,经常有 CDN 上传资源到 S3,需要进行版本管理处理的场景。通过该包,可以快速实现版本管理和自动化上传 CDN 资源。

安装

首先需要提前安装 Node.js,然后执行以下命令进行安装:

或者使用 yarn:

使用

创建配置文件

在你的项目根目录下创建 s3.config.js 文件,并按照如下格式进行配置:

参数说明:

  • accessKeyIdsecretAccessKey: AWS 访问密钥 ID 和密钥,可以在 AWS 的 IAM 控制台中进行获取。
  • region: AWS S3 的地区,例如:us-west-2。
  • bucket: S3 存储桶名称。
  • directory: 需要进行打包和上传的目录名称。

执行命令

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

即可将 directory 目录下的所有文件进行打包,然后上传到 AWS S3,并生成一个版本号进行管理。同时会在控制台输出上传结果和生成的版本号。

示例代码

下面给出一个示例代码,供大家参考:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

结束语

通过使用 bvd-version-tmp-of-directory-to-s3 包,我们可以实现 CDN 资源版本管理和自动上传,从而提高前端开发效率,减少出错的可能性。希望本文对大家有所帮助。

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

纠错
反馈