https://github.com/remcohaszing/codeclimate-types

TypeScript type definitions for code climate reports
https://github.com/remcohaszing/codeclimate-types

codeclimate codequality gitlab types typescript

Last synced: 2 months ago
JSON representation

TypeScript type definitions for code climate reports

• Host: GitHub
• URL: https://github.com/remcohaszing/codeclimate-types
• Owner: remcohaszing
• License: mit
• Created: 2023-07-20T09:20:30.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-03T12:19:35.000Z (5 months ago)
• Last Synced: 2024-10-06T12:00:09.512Z (3 months ago)
• Topics: codeclimate, codequality, gitlab, types, typescript
• Homepage:
• Size: 120 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# codeclimate-types

[![github actions](https://github.com/remcohaszing/codeclimate-types/actions/workflows/ci.yaml/badge.svg)](https://github.com/remcohaszing/codeclimate-types/actions/workflows/ci.yaml)

[![npm version](https://img.shields.io/npm/v/codeclimate-types)](https://www.npmjs.com/package/codeclimate-types)

[![npm downloads](https://img.shields.io/npm/dm/codeclimate-types)](https://www.npmjs.com/package/codeclimate-types)

TypeScript type definitions for

[Code Climate reports](https://github.com/codeclimate/platform/blob/master/spec/analyzers/SPEC.md)

## Table of Contents

- [Installation](#installation)

- [Usage](#usage)

- [API](#api)

- [Related Projects](#related-projects)

- [License](#license)

## Installation

```sh

npm install codeclimate-types

```

## Usage

This package can be used to work with

[Code Climate reports](https://github.com/codeclimate/platform/blob/master/spec/analyzers/SPEC.md#issues)

in a type-safe manner. A practical use case is to generate a

[GitLab code quality](https://docs.gitlab.com/ee/ci/testing/code_quality.html) artifact.

## API

The package exports the following types:

- `Issue` — An issue represents a single instance of a real or potential code problem, detected by a

  static analysis Engine.

- `Category` — Issues must be associated with one or more categories.

- `Location` — Locations refer to ranges of a source code file.

- `Position` — Positions refer to specific characters within a source file.

- `Content` — Content gives more information about the issue’s check.

- `Trace` — Some engines require the ability to refer to other source locations in describing an

  issue.

- `Severity` — A severity string describing the potential impact of the issue found.

## Related Projects

- [`eslint-formatter-gitlab`](https://gitlab.com/remcohaszing/eslint-formatter-gitlab) — Show ESLint

  results directly in the GitLab code quality results

## License

[MIT](LICENSE.md) © [Remco Haszing](https://github.com/remcohaszing)