# @bartekbp/typescript-checkstyle 中文文档

规范地址：https://npmcn.com/package/%40bartekbp/typescript-checkstyle/

版本：5\.0\.0
npm 元数据更新时间：2022-04-04T17:44:50.682Z
中文译文更新时间：2026-11-07T17:17:21.960Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40bartekbp/typescript-checkstyle
原文对照：https://npmcn.com/package/%40bartekbp/typescript-checkstyle/?lang=original
项目主页：https://github.com/bartekbp/typescript-checkstyle#readme
源码仓库：https://github.com/bartekbp/typescript-checkstyle

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

- 包体积（解压后）：13.4 kB，12 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：5 个
- 首次发布：2021-01-23T12:59:51.050Z
- 最新版本发布：2021-07-16T20:06:50.351Z
- 近 30 天下载量：19279（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 0 个）

## 中文简介

库以检查样式格式报告 tsc 输出

## 安装

```sh
npm install @bartekbp/typescript-checkstyle
```

也可以使用：`pnpm add @bartekbp/typescript-checkstyle`、`yarn add @bartekbp/typescript-checkstyle`、`bun add @bartekbp/typescript-checkstyle`

## README

# 字体检查样式

Typescript- checkstyle 是报告的工具 `typescript compiler` 输出于 `checkstyle` 格式。 创建它是为了改进有编译器错误的拉动请求装饰.

## 先决条件

项目要求:

-   节点 10
-   无

## 安装

所有离相被公布为npm. 要使用最新版本,可以使用:

```
npm i --save-dev @bartekbp/typescript-checkstyle
```

## 使用量

从命令行和javascript中可以使用打字检查样式.

### 命令行

图书馆读取 `tsc` 从标准输入输出。 你也许想一起跑 以下命令类型检查您的工程并显示编译错误 `checkstyle` 格式 :

```
> npx tsc --noEmit | npx @bartekbp/typescript-checkstyle
```

如果你已经有 `npm scripts` 配置并想要使用其中之一的输出来打字检查样式, 您需要引用 `npm` 与 **安静** 以压制 npm 预告 :

```
> npm --silent run lint:tsc | npx @bartekbp/typescript-checkstyle
```

### 拖动有打字错误的请求装饰

如果您想要根据压缩输出将注释自动添加到拉动请求中,则打字检查样式将帮助您实现. 要配置它,我会用 `jenkins`,但该解决方案也适用于其他连续集成系统.

#### 詹金斯平线

你需要设置一个 `jenkins pipeline` 将随 [bitbucket 分支源插件](https://plugins.jenkins.io/cloudbees-bitbucket-branch-source/) 或者说 [github 分支源插件](https://github.com/jenkinsci/github-branch-source-plugin)在管道中,您需要运行打印检查样式 `tsc` 并重定向输出到文件 :

```
stage('tsc') {
  steps {
    sh  'npx tsc --noEmit | npx @bartekbp/typescript-checkstyle > tsc-checkstyle.xml'
  }
}
```

根据你的代码审查系统, **假发** 为拉动请求装饰创建了不同的插件. 你可以在底部找到完整的名单 [违反- lib readme](https://github.com/tomasbjerre/violations-lib)我将专注于配置 `bitbucket cloud`。 。 。 .

您需要更新管道, 并添加一个 pr 装饰 :

stage('Decorate pr') {
  steps {
    withCredentials(\[usernamePassword(credentialsId: **'jenkins-pr-writes'**, passwordVariable: 'JENKINS\_VIOLATION\_PASSWORD', usernameVariable: 'JENKINS\_VIOLATION\_USER')\]) {
      sh 'npx violation-comments-to-bitbucket-cloud-command-line -u "$JENKINS\_VIOLATION\_USER" -p "$JENKINS\_VIOLATION\_PASSWORD" -ws **workspace** -rs **repoName** -prid "$CHANGE\_ID" -v "CHECKSTYLE" "." ".\*tsc-checkstyle.xml$" "tsc" || true'
    }
  }
}

舞台上的粗体部分需要更新以反映您的项目:

-   **jenkins 复写** 带有证书到比特巴克特用户
-   **工作空间** 带有 bitbucket 工作空间
-   **重播Name** 拥有已打开的拉动请求的仓库

### Javascript

Typescript- checkstyle 显示一个函数 `format`数字 :

```
/**
 * Converts tsc errors to checkstyle format
 *
 * @param {string} input - errors from tsc
 * @return {string} errors in checkstyle format
 function format(input) {}
 */
```

其使用方式如下:

```
import format from '@bartekbp/typescript-checkstyle';

const input = `src/test.component.ts(3, 12): error TS2564: Property 'name' has no initializer`;
const errorsInCheckstyleFormat = format(input);
console.log(errorsInCheckstyleFormat);
```

此代码打印出错误 `input` 以检查样式格式.

## 许可证

根据麻省理工学院的许可证分发。 更多信息见LICENSE.

## 鸣谢

非常感谢:

-   [假发](https://github.com/tomasbjerre) 为他提供拉动请求装饰的工具
-   [维金穆布](https://github.com/aivenkimmob) tsc 输出解析器
-   [页:1](https://github.com/jimf) 用于将 json 转换为 xml 检查样式格式的工具

## 常见问题

### @bartekbp/typescript-checkstyle 是什么？

库以检查样式格式报告 tsc 输出

### 如何安装 @bartekbp/typescript-checkstyle？

在项目目录运行 npm install @bartekbp/typescript-checkstyle，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 typescript-checkstyle，可以用 npx typescript-checkstyle 直接运行。

### @bartekbp/typescript-checkstyle 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @bartekbp/typescript-checkstyle 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @bartekbp/typescript-checkstyle 可以商用吗？

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

### @bartekbp/typescript-checkstyle 的下载量有多少？

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

### @bartekbp/typescript-checkstyle 还在维护吗？

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