{"id":15055448,"url":"https://github.com/zavoloklom/eslint-formatter-gitlab","last_synced_at":"2025-07-21T05:04:25.942Z","repository":{"id":242868132,"uuid":"810725088","full_name":"zavoloklom/eslint-formatter-gitlab","owner":"zavoloklom","description":"Formatter that transforms ESLint reports into a format suitable for use with GitLab widgets.","archived":false,"fork":false,"pushed_at":"2025-06-20T11:55:03.000Z","size":133,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-20T12:42:19.635Z","etag":null,"topics":["eslint","eslint-formatter","eslintformatter","gitlab","gitlab-ci"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zavoloklom.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-05T08:40:26.000Z","updated_at":"2025-06-20T11:55:07.000Z","dependencies_parsed_at":"2024-06-05T13:03:11.363Z","dependency_job_id":"0f9e3fc9-58ab-4c04-9a0a-f7dc26079ded","html_url":"https://github.com/zavoloklom/eslint-formatter-gitlab","commit_stats":null,"previous_names":["zavoloklom/eslint-formatter-gitlab"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/zavoloklom/eslint-formatter-gitlab","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zavoloklom%2Feslint-formatter-gitlab","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zavoloklom%2Feslint-formatter-gitlab/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zavoloklom%2Feslint-formatter-gitlab/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zavoloklom%2Feslint-formatter-gitlab/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zavoloklom","download_url":"https://codeload.github.com/zavoloklom/eslint-formatter-gitlab/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zavoloklom%2Feslint-formatter-gitlab/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266242072,"owners_count":23898102,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["eslint","eslint-formatter","eslintformatter","gitlab","gitlab-ci"],"created_at":"2024-09-24T21:42:13.719Z","updated_at":"2025-07-21T05:04:25.920Z","avatar_url":"https://github.com/zavoloklom.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Eslint Gitlab Codequality Formatter\n\n[![Latest Release](https://gitlab.com/gitlab-formatters/eslint-formatter-gitlab/-/badges/release.svg?style=flat-square)](https://gitlab.com/gitlab-formatters/eslint-formatter-gitlab/-/releases)\n![Coverage Badge](https://img.shields.io/codacy/coverage/f40620b9d84b4424ae766a0bda5d768c?style=flat-square\u0026label=Coverage)\n[![Codacy Code Quality Badge](https://img.shields.io/codacy/grade/f40620b9d84b4424ae766a0bda5d768c?style=flat-square\u0026logo=codacy\u0026label=Code%20Quality)](https://app.codacy.com/gl/gitlab-formatters/eslint-formatter-gitlab/dashboard?utm_source=gl\u0026utm_medium=referral\u0026utm_content=\u0026utm_campaign=Badge_grade)\n[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits\u0026logoColor=whit\u0026style=flat-square)](https://conventionalcommits.org)\n\nFormatter that transforms [ESLint](https://eslint.org/) reports into a format suitable for use\nwith [GitLab widgets](https://docs.gitlab.com/ee/ci/testing/code_quality.html).\n\n\u003e The source code is hosted on [GitLab](https://gitlab.com/gitlab-formatters/eslint-formatter-gitlab).\n\u003e Although there is an automatic mirror of this repository\n\u003e on [GitHub](https://github.com/zavoloklom/eslint-formatter-gitlab), all bug reports, feature requests, and merge\n\u003e requests should be submitted through GitLab.\n\n## Usage\n\nInstall `eslint` and `@gitlab-formatters/eslint-formatter-gitlab` using your package manager:\n\n```bash\nnpm install --save-dev eslint @gitlab-formatters/eslint-formatter-gitlab\n```\n\n```bash\nyarn add --dev eslint @gitlab-formatters/eslint-formatter-gitlab\n```\n\nTo use in your project, simply run:\n\n```bash\nnpx eslint . --format=@gitlab-formatters/gitlab\n```\n\nFor integration with GitLab CI, add the following to your `.gitlab-ci.yml`:\n\n```yml\neslint:\n  image: node:20.14.0-alpine3.20\n  stage: codequality\n  script:\n    - npm ci\n    - npx eslint . --format=@gitlab-formatters/gitlab --output-file=gl-codequality.json\n  artifacts:\n    reports:\n      codequality: gl-codequality.json\n```\n\n## Report Example\n\nBelow is a JSON example of how the formatter reports issues.\n\nThis particular example outputs a detailed report that goes beyond the minimal fields required by GitLab's code quality\nwidgets.\n\nWhile GitLab requires only a subset of fields according to\nthe [Gitlab Code Quality specification](https://docs.gitlab.com/ee/ci/testing/code_quality.html#implement-a-custom-tool),\nthis formatter implements the full set of fields as outlined in\nthe [Code Climate Issue Data Type specification](https://github.com/codeclimate/platform/blob/master/spec/analyzers/SPEC.md#issues).\n\nThis comprehensive implementation enhances the depth of information available and facilitates better issue tracking and\nresolution.\n\n```json\n[\n  {\n    \"type\": \"issue\",\n    \"check_name\": \"import/order\",\n    \"description\": \"`./app.module` import should occur after import of `@nestjs/mongoose/dist/mongoose-core.module`\",\n    \"content\": {\n      \"body\": \"Error found in import/order\"\n    },\n    \"categories\": [\n      \"Style\"\n    ],\n    \"location\": {\n      \"path\": \"src/cli.ts\",\n      \"lines\": {\n        \"begin\": 2,\n        \"end\": 2\n      },\n      \"positions\": {\n        \"begin\": {\n          \"line\": 2,\n          \"column\": 1\n        },\n        \"end\": {\n          \"line\": 2,\n          \"column\": 42\n        }\n      }\n    },\n    \"severity\": \"major\",\n    \"fingerprint\": \"9209a8c4e2408f83d9dd5063891f4e96\"\n  }\n]\n```\n\nYou can see an example of the widget and how errors are displayed\nin [Merge Request #2](https://gitlab.com/gitlab-formatters/eslint-formatter-gitlab/-/merge_requests/2).\n\nThis merge request includes detailed examples and explanations of the widget's functionality, showcasing how it\nintegrates with GitLab to display code quality issues reported by ESLint.\n\nReviewing this merge request can provide insights into the formatter's capabilities and how it enhances error reporting\nwithin GitLab.\n\n## Contributing\n\nIf you'd like to contribute to this project, please read through [CONTRIBUTING.md](./CONTRIBUTING.md) file.\n\n## Changelog\n\n\u003e Changelog is automatically generated based on [semantic-release](https://github.com/semantic-release/changelog)\n\u003e and [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/).\n\nSee the [CHANGELOG.md](./CHANGELOG.md) file for detailed lists of changes for each version.\n\n## License\n\nMIT License. See the [License File](./LICENSE) for more information.\n\n## Contact\n\nIf you have any questions or suggestions, feel free to reach out by\n\n- Email: [s.kupletsky@gmail.com](mailto:s.kupletsky@gmail.com)\n- Twitter: \u003chttps://twitter.com/zavoloklom/\u003e\n- GitHub: \u003chttps://github.com/zavoloklom/\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzavoloklom%2Feslint-formatter-gitlab","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzavoloklom%2Feslint-formatter-gitlab","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzavoloklom%2Feslint-formatter-gitlab/lists"}