npm 包 @sewing-kit/config 使用教程

前言

@sewing-kit/config 是一个基于 TypeScript 构建的 npm 包,它提供了一种配置 Sewing Kit 构建工具和插件的方法。通过本教程,您将了解到如何使用 @sewing-kit/config 来实现强大的构建和插件配置,同时学习到编写 TypeScript npm 包的方法和最佳实践。

安装

使用该库需要先安装 Sewing Kit,Sewing Kit 是一个非常强大的构建工具,提供了很多构建功能的插件,同时也支持自定义插件。执行以下命令安装:

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

配置

在项目根目录创建 sewing-kit.config.ts 文件,并加入以下内容:

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

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

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

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

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

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

@sewing-kit/config 提供了 createComposedConfiguration 方法来创建我们的配置。

调用 compose 方法来组合插件配置。这里定义了 commonPlugins,并将其作为第一个参数传入,让我们定义一些通用插件配置。

在这个配置文件中,我们使用了 @sewing-kit/plugin-webpack 插件。我们定义了 isDevpublicPath 选项,分别表示是否开发模式和访问资源的路径。

另外,我们使用了自定义配置的方法,这里通过自定义 DefinePlugin 插件来实现自定义配置。

编写插件

@sewing-kit/config 使用 Sewing Kit 的插件来实现自定义配置,下面是一个简单的例子:

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

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

这段代码定义了一个输出 GREETING 常量和 hello 方法的插件。apply 方法用来定义插件的行为,这里调用了 api.describe 方法来定义 Sewing Kit 的行为。

使用插件

接下来我们将这个插件加入到我们的配置中:

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

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

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

我们可以将插件作为参数传入 compose 方法。

运行该配置后,我们可以看到控制台输出了 Hello

结论

通过本文,我们了解了如何使用 @sewing-kit/config 包来实现项目的构建和插件的使用,并且也学习到了编写 TypeScript 模块的方法。在 Sewing Kit 构建工具的基础上,我们可以通过编写插件来实现一些项目特定的构建需求。如果您想了解更多,请参考相关文档。

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


