sarif-codeclimate

Sarif-CodeClimate

This project aims to convert a SARIF output file from a linter to a CodeClimate output file. It could be use inside GitLab to display to the user the result of the linter inside the MR.

Installation

# npm
npm i -g sarif-codeclimate@latest

# yarn 
yarn global add sarif-codeclimate@latest

You can update latest tag by a specific version tag

Usage

You can use this tool in two ways:

1. Using the CLI

sarif-codeclimate --input <path to sarif file> --output <path to codeclimate file>

👉 You can also use the short version of the arguments -i and -o. Output file is optional, if you don't specify it, the output will be printed in the console.

2. Importing the module in your code

Here is an example of how to read a SARIF file and convert it to a CodeClimate file:

const parser = require('sarif-codeclimate/lib/parser');
const fs = require('fs');

//Read the content of a SARIF file
const sarifFile = fs.readFileSync('file.sarif', 'utf8');
// Return a object with a data that represent the JSON object and an error field
const { data, error } = parser(sarifFile);
if (error) {
  console.error(error);
  return;
} else {
  fs.writeFileSync('codeclimate-result.json', JSON.stringify(data, null, 4));
}

Contributing

Are you missing something or want to contribute? Feel free to open an issue or create a pull request

License

MIT

Author

GridexX, a french DevOps working for R2DevOps