# @box/frontend 中文文档

规范地址：https://npmcn.com/package/%40box/frontend/

版本：12\.1\.0
npm 元数据更新时间：2026-10-09T14:45:31.259Z
中文译文更新时间：2026-11-08T12:58:47.779Z
软件包许可：SEE LICENSE IN LICENSE

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40box/frontend
原文对照：https://npmcn.com/package/%40box/frontend/?lang=original
源码仓库：https://git.dev.box.net/Box/frontend

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：91 kB，31 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- Node.js 要求：^22\.0\.0 \|\| ^24\.0\.0
- 运行依赖：3 个
- peer 依赖：husky ^3\.1\.0，eslint ^8\.57\.0，lodash ^4\.17\.15，postcss ^8\.4\.49，prettier ^3\.8\.3，stylelint ^16\.18\.0，typescript ^5\.9\.3，lint-staged ^9\.5\.0，@box/cldr-data ^34\.2\.0，@box/languages ^1\.0\.0，@commitlint/cli ^19\.8\.0，stylelint-order ^7\.0\.0，intl-messageformat ^2\.2\.0，eslint-plugin-react ^7\.34\.1，@babel/eslint-parser ^7\.24\.1，eslint-config-airbnb ^19\.0\.4，eslint-plugin-import ^2\.29\.1，eslint-plugin-lodash ^7\.4\.0，eslint-plugin-ft-flow ^3\.0\.7，eslint-config-prettier ^9\.1\.0，eslint-plugin-formatjs ^4\.12\.2，eslint-plugin-jsx-a11y ^6\.8\.0，@typescript-eslint/parser ^8\.59\.4，eslint-plugin-react-hooks ^4\.6\.0，stylelint-config-standard ^38\.0\.0，conventional-changelog-cli ^2\.0\.28，stylelint-config-clean-order ^7\.0\.0，stylelint-config-standard-scss ^15\.0\.1，@commitlint/config-conventional ^19\.8\.0，@typescript-eslint/eslint-plugin ^8\.59\.4
- 首次发布：2018-11-03T02:45:11.077Z
- 最新版本发布：2026-10-09T14:45:31.028Z
- 近 30 天下载量：3400（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：54（近 12 个月 5 个）

## 中文简介

前端项目的共同配置和工具

## 安装

```sh
npm install @box/frontend
```

也可以使用：`pnpm add @box/frontend`、`yarn add @box/frontend`、`bun add @box/frontend`

## README

[![npm version](https://img.shields.io/npm/v/@box/frontend.svg?style=flat-square)](https://www.npmjs.com/package/@box/frontend)

此工程被其他 Box 前端工程用于 _仅发展依赖性_. 除非你是另一个Box项目的一部分, 你不应该在这里消耗任何代码。 它完全没有支持,对于非盒式消费来说可能非常不稳定.

-   [依赖关系](https://npmcn.com/package/%40box/frontend/#readme-dependencies)
-   [移徙](https://npmcn.com/package/%40box/frontend/#readme-migration)
-   [配置](https://npmcn.com/package/%40box/frontend/#readme-configs)
    -   [ESLint 语录](https://npmcn.com/package/%40box/frontend/#readme-eslint)
    -   [样式林](https://npmcn.com/package/%40box/frontend/#readme-stylelint)
    -   [高级](https://npmcn.com/package/%40box/frontend/#readme-prettier)
    -   [提交线条](https://npmcn.com/package/%40box/frontend/#readme-commit-linter)
-   [Lint 分阶段文件](https://npmcn.com/package/%40box/frontend/#readme-lint-staged-files)
-   [i18n (英语)](https://npmcn.com/package/%40box/frontend/#readme-i18n)
-   [网络包装插件](https://npmcn.com/package/%40box/frontend/#readme-webpack-plugins)
-   [编辑器集成](https://npmcn.com/package/%40box/frontend/#readme-editor-integration)
    -   [虚拟系统](https://npmcn.com/package/%40box/frontend/#readme-vscode)
-   [捐款](https://npmcn.com/package/%40box/frontend/#readme-contributing)
-   [版权和许可证](https://npmcn.com/package/%40box/frontend/#readme-copyright-and-license)

# 依赖关系

见 [软件包.json](https://npmcn.com/package/%40box/frontend/package.json) 用于依赖和同伴依赖.

Node.js 24是支持开发,CI,和工具化的运行时间. 节点.js 22仍然在工作,但已贬值,并将在未来的主要发布中被移除;预期消费者会尽快迁移到节点.js 24. `.nvmrc`, (中文(简体) ), `.node-version`,以及 `mise.toml` 24号节点用于发展.

# 移徙

见 [移民.md](https://npmcn.com/package/%40box/frontend/MIGRATION.md) 指数和 `migrations/v<N>-to-v<N+1>.md` 用于版本升级指南.

# 配置

## ESLint 语录

-   见 [埃斯林特语name](https://npmcn.com/package/%40box/frontend/eslint/README.md) 文档.

## 样式林

-   见 [样式lint](https://npmcn.com/package/%40box/frontend/stylelint/README.md) 文档.

## 高级

-   见 [更美丽](https://npmcn.com/package/%40box/frontend/prettier/README.md) 文档.

## 提交线条

-   见 [执行插件](https://npmcn.com/package/%40box/frontend/commitlint/README.md) 文档.

# Lint 分阶段文件

要在承诺时自动格式化已更改的文件,请添加 `lint-staged` 财务报告和审定财务报表 `husky` 配置为 **软件包.json**数字 :

```json
{
  "devDependencies": {
    "husky": "^1.1.2",
    "lint-staged": "^8.0.4"
  },
  "husky": {
    "hooks": {
      "pre-commit": "lint-staged"
    }
  },
  "lint-staged": {
    "linters": {
      "*.js": [
        "eslint --max-warnings=0 --report-unused-disable-directives --fix",
        "git add"
      ],
      "*.md": ["prettier --write --parser=markdown", "git add"],
      "*.json": ["prettier --write --parser=json", "git add"]
    }
  }
}
```

# i18n (英语)

-   见 [国际化](https://npmcn.com/package/%40box/frontend/i18n/README.md) 文档.

# 网络包装插件

-   见 [Rsync 缓冲](https://npmcn.com/package/%40box/frontend/webpack/README.md#rsyncplugin) 文档
-   见 [翻译](https://npmcn.com/package/%40box/frontend/webpack/README.md#translationsplugin) 文档
-   见 [监视缓冲](https://npmcn.com/package/%40box/frontend/webpack/README.md#watchdelayplugin) 文档

# 编辑器集成

## 虚拟系统

见 [./.vscode 密码](https://npmcn.com/package/%40box/frontend/.vscode) 建议 [扩展](https://npmcn.com/package/%40box/frontend/.vscode/extensions.json) 财务报告和审定财务报表 [设置](https://npmcn.com/package/%40box/frontend/.vscode/settings.json)。 。 。 .

| 插件 | 已启用 | 自动修正 |
| --- | --- | --- |
| ESLint 语录 | ✔ | 𐄂 |
| 高级 | ✔ | ✔ |

一些ESLint规则可以干扰开发中的调试,因此不建议自动固定ESLint. ESLint 规则可以 请在您的编辑中突出显示, 并在承诺和CI中执行.

# 捐款

见 [捐款](https://npmcn.com/package/%40box/frontend/CONTRIBUTING.md) 编辑 [dev 容器设置](https://npmcn.com/package/%40box/frontend/.devcontainer/README.md)。 。 。 .

# 版权和许可证

版权2016年至今 Box, Inc. All Rights Reserved.

根据"盒式软件许可证协议"获得许可 v. 20170516. 除符合下列条件外,您不得使用此文件: 执照 您可在下列地点获得许可证副本:

[https://developer.box.com/docs/box-sdk-license 页面存档备份,存于互联网档案馆](https://developer.box.com/docs/box-sdk-license)

除非适用的法律要求或书面同意,否则根据许可证分发的软件将在下列网上分发: "As is" Basis,没有警告或任何条件,无论是明示或暗示。 具体内容见许可证 使用语言规范许可证下的许可和限制.

## 常见问题

### @box/frontend 是什么？

前端项目的共同配置和工具

### 如何安装 @box/frontend？

在项目目录运行 npm install @box/frontend，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：husky（^3\.1\.0）、eslint（^8\.57\.0）、lodash（^4\.17\.15）、postcss（^8\.4\.49）、prettier（^3\.8\.3）、stylelint（^16\.18\.0）、typescript（^5\.9\.3）、lint-staged（^9\.5\.0）、@box/cldr-data（^34\.2\.0）、@box/languages（^1\.0\.0）、@commitlint/cli（^19\.8\.0）、stylelint-order（^7\.0\.0）、intl-messageformat（^2\.2\.0）、eslint-plugin-react（^7\.34\.1）、@babel/eslint-parser（^7\.24\.1）、eslint-config-airbnb（^19\.0\.4）、eslint-plugin-import（^2\.29\.1）、eslint-plugin-lodash（^7\.4\.0）、eslint-plugin-ft-flow（^3\.0\.7）、eslint-config-prettier（^9\.1\.0）、eslint-plugin-formatjs（^4\.12\.2）、eslint-plugin-jsx-a11y（^6\.8\.0）、@typescript-eslint/parser（^8\.59\.4）、eslint-plugin-react-hooks（^4\.6\.0）、stylelint-config-standard（^38\.0\.0）、conventional-changelog-cli（^2\.0\.28）、stylelint-config-clean-order（^7\.0\.0）、stylelint-config-standard-scss（^15\.0\.1）、@commitlint/config-conventional（^19\.8\.0）、@typescript-eslint/eslint-plugin（^8\.59\.4）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 props2es、buildBundles，可以用 npx props2es 直接运行。

### @box/frontend 支持 TypeScript 吗？

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

### @box/frontend 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @box/frontend 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js ^22\.0\.0 \|\| ^24\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @box/frontend 可以商用吗？

@box/frontend 使用 SEE LICENSE IN LICENSE 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @box/frontend 的下载量有多少？

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

### @box/frontend 还在维护吗？

最新版本 12\.1\.0 发布于 2026/10/09（29 天前）；至今共发布 54 个版本，其中过去 12 个月发布了 5 个；首次发布于 2018/11/03。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