猜你喜欢

  • npm 包 immutable-ext 使用教程

    在前端开发中,我们经常需要处理一些复杂的数据结构。为了使代码更加可读、可维护,在 JavaScript 中广泛使用了 immutable 数据结构。在此基础上, npm 包 immutable-ext...

    4 年前
  • npm 包 theo 使用教程

    什么是 theo theo 是一个由 Facebook 开发的 npm 包,用于将设计系统中的样式转换成可重用的 CSS/SCSS 变量、组件和 mixin 的工具。

    4 年前
  • npm 包 @shopify/react-testing 使用教程

    前言 在 Web 开发中,前端应用的测试已经成为不可或缺的一环。而 React 作为现今流行的一个前端框架,其测试方案也需要越来越完善。因此在这篇文章中,我将介绍一个基于 React 的测试工具 --...

    4 年前
  • npm 包 @shopify/with-env 使用教程

    前言 在 Web 开发过程中,常常需要在不同环境下使用不同的变量。例如,开发环境和生产环境下使用的域名和 API 地址不同。而使用环境变量可以做到同一份代码在不同的环境下执行不同的逻辑。

    4 年前
  • npm 包 tabbable 使用教程

    前言 随着前端技术的发展,开发者们对于用户体验的要求越来越高,Tab 键轮询聚焦元素已经成为一个不可缺少的功能。如果你正在寻找一个优秀的实现方案,那么 tabbable 应该是一个不错的选择。

    4 年前
  • npm 包 babel-preset-typescript-vue 使用教程

    简介 Typescript 是一种静态类型检查的语言,可以使得代码更加健壮和可维护。同时,Vue.js 是一种流行的前端框架,可以帮助我们更加高效地开发交互式前端应用。

    4 年前
  • npm 包 make-dir-cli 使用教程

    在前端开发中,经常需要创建新的目录来存放项目文件,使用命令行操作可以更加高效。make-dir-cli 是一款 npm 包,它可以帮助我们在命令行中快速创建新目录,并可以自动设置新目录的权限和时间戳。

    4 年前
  • npm包 @jest/environment 使用教程

    介绍 在前端开发中,测试是一个非常重要的环节。而Jest是一款前端自动化测试框架,它可以让我们编写出更好的测试代码,而@jest/environment是Jest提供的一个负责管理测试环境的npm包,...

    4 年前
  • npm 包 @jest/fake-timers 使用教程

    前言 测试是前端开发中非常重要的一部分。在测试中,时间是一个非常关键的因素。在开发中,我们可能会依赖于一些异步操作,比如 setTimeout() 或者 Promise ,这会使我们的测试变得更加复杂...

    4 年前
  • npm 包 just-debounce-it 使用教程

    在前端开发中,频繁触发事件可能会导致浏览器性能下降或出现其他异常,因此需要用到 debounce 函数来控制函数调用频率。 在 JavaScript 库中,提供了一系列 debounce 函数包,其中...

    4 年前
  • npm包@react-google-maps/infobox使用教程

    在React中集成Google Maps API本身是一项挑战,但如果你想要在Google Maps中添加自定义信息窗口,则变得更加困难。不幸的是,Google Maps API自身并没有提供这种功能...

    4 年前
  • npm 包 @react-google-maps/marker-clusterer 使用教程

    简介 @react-google-maps/marker-clusterer 是一个基于 React 和 Google Maps API 的 npm 包,它提供一个集群化的 Google Maps M...

    4 年前
  • npm 包 precise-proofs-js 使用教程

    precise-proofs-js 是一种用于在前端应用程序中创建 Merkle 树和验证其证明的 npm 包。在今天的区块链世界中,这是一种基本的技术,Merkle 树可以帮助我们快速验证从网络收到...

    4 年前
  • npm 包 @getify/eslint-plugin-proper-arrows 使用教程

    在 JavaScript 代码编写中,箭头函数因为书写简洁优雅、语义明确被广泛使用,但是当箭头函数中的代码块较多时,其书写风格就容易出现较多问题,使得代码难以阅读和维护。

    4 年前
  • npm 包 ethlint 使用教程

    前言 Ethlint 是一个专为 Solidity 语言智能合约开发而设的代码检查工具。它使用 Eslint 进行检查,并提供了一些 Solidity 语言的检查规则,以帮助开发者发现代码潜在的问题和...

    4 年前
  • npm包eslint-plugin-ascii使用教程

    前言 对于一名前端开发者来说,代码规范的重要性不言而喻。而其中,一个遵循 ASCII 码规范的代码,在阅读、调试和维护等方面,都能提供更好的体验和便利。为此,离不开 ESlint 的帮助和支持。

    4 年前
  • npm 包 eslint-plugin-react-functional-set-state 使用教程

    简介 eslint-plugin-react-functional-set-state 是一个 ESLint 插件,它帮助开发者检测 React 组件中非法的 this.setState 调用。

    4 年前
  • npm 包 eslint-plugin-react-perf 使用教程

    在前端开发中,我们经常会使用 React 这样的库和框架进行开发。React 虽然使用简单,但是在组件的性能优化上却需要我们一定的技巧和经验。为了帮助开发人员更好地检查组件性能方面的问题,有一个很好用...

    4 年前
  • npm 包 polly-js 使用教程

    介绍 polly-js 是一款非常实用的 npm 包,它提供了录制和回放 http 请求的功能。通过 polly-js,我们可以在开发和测试过程中方便地模拟和测试 http 请求的情况,提高开发效率和...

    4 年前
  • npm 包 eslint-plugin-security-node 使用教程

    什么是 eslint-plugin-security-node eslint-plugin-security-node 是一个利用 ESLint 为 Node.js 代码提供安全扫描的插件。

    4 年前

相关推荐

    暂无文章