@gitlab-formatters/eslint-formatter-gitlab

中文文档
1.0.1发布于 2024/06/07MITTypeScriptESM + CJS零依赖近 30 天下载 14万

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

中文使用文档
文档目录6 节
  1. 使用量
  2. 报表示例
  3. 捐款
  4. 更改日志
  5. 许可证
  6. 联系人

Eslint Gitlab 代码质量格式

Latest Release Coverage Badge Codacy Code Quality Badge Conventional Commits

改变的东西 ESLint 语录 报告的格式适合使用 与 GitLab 部件。 。 。 .

源代码托管于 吉特拉布语Name。 。 。 . 虽然这个寄存器有一个自动镜像 打开 GitHub 图像,所有错误报告、特性请求和合并 请求应通过GitLab提交.

使用量

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

npm install --save-dev eslint @gitlab-formatters/eslint-formatter-gitlab
yarn add --dev eslint @gitlab-formatters/eslint-formatter-gitlab

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

npx eslint . --format=@gitlab-formatters/gitlab

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

eslint:
  image: node:20.14.0-alpine3.20
  stage: codequality
  script:
    - npm ci
    - npx eslint . --format=@gitlab-formatters/gitlab --output-file=gl-codequality.json
  artifacts:
    reports:
      codequality: gl-codequality.json

报表示例

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

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

GitLab 只需根据 页:1 Gitlab 代码质量规格, (中文(简体) ), 此格式将执行在 页:1 代码 气候问题数据 类型规格。 。 。 .

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

[
  {
    "type": "issue",
    "check_name": "import/order",
    "description": "`./app.module` import should occur after import of `@nestjs/mongoose/dist/mongoose-core.module`",
    "content": {
      "body": "Error found in import/order"
    },
    "categories": [
      "Style"
    ],
    "location": {
      "path": "src/cli.ts",
      "lines": {
        "begin": 2,
        "end": 2
      },
      "positions": {
        "begin": {
          "line": 2,
          "column": 1
        },
        "end": {
          "line": 2,
          "column": 42
        }
      }
    },
    "severity": "major",
    "fingerprint": "9209a8c4e2408f83d9dd5063891f4e96"
  }
]

您可以看到部件的示例以及显示错误的方式 内 合并请求 # 2。 。 。 .

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

审查这一合并请求可以使人们深入了解该主题的能力以及如何加强错误报告 在基特拉布内.

捐款

如果你愿意为这个项目捐款 请读一下 捐款额 文档.

更改日志

Changelog 是基于 语义释放 财务报告和审定财务报表 常规承诺。 。 。 .

见 变动情况 每个版本的详细更改列表.

许可证

MIT许可证。 见 许可证文件 更多信息.

联系人

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

版本与发布记录

@gitlab-formatters/eslint-formatter-gitlab 共发布 4 个版本,首次发布于 2024/06/07;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.1latest2024/06/072 年前
1.0.02024/06/052 年前
0.0.22024/06/052 年前
0.0.12024/06/042 年前

关于 @gitlab-formatters/eslint-formatter-gitlab 的常见问题

@gitlab-formatters/eslint-formatter-gitlab 是什么?

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

如何安装 @gitlab-formatters/eslint-formatter-gitlab?

在项目目录运行 npm install @gitlab-formatters/eslint-formatter-gitlab,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:eslint(>=8 <10)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@gitlab-formatters/eslint-formatter-gitlab 支持 TypeScript 吗?

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

@gitlab-formatters/eslint-formatter-gitlab 支持 ESM 还是 CommonJS?

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

@gitlab-formatters/eslint-formatter-gitlab 可以商用吗?

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

@gitlab-formatters/eslint-formatter-gitlab 的下载量有多少?

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

@gitlab-formatters/eslint-formatter-gitlab 还在维护吗?

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