{"_id":"codeclimate-types","name":"codeclimate-types","dist-tags":{"latest":"0.3.1"},"versions":{"0.3.1":{"name":"codeclimate-types","version":"0.3.1","description":"TypeScript type definitions for code climate reports","keywords":["codeclimate","codequality","gitlab","types","typescript"],"homepage":"https://github.com/remcohaszing/codeclimate-types#readme","bugs":{"url":"https://github.com/remcohaszing/codeclimate-types/issues"},"repository":{"type":"git","url":"git+https://github.com/remcohaszing/codeclimate-types.git"},"funding":"https://github.com/sponsors/remcohaszing","license":"MIT","author":{"name":"Remco Haszing","email":"remcohaszing@gmail.com"},"sideEffects":false,"exports":"./index.js","scripts":{"prepack":"tsc --noEmit false","test":"node --test"},"devDependencies":{"prettier":"^3.0.0","remark-cli":"^11.0.0","remark-preset-remcohaszing":"^2.0.0","typescript":"^5.0.0"},"types":"./index.d.ts","_id":"codeclimate-types@0.3.1","_integrity":"sha512-JCAaPG3tAYlVQQE9NP5kgsXBxPfSmflUI7manmbllUd9TN+1p/SXZkOsMAlPXCp3gcqNVL0itxMjcgKF0nBmJg==","_resolved":"/home/runner/work/codeclimate-types/codeclimate-types/codeclimate-types-0.3.1.tgz","_from":"file:codeclimate-types-0.3.1.tgz","_nodeVersion":"20.4.0","_npmVersion":"9.7.2","dist":{"integrity":"sha512-JCAaPG3tAYlVQQE9NP5kgsXBxPfSmflUI7manmbllUd9TN+1p/SXZkOsMAlPXCp3gcqNVL0itxMjcgKF0nBmJg==","shasum":"a50bd181506b5ce5bd3940eca07c1c53c770416b","tarball":"https://registry.npmjs.org/codeclimate-types/-/codeclimate-types-0.3.1.tgz","fileCount":5,"unpackedSize":11554,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/codeclimate-types@0.3.1","provenance":{"predicateType":"https://slsa.dev/provenance/v0.2"}},"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAfhA2NbQQeQT875lwMCEAuWqFV8KC+3QJ1zA4KHsy1ZAiEAyWEIFvubyBwmsSmcVNjfqasBzkLFofgVCaLMg8ALu6s="}]},"_npmUser":{"name":"remcohaszing","email":"remcohaszing@gmail.com"},"directories":{},"maintainers":[{"name":"remcohaszing","email":"remcohaszing@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/codeclimate-types_0.3.1_1689846307802_0.04541698488504653"},"_hasShrinkwrap":false}},"time":{"created":"2023-07-20T09:45:07.712Z","0.3.1":"2023-07-20T09:45:08.012Z","modified":"2023-07-20T09:45:08.527Z"},"maintainers":[{"name":"remcohaszing","email":"remcohaszing@gmail.com"}],"description":"TypeScript type definitions for code climate reports","homepage":"https://github.com/remcohaszing/codeclimate-types#readme","keywords":["codeclimate","codequality","gitlab","types","typescript"],"repository":{"type":"git","url":"git+https://github.com/remcohaszing/codeclimate-types.git"},"author":{"name":"Remco Haszing","email":"remcohaszing@gmail.com"},"bugs":{"url":"https://github.com/remcohaszing/codeclimate-types/issues"},"license":"MIT","readme":"# codeclimate-types\n\n[![github actions](https://github.com/remcohaszing/codeclimate-types/actions/workflows/ci.yaml/badge.svg)](https://github.com/remcohaszing/codeclimate-types/actions/workflows/ci.yaml)\n[![npm version](https://img.shields.io/npm/v/codeclimate-types)](https://www.npmjs.com/package/codeclimate-types)\n[![npm downloads](https://img.shields.io/npm/dm/codeclimate-types)](https://www.npmjs.com/package/codeclimate-types)\n\nTypeScript type definitions for\n[Code Climate reports](https://github.com/codeclimate/platform/blob/master/spec/analyzers/SPEC.md)\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [API](#api)\n- [Related Projects](#related-projects)\n- [License](#license)\n\n## Installation\n\n```sh\nnpm install codeclimate-types\n```\n\n## Usage\n\nThis package can be used to work with\n[Code Climate reports](https://github.com/codeclimate/platform/blob/master/spec/analyzers/SPEC.md#issues)\nin a type-safe manner. A practical use case is to generate a\n[GitLab code quality](https://docs.gitlab.com/ee/ci/testing/code_quality.html) artifact.\n\n## API\n\nThe package exports the following types:\n\n- `Issue` — An issue represents a single instance of a real or potential code problem, detected by a\n  static analysis Engine.\n- `Category` — Issues must be associated with one or more categories.\n- `Location` — Locations refer to ranges of a source code file.\n- `Position` — Positions refer to specific characters within a source file.\n- `Content` — Content gives more information about the issue’s check.\n- `Trace` — Some engines require the ability to refer to other source locations in describing an\n  issue.\n- `Severity` — A severity string describing the potential impact of the issue found.\n\n## Related Projects\n\n- [`eslint-formatter-gitlab`](https://gitlab.com/remcohaszing/eslint-formatter-gitlab) — Show ESLint\n  results directly in the GitLab code quality results\n\n## License\n\n[MIT](LICENSE.md) © [Remco Haszing](https://github.com/remcohaszing)\n","readmeFilename":"README.md"}