npm 包 tradie 使用教程

阅读时长 7 分钟读完

什么是 tradie?

Tradie 是一款针对前端开发的 npm 包,它可以帮助你更好的管理你的前端项目。它通过集成不同的工具,例如 lint、编译、测试等,来使开发效率更高,代码更规范。它适用于中小型项目和团队。

它的一些特性包括:

  • 支持 TypeScript, React 和 JSX
  • 集成了 Babel 编译器
  • 压缩和优化图片和文件
  • 支持多种测试框架,例如 Jest, Mocha, Enzyme 等
  • 集成了 ESLint、Prettier 等工具,帮助规范代码风格

如何使用 tradie?

全局安装

首先我们需要全局安装 tradie:

安装完成后,我们就可以在命令行中使用 tradie 命令。

初始化项目

使用 tradie 初始化一个新项目非常容易。首先,创建一个新目录并进去:

然后执行以下命令:

tradie 会通过交互式的命令行界面来引导你完成项目的初始化。在这个阶段中,你可以设置一些基本的选项,例如项目名称、作者信息等。

完成后,tradie 会自动生成一些初始目录和文件。比如一个 “src” 目录,这个目录中存放所有源代码、一个 “tests” 目录,这个目录中存放所有测试代码。

配置文件

默认情况下,package.json 中会自动生成一个与 tradie 相关的配置,如下所示:

你也可以直接在项目根目录下创建一个名为 tradie.config.js 的文件来覆盖默认配置。例如:

命令

当我们完成项目初始化后,就可以使用以下命令:

tradie build

使用 tradie build 来编译项目。默认情况下,构建会在 output 目录中输出。例如:

tradie test

使用 tradie test 来运行测试。默认情况下,测试框架是 Jest。例如:

tradie lint

使用 tradie lint 来检查代码风格。默认情况下,使用 ESLint。

tradie precommit

使用 tradie precommit 可以在提交代码之前自动运行测试和 Lint 检查。

tradie watch

使用 tradie watch 可以监听文件的变化,并在文件有变化时自动执行相关命令。例如:

构建配置

Tradie 通过集成多个开发工具来进行代码的构建。下面我们将简单介绍一下一些常用工具的配置:

rollup

安装

Rollup 是一个 JavaScript 模块打包器。我们需要安装一些插件来支持使用它来构建项目。

配置

修改 tradie.config.js 文件中的 tool 选项为 rollup

然后,我们可以修改 build 选项:

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

webpack

安装

Webpack 是一个模块加载器。我们需要安装以下插件来实现使用它来构建我们的项目:

配置

修改 tradie.config.js 文件中的 tool 选项为 webpack

然后,我们可以修改 build 选项:

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

结论

在这篇文章中,我们介绍了 Tradie 这个 npm 包,它提供了一系列的工具来帮助我们更好的管理和开发前端项目。我们学习了如何安装和配置 Tradie,并了解了如何使用不同的构建工具来构建我们的项目。我们还介绍了一些常见的配置选项,以及如何使用它们来完成我们的开发任务。希望这篇文章能帮助你更好的使用 Tradie,并提高你的开发效率。

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

纠错
反馈