Formatter that transforms ESLint reports into a format suitable for use with GitLab widgets.
!Coverage Badge
Formatter that transforms ESLint reports into a format suitable for use
with GitLab widgets.
> The source code is hosted on GitLab.
> Although there is an automatic mirror of this repository
> on GitHub, all bug reports, feature requests, and merge
> requests should be submitted through GitLab.
Install eslint and @gitlab-formatters/eslint-formatter-gitlab using your package manager:
``bash`
npm install --save-dev eslint @gitlab-formatters/eslint-formatter-gitlab
`bash`
yarn add --dev eslint @gitlab-formatters/eslint-formatter-gitlab
To use in your project, simply run:
`bash`
npx eslint . --format=@gitlab-formatters/gitlab
For integration with GitLab CI, add the following to your .gitlab-ci.yml:
`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
Below is a JSON example of how the formatter reports issues.
This particular example outputs a detailed report that goes beyond the minimal fields required by GitLab's code quality
widgets.
While GitLab requires only a subset of fields according to
the Gitlab Code Quality specification,
this formatter implements the full set of fields as outlined in
the Code Climate Issue Data Type specification.
This comprehensive implementation enhances the depth of information available and facilitates better issue tracking and
resolution.
`json./app.module
[
{
"type": "issue",
"check_name": "import/order",
"description": " 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"
}
]
You can see an example of the widget and how errors are displayed
in Merge Request #2.
This merge request includes detailed examples and explanations of the widget's functionality, showcasing how it
integrates with GitLab to display code quality issues reported by ESLint.
Reviewing this merge request can provide insights into the formatter's capabilities and how it enhances error reporting
within GitLab.
If you'd like to contribute to this project, please read through CONTRIBUTING.md file.
> Changelog is automatically generated based on semantic-release
> and conventional commits.
See the CHANGELOG.md file for detailed lists of changes for each version.
MIT License. See the License File for more information.
If you have any questions or suggestions, feel free to reach out by
- Email: s.kupletsky@gmail.com
- Twitter:
- GitHub: