eslint-formatter-codeclimate/types/eslint-formatter-codeclimate.d.ts

Format ESLint results as a Code Climate report

/**
 * Convert ESLint messages to Code Climate issues.
 *
 * @param {ESLint.LintResult[]} results
 *   The ESLint report results.
 * @param {Record<string, Rule.RuleMetaData>} rulesMeta
 *   The ESLint rule meta data.
 * @param {string} cwd
 *   The current work directory to calculate relative paths against.
 * @returns {Issue[]}
 *   The ESLint messages in the form of a CodeClimate report.
 */
export function toCodeClimate(results: ESLint.LintResult[], rulesMeta: Record<string, Rule.RuleMetaData>, cwd: string): Issue[];
export default formatter;
import type { ESLint } from 'eslint';
import type { Rule } from 'eslint';
import type { Issue } from 'codeclimate-types';
/**
 * An ESLint formatter which represents ESLint results as a Code Climate report.
 *
 * For programmatic use, use {@link toCodeClimate} instead.
 *
 * @param {ESLint.LintResult[]} results
 *   The ESLint report results.
 * @param {ESLint.LintResultData} data
 *   The ESLint report result data.
 * @returns {string}
 *   The Code Climate report as a string.
 */
declare function formatter(results: ESLint.LintResult[], data: ESLint.LintResultData): string;
//# sourceMappingURL=eslint-formatter-codeclimate.d.ts.map