# @gitlab-formatters/stylelint-formatter-gitlab 中文文档

规范地址：https://npmcn.com/package/%40gitlab-formatters/stylelint-formatter-gitlab/

版本：1\.0\.2
npm 元数据更新时间：2024-06-18T16:59:44.668Z
中文译文更新时间：2026-11-16T10:57:42.373Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40gitlab-formatters/stylelint-formatter-gitlab
原文对照：https://npmcn.com/package/%40gitlab-formatters/stylelint-formatter-gitlab/?lang=original
项目主页：https://gitlab.com/gitlab-formatters/stylelint-formatter-gitlab
源码仓库：https://gitlab.com/gitlab-formatters/stylelint-formatter-gitlab

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

- 包体积（解压后）：17.6 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：stylelint \>=14
- 首次发布：2024-06-18T15:28:21.639Z
- 最新版本发布：2024-06-18T16:59:44.490Z
- 近 30 天下载量：120226（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

将 Stylelint 报告转换成适合使用 GitLab 部件的格式.

## 安装

```sh
npm install @gitlab-formatters/stylelint-formatter-gitlab
```

也可以使用：`pnpm add @gitlab-formatters/stylelint-formatter-gitlab`、`yarn add @gitlab-formatters/stylelint-formatter-gitlab`、`bun add @gitlab-formatters/stylelint-formatter-gitlab`

## README

# Stytlint Gitlab 代码质量格式

[![Latest Release](https://img.shields.io/npm/v/%40gitlab-formatters%2Fstylelint-formatter-gitlab?style=flat-square)](https://www.npmjs.com/package/@gitlab-formatters/stylelint-formatter-gitlab) ![Coverage Badge](https://img.shields.io/codacy/coverage/8420b859b4654c05a2ba9201620081c7?style=flat-square&label=Coverage) [![Codacy Code Quality Badge](https://img.shields.io/codacy/grade/8420b859b4654c05a2ba9201620081c7?style=flat-square&logo=codacy&label=Code%20Quality)](https://app.codacy.com/gl/gitlab-formatters/stylelint-formatter-gitlab/dashboard?utm_source=gl&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=whit&style=flat-square)](https://conventionalcommits.org/)

改变的东西 [样式林](https://stylelint.io/) 报告的格式适合使用 与 [GitLab 部件](https://docs.gitlab.com/ee/ci/testing/code_quality.html)。 。 。 .

> 源代码托管于 [吉特拉布语Name](https://gitlab.com/gitlab-formatters/stylelint-formatter-gitlab)。 。 。 . 虽然这个寄存器有一个自动镜像 打开 [GitHub 图像](https://github.com/zavoloklom/stylelint-formatter-gitlab),所有错误报告、特性请求和合并 请求应通过GitLab提交.

## 使用量

安装 `stylelint` 财务报告和审定财务报表 `@gitlab-formatters/stylelint-formatter-gitlab` 使用您的软件包管理器 :

```bash
npm install --save-dev stylelint @gitlab-formatters/stylelint-formatter-gitlab
```

```bash
yarn add --dev stylelint @gitlab-formatters/stylelint-formatter-gitlab
```

要在您的工程中使用,只需运行:

```bash
npx stylelint . --custom-formatter=@gitlab-formatters/stylelint-formatter-gitlab
```

关于与 GitLab CI 的合并,请在您 `.gitlab-ci.yml`数字 :

```yml
stylelint:
  image: node:20.14.0-alpine3.20
  stage: codequality
  script:
    - npm ci
    - npx stylelint . --custom-formatter=@gitlab-formatters/stylelint-formatter-gitlab --output-file=gl-codequality.json
  artifacts:
    reports:
      codequality: gl-codequality.json
```

## 报表示例

以下是JSON如何报告问题的例子.

这个特别的例子会输出一份超越 GitLab 代码质量所要求的最小字段的详细报告 部件.

GitLab 只需根据 页:1 [Gitlab 代码质量规格](https://docs.gitlab.com/ee/ci/testing/code_quality.html#implement-a-custom-tool), (中文(简体) ), 此格式将执行在 页:1 [代码 气候问题数据 类型规格](https://github.com/codeclimate/platform/blob/master/spec/analyzers/SPEC.md#issues)。 。 。 .

这种全面执行可提高现有信息的深度并便利更好地跟踪问题 决议.

```json
[
  {
    "type": "issue",
    "check_name": "unit-no-unknown",
    "description": "Unexpected unknown unit \"pp\" (unit-no-unknown)",
    "content": {
      "body": "Error found in unit-no-unknown. See https://stylelint.io/user-guide/rules/unit-no-unknown for more details."
    },
    "categories": [
      "Style"
    ],
    "location": {
      "path": "src/app.module.scss",
      "lines": {
        "begin": 2,
        "end": 2
      },
      "positions": {
        "begin": {
          "line": 2,
          "column": 14
        },
        "end": {
          "line": 2,
          "column": 16
        }
      }
    },
    "severity": "major",
    "fingerprint": "d87ffdeffd6374e748011a709a4d648a"
  }
]
```

您可以看到部件的示例以及显示错误的方式 内 [合并请求 # 1](https://gitlab.com/gitlab-formatters/stylelint-formatter-gitlab/-/merge_requests/1)。 。 。 .

此合并请求包括对部件功能的详细示例和解释, 显示其如何 与 GitLab 集成以显示 Stylelint 报告的代码质量问题.

## 捐款

如果你愿意为这个项目捐款 请读一下 [捐款额](https://npmcn.com/package/%40gitlab-formatters/stylelint-formatter-gitlab/CONTRIBUTING.md) 文档.

## 更改日志

> Changelog 是基于 [语义释放](https://github.com/semantic-release/changelog) 财务报告和审定财务报表 [常规承诺](https://www.conventionalcommits.org/en/v1.0.0/)。 。 。 .

见 [变动情况](https://npmcn.com/package/%40gitlab-formatters/stylelint-formatter-gitlab/CHANGELOG.md) 每个版本的详细更改列表.

## 许可证

MIT许可证。 见 [许可证文件](https://npmcn.com/package/%40gitlab-formatters/stylelint-formatter-gitlab/LICENSE) 更多信息.

## 联系人

如果有任何问题或建议,请随意联系:

-   电子邮件 : [s.kupletsky@gmail.com (英语)](mailto:s.kupletsky@gmail.com)
-   X/ 转子 : [https://x.com/zavoloklom (英语)](https://x.com/zavoloklom)
-   GitHub : (中文(简体) ) [https://github.com/zavoloklom (英语)](https://github.com/zavoloklom)

## 常见问题

### @gitlab-formatters/stylelint-formatter-gitlab 是什么？

将 Stylelint 报告转换成适合使用 GitLab 部件的格式\.

### 如何安装 @gitlab-formatters/stylelint-formatter-gitlab？

在项目目录运行 npm install @gitlab-formatters/stylelint-formatter-gitlab，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：stylelint（\>=14）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @gitlab-formatters/stylelint-formatter-gitlab 支持 TypeScript 吗？

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

### @gitlab-formatters/stylelint-formatter-gitlab 支持 ESM 还是 CommonJS？

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

### @gitlab-formatters/stylelint-formatter-gitlab 可以商用吗？

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

### @gitlab-formatters/stylelint-formatter-gitlab 的下载量有多少？

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

### @gitlab-formatters/stylelint-formatter-gitlab 还在维护吗？

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

