npm 包 atavi-client-bundle-application 使用教程

背景

atavi-client-bundle-application 是一个 Node.js 模块，它是 Atavi (一个在线书签管理器) 的客户端脚本打包器。它使得 Atavi 客户端脚本的开发和维护变得异常简单，并且可以节省开发者自己构建打包脚本的时间。

安装

要使用 atavi-client-bundle-application，你需要先安装 Node.js 与 npm 包管理器。通常情况下，npm 会随着 Node.js 的安装一起被安装。安装完成后，可以使用以下命令安装 atavi-client-bundle-application。

npm install atavi-client-bundle-application

使用

要使用 atavi-client-bundle-application，你需要将你的 Atavi 客户端脚本存放在某个目录下。然后，在你的应用程序的入口脚本中，通过 require 导入 atavi-client-bundle-application，然后调用该模块的 bundle 方法即可。

const bundler = require('atavi-client-bundle-application')

bundler.bundle('your_script_dir', outputPath, options)

其中，'your_script_dir' 是存放 Atavi 客户端脚本的目录路径；outputPath 是输出文件路径；options 是一个可选参数，用于指定额外的配置选项（可参考下文的配置项说明）。

配置项

以下是 atavi-client-bundle-application 支持的配置项的说明。

options.include

该配置项是一个文件路径数组，它用于指定要包含到 Atavi 客户端脚本中的其他脚本文件。例如，如果你想要将 jQuery 作为一个全局变量引入到 Atavi 客户端脚本中，你可以将 jQuery 的文件路径添加到该选项中。

{
  include: ['path/to/jquery.js']
}

options.exclude

该配置项也是一个文件路径数组，它用于指定要从 Atavi 客户端脚本中排除的文件。可以使用 glob 规则来指定文件路径。

{
  exclude: ['**/*.test.js']
}

options.useStrict

该配置项用于指定是否在 Atavi 客户端脚本中使用 'use strict';。默认为 true。

{
  useStrict: false
}

options.minify

该配置项用于指定是否将 Atavi 客户端脚本进行压缩。默认为 false。

{
  minify: true
}

示例

假设你的 Atavi 客户端脚本目录结构如下：

your_script_dir/
  src/
    index.js
    utils.js
  css/
    style.css

你可以使用以下代码将它们打包成一个文件：

const bundler = require('atavi-client-bundle-application')

bundler.bundle('your_script_dir/src', 'bundle.js', {
  include: ['your_script_dir/css/style.css'],
  useStrict: true,
  minify: false
})

输出的 bundle.js 文件将包含所有的 Atavi 客户端脚本以及样式表。你可以将该文件上传到 Atavi 服务器，以供用户使用。

结论

atavi-client-bundle-application 是一个非常实用的工具，它可以帮助 Atavi 客户端脚本的开发者更加轻松地进行脚本的打包和维护。同时，它也可以作为打包工具的参考模板，用于开发其他类似的工具。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005590b81e8991b448d6771