# @cbs-consulting/tools 中文文档

规范地址：https://npmcn.com/package/%40cbs-consulting/tools/

版本：1\.3\.1
npm 元数据更新时间：2026-10-26T06:06:01.567Z
中文译文更新时间：2026-11-09T05:49:16.541Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40cbs-consulting/tools
原文对照：https://npmcn.com/package/%40cbs-consulting/tools/?lang=original

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

- 包体积（解压后）：20.2 kB，12 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：^20\.19\.0 \|\| ^22\.13\.0 \|\| \>=24\.0\.0
- 运行依赖：2 个
- peer 依赖：eslint ^10，@sap/cds \>=9，prettier \>=3，@ui5/linter \>=1，@sap/eslint-plugin-cds \>=4\.2
- 首次发布：2026-02-05T22:40:54.859Z
- 最新版本发布：2026-10-26T06:06:01.371Z
- 近 30 天下载量：5876（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 9 个）

## 中文简介

配置文件 ESLint, UI5 Linter 和 Pretier

## 安装

```sh
npm install @cbs-consulting/tools
```

也可以使用：`pnpm add @cbs-consulting/tools`、`yarn add @cbs-consulting/tools`、`bun add @cbs-consulting/tools`

## README

# @cbs-咨询/工具

`@cbs-consulting/tools` 是一个配置软件包,为开发SAPUI5和/或SAP Cloud应用编程模型(SAP CAP)应用程序提供共享的ESLint配置. 此外,它还包括一个Pretier配置,以确保各项目一致的代码格式.

## ESLint 语录

### 版本要求

-   节点.js `^20.19.0 || ^22.13.0 || >=24.0.0` 需要时间.
-   `eslint` `>=10` 需要时间.
-   `prettier` `>=3` 用于Pretier配置使用.
-   `@sap/cds` `>=9` 是可选的,只有在使用 CAP 规则集时才需要.
-   `@sap/eslint-plugin-cds` `>=4` 是可选的,只有在使用 CAP 规则集时才需要.

### 安装

每个框架和语言都有单独的规则集. 所有这些规则集都是基于共同的规则集.

#### SAPUI5 (爪哇脚本)

对于使用 JavaScript 的 SAPUI5 工程, 安装以下 dev 依赖性 :

```bash
npm install --save-dev @cbs-consulting/tools eslint
```

#### SAPUI5 (脚本)

对于使用 TypeScript 的 SAPUI5 项目,安装以下非依赖性:

```bash
npm install --save-dev @cbs-consulting/tools eslint
```

#### SAP CAP (爪哇脚本)

对于使用JavaScript的SAP CAP项目,安装以下非依赖性:

```bash
npm install --save-dev @cbs-consulting/tools eslint @sap/cds @sap/eslint-plugin-cds
```

#### SAP CAP( 电视脚本)

对于使用 TypeScript 的 SAP CAP 项目,安装以下依赖性:

```bash
npm install --save-dev @cbs-consulting/tools eslint @sap/cds @sap/eslint-plugin-cds
```

> `typescript-eslint` 与 `@cbs-consulting/tools`,因此不需要自己安装。 安装您自己的副本可导致 `eslint` 同侪依赖性冲突(较老的) `typescript-eslint` 可能不支持ESLint 10.

### 使用量

要使用 ESLint 配置, 创建或扩展其中的相关配置 `eslint.config.mjs` 文档.

#### SAPUI5 软件

##### Java 脚本

```javascript
import ui5JsConfig from "@cbs-consulting/tools/eslint/ui5/js/eslint.config.mjs";

export default ui5JsConfig;
```

##### 类型脚本

```javascript
import ui5TsConfig from "@cbs-consulting/tools/eslint/ui5/ts/eslint.config.mjs";

export default ui5TsConfig;
```

#### SAP 联合呼吁程序

##### Java 脚本

```javascript
import capJsConfig from "@cbs-consulting/tools/eslint/cap/js/eslint.config.mjs";

export default capJsConfig;
```

##### 类型脚本

```javascript
import capTsConfig from "@cbs-consulting/tools/eslint/cap/ts/eslint.config.mjs";

export default capTsConfig;
```

## 高级

### 安装

通过 npm 安装必要的软件包 :

```bash
npm install --save-dev @cbs-consulting/tools prettier prettier-plugin-organize-imports @prettier/plugin-xml
```

要使用 Pretier 配置, 请在您的 `prettier.config.mjs` 文件 :

```javascript
import prettierConfig from "@cbs-consulting/tools/prettier/prettier.config.mjs";

export default prettierConfig;
```

## UI5 线条

```bash
npm install --save-dev @cbs-consulting/tools @ui5/linter
```

要使用UI5 Linter 配置, 请创建配置文件 `ui5lint.config.mjs`。 。 。 .

```javascript
import ui5LinterConfig from "@cbs-consulting/tools/ui5-linter/ui5lint.config.mjs";

export default ui5LinterConfig;
```

### 单曲

UI5 Linter 从它运行的文件夹中解析它的配置, 所以在一个 每个UI5应用程序都从自己的目录中运行 linter. 保持单身 `ui5lint.config.mjs` 在工作空间根部,并通过它指向每个应用程序 `--config`数字 :

```jsonc
// app/<my-app>/package.json
{
  "scripts": {
    "ui5lint": "ui5lint --config ../../ui5lint.config.mjs",
    "ui5lint-fix": "ui5lint --fix --config ../../ui5lint.config.mjs"
  }
}
```

在工作空间根上添加汇总脚本以运行每个应用程序 :

```jsonc
// package.json (root)
{
  "scripts": {
    "ui5lint": "npm run ui5lint --workspaces --if-present",
    "ui5lint-fix": "npm run ui5lint-fix --workspaces --if-present"
  }
}
```

> 在沙盒或 CI 环境中, 墨盒可以打印一个 `@ui5/linter update check failed` 框引用 `~/.config`这是一个无害的更新检查 警告,且不影响倾斜的结果.

## 移动

### 从 `cbs-tools` 改为 `@cbs-consulting/tools`

软件包从 `cbs-tools` 改为 `@cbs-consulting/tools`替换 依赖并相应更新每个导入规格 (单位:千美元)`cbs-tools/...` → `@cbs-consulting/tools/...`) (中文(简体) ).

### 升级到ESLint 10

`@cbs-consulting/tools@1.2.x` 需求 **ESLint 10 (英语)** (单位:千美元)`eslint@^10`) (中文(简体) ). 何时 升级 :

-   弹出 `eslint` 改为 `^10`。 。 。 .
-   弹出 `@sap/eslint-plugin-cds` 改为 `>=4.2` (4.1只支持ESLint 9).
-   删除任何工程级别 `@typescript-eslint/*` 或者说 `typescript-eslint` 针 - 兼容 `typescript-eslint` 与此软件包相捆绑。 旧针头 (例如:. `8.53.0`)不支持ESLint 10,并将断开 `npm install`。 。 。 .

## 许可证

这个包裹根据麻省理工学院的许可证获得许可.

## 常见问题

### @cbs-consulting/tools 是什么？

配置文件 ESLint, UI5 Linter 和 Pretier

### 如何安装 @cbs-consulting/tools？

在项目目录运行 npm install @cbs-consulting/tools，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：eslint（^10）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @cbs-consulting/tools 支持 TypeScript 吗？

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

### @cbs-consulting/tools 支持 ESM 还是 CommonJS？

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

### @cbs-consulting/tools 需要什么版本的 Node\.js？

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

### @cbs-consulting/tools 可以商用吗？

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

### @cbs-consulting/tools 的下载量有多少？

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

### @cbs-consulting/tools 还在维护吗？

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