npm 包 modern-package-boilerplate 使用教程

简介

modern-package-boilerplate 是一款用于构建现代化 JavaScript npm 包的工具,基于 Rollup.js 和 Babel,支持 ES6 和 CommonJS 模块规范。该工具的目标是提供基础的 npm 包开发架构,让开发者可以快速搭建出基于现代化 JavaScript 生态系统的 npm 包。

安装

安装 modern-package-boilerplate,我们需要使用 npm 或 yarn:

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

使用

modern-package-boilerplate 基于 Rollup.js 构建,需要先在项目中安装 Rollup.js,使用以下指令:

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

接下来,在项目的 package.json 文件中添加以下脚本:

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

然后,在项目中创建一个 src 文件夹并编写你的代码。例如,创建一个 index.js 文件:

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

随后,在项目的根目录下创建一个 rollup.config.js 文件:

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

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

此文件定义了 Rollup 的输入和输出配置,以及使用 terser 压缩代码的插件。

最后,运行构建命令即可生成打包后的代码:

--- --- -----

现在,我们的代码就已经完成了构建过程,生成了 CommonJS、ES 和 IIFE 三种形式的输出,可以在不同的 JavaScript 环境中使用。

示例代码

我们在这里提供一个使用了 modern-package-boilerplate 的例子,用于理解如何使用 package.json 配置以及如何编写具体代码。

package.json

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

src/utils.js

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

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

index.js

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

rollup.config.js

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

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

总结

现代化 JavaScript 生态系统已成为前端工程化的主流,npm 包作为其中不可或缺的一部分,也需要更加现代化的解决方案来构建。modern-package-boilerplate 基于 Rollup.js 和 Babel,提供了基础的 npm 包开发架构,帮助开发者快速搭建出符合现代化 JavaScript 生态系统的 npm 包。通过本文的简介和实例代码,相信读者已经可以快速上手运用该工具来开发自己的 npm 包。

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


猜你喜欢

  • npm 包 timeline-monoid 使用教程

    前言 在前端开发中,我们需要处理各种各样的时间轴数据。在这里,我们介绍一个 npm 包 timeline-monoid,它可以很方便地处理时间轴数据。 什么是 timeline-monoid? tim...

    3 年前
  • npm 包 "wait-for-mssql" 使用教程

    在前端开发中,一些功能需要等待特定的条件满足后才能进行后续的操作。针对 SQL Server 数据库的开发中,我们常常需要等待数据库连接成功后再进行相应的操作。在此场景下,npm 包 "wait-fo...

    3 年前
  • npm 包 markovn 使用教程

    什么是 markovn markovn 是一个基于 Markov 链的文本模型生成器。它可以使用任何文本语料库,对文本进行分析,并使用与文本相似的模式为您生成新的文本。

    3 年前
  • npm 包 request-application 使用教程

    在前端开发中,经常需要与后端进行数据交互。为了方便地发送 HTTP 请求,我们可以使用一个名为 request-application 的 npm 包。本篇文章将详细介绍 request-applic...

    3 年前
  • npm 包 uploadable-image 使用教程

    在前端开发过程中,图片上传是一个非常基础和常见的功能。而 uploadable-image 这个 npm 包提供了一种非常简单和易用的方式来实现图片上传功能。本文将介绍如何使用 uploadable-...

    3 年前
  • npm 包 gulp-json-to-scss 使用教程

    在前端开发中,我们常常需要将 JSON 数据转化成 SCSS 样式,以便实现动态样式的定制,而 gulp-json-to-scss 就是一个非常方便的工具,可以帮助我们快速地完成这个转换过程。

    3 年前
  • npm 包 zr-devcamp-js-footer 使用教程

    背景 在前端开发中,很多页面都需要共用一个 footer。为了避免重复编写代码和维护,我们可能会考虑将 footer 抽离出来封装成一个独立的 npm 包。其中,zr-devcamp-js-foote...

    3 年前
  • npm 包 rc-ace-diff 使用教程

    前言 在前端开发中,我们经常需要对比不同版本代码以确定变更和修改,而 rc-ace-diff 是一个非常实用的 npm 包,它可以帮助我们比较两个代码块的不同,并将差异以不同颜色进行标识。

    3 年前
  • npm 包 string-common-utils 使用教程

    简介 在进行前端开发的过程中,字符串的处理是很常见的操作,比如字符串的截取、替换、转换等。这些操作可能会占用大量的时间和精力,因此出现了一些工具库来帮助我们完成这些操作。

    3 年前
  • npm 包 chin-plugin-convert-svg 使用教程

    在前端开发中,使用 Vector 图形比使用位图图像具有更加灵活和可扩展的优势。但是,当需要在项目中使用 Vector 图形时,我们需要将其转换成前端可用的格式,如 SVG。

    3 年前
  • npm 包 chin-plugin-imagemin 使用教程

    前言 在前端开发中,图片的优化是一个很重要的事情。优化图片不仅能加快网站的加载速度,还能提升用户的体验。而在实际开发中,我们可能会遇到图片太大或者需要压缩图片的情况。

    3 年前
  • npm 包 chin-plugin-inkscape 使用教程

    简介 chin-plugin-inkscape 是一个基于 Inkscape 的 npm 包,可以用于在前端项目中生成矢量图形。它支持多种格式的输入和输出,如 SVG、PDF、EPS 等。

    3 年前
  • npm 包 chin-plugin-json 使用教程

    简介 chin-plugin-json 是一个基于 npm 包的插件,用于解析 JSON 格式的数据并根据指定的格式输出数据。该插件能够在前端开发中解决 JSON 数据的解析问题,帮助开发人员更加高效...

    3 年前
  • npm 包 chin-plugin-svgr 使用教程

    简介 NPM 是 Node.js 的包管理器,提供了丰富的第三方包供开发者使用和分享。chin-plugin-svgr 是一个基于 SVGR 的 NPM 包,旨在将 SVG 图标文件转化成可直接在 R...

    3 年前
  • npm 包 chin-plugin-unified 使用教程

    前言 随着互联网的发展,前端的重要性也越来越凸显。在前端的开发中,npm 包是不可或缺的一部分,它们可以帮助我们完成很多重复且复杂的工作。而 chin-plugin-unified 就是一款值得推荐的...

    3 年前
  • npm 包 prex-es5 使用教程

    在前端开发中,我们经常需要使用一些 JavaScript 库和工具来帮助我们进行开发。其中,npm 是一个非常流行的 JavaScript 包管理器,可以让我们方便地下载和安装各种开源 JavaScr...

    3 年前
  • npm 包 pomelo-x 使用教程

    简介 pomelo-x 是一个基于 Node.js 的分布式游戏服务器框架,支持实时推送和大规模并发。底层框架 pomelo 已经成为了国内游戏服务器开发行业的标准之一。

    3 年前
  • NPM 包 template-code-gen 使用教程

    介绍 template-code-gen 是一个基于 Node.js 平台的 NPM 包,专门用于生成前端项目中的代码模板。它可以快速生成 Vue、React、Angular 等前端框架的组件、指令、...

    3 年前
  • npm 包 hapi-gen 使用教程

    在前端开发中,node.js 和 npm 是不可少的工具,尤其是在开发 web 应用时。hapi-gen 是 npm 包中的一个工具,它可以帮助我们快速地创建 Hapi.js 项目结构。

    3 年前
  • npm 包 huangge-aurora-imui-react-native 使用教程

    在前端开发中,可以使用 React Native 来构建跨平台的原生应用程序。而为了实现一些实时通讯、聊天等功能,我们需要一个类似于即时通讯应用程序的聊天界面。本文将介绍一款非常优秀的 npm 包,h...

    3 年前

相关推荐

    暂无文章