codeclimate-types v0.3.1

codeclimate-types

TypeScript type definitions for Code Climate reports

Table of Contents

• Installation
• Usage
• API
• Related Projects
• License

Installation

npm install codeclimate-types

Usage

This package can be used to work with Code Climate reports in a type-safe manner. A practical use case is to generate a GitLab code quality 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 — Show ESLint results directly in the GitLab code quality results

License

MIT © Remco Haszing