@assetpack/cli

中文文档
0.8.0发布于 2023/11/17MITES Module近 30 天下载 2797

A simple CLI to run AssetPack

原始使用文档
文档目录3 节
  1. Installation
  2. Usage
  3. Config File

@assetpack/cli

AssetPack CLI is a command line tool for AssetPack.

Installation

npm install --save-dev @assetpack/cli

Usage

{
    "scripts": {
        "build": "assetpack -c .assetpack.js",
        "watch": "assetpack -c .assetpack.js -w"
    }
}

Config File

AssetPack uses a config file to define what assets you want to optimise and how you want to optimise them. The config file is a JavaScript file that exports an object with the following properties:

  • entry: The directory where your raw assets are located.
  • output: The directory where you want your optimised assets to be outputted to.
  • plugins: An object containing the plugins you want to use. The key is the name of the plugin, and the value is the plugin itself.
  • ignore: an optional array of ignore patterns. Any file path matching the patterns will not be processed by assetpack
  • cache: an optional boolean to enable or disable caching. Defaults to true.
  • logLevel: an optional string to set the log level. Defaults to 'info'.
  • files: an optional object to override the settings and tags of any assets. See Config Overrides for more details.

Example

// .assetpack.js

export default {
  entry: "./raw-assets",
  output: "./public",
  plugins: {},
};

版本与发布记录

@assetpack/cli 共发布 15 个版本,首次发布于 2023/02/02;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.8.0latest2023/11/172 年前
0.7.02023/07/043 年前
0.6.22023/03/233 年前
0.6.12023/03/023 年前
0.6.02023/02/233 年前
0.5.12023/02/173 年前

关于 @assetpack/cli 的常见问题

@assetpack/cli 是什么?

A simple CLI to run AssetPack

如何安装 @assetpack/cli?

在项目目录运行 npm install @assetpack/cli,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@assetpack/core(>=0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。它还提供命令行工具 assetpack,可以用 npx assetpack 直接运行。

@assetpack/cli 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/assetpack__cli 是否存在。

@assetpack/cli 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@assetpack/cli 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=16.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@assetpack/cli 可以商用吗?

@assetpack/cli 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@assetpack/cli 的下载量有多少?

根据 npm 官方下载统计,@assetpack/cli 在 2026/10/07 – 2026/11/05 这 30 天内被下载 2,797 次,日均约 93 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@assetpack/cli 还在维护吗?

最新版本 0.8.0 发布于 2023/11/17(2 年前);至今共发布 15 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/02/02。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。