core/adapters/tool.rubocop.adapter.ts

core/adapters/tool.rubocop.adapter.ts is a file in GovLab Quality. 50 lines of code and 11 definitions.

import type { AdvisoryContext, RunnerContext, ScanSpec, ToolCall } from "#types/tool.types";
import { NO_STDERR_DETAIL, installHint, toolErrorBecause } from "#configuration/strings/tool.strings";
import { fixCycle, passTool, residualOf } from "#core/adapters/tool.adapter";
import type { RunResult } from "#types/finding.types";
import { defineTool } from "#core/registries/tool.registry";
import { gatingAdvisory } from "#core/factories/tool.factory";
import { nativeToolConfig } from "#core/resolvers/tool.resolver";
import { parseRubocopOutput } from "#core/parsers/tool.rubocop.parser";
import { tailLines } from "#core/selectors/failure.selector";
import { toolFailure } from "#core/factories/finding.factory";
import { writeToolFile } from "#core/persistence/tool.persistence";

const TOOL = "rubocop";
const LANGUAGE = "ruby";
const CONFIG_FILE = ".rubocop.yml";
const TOOL_ERROR = 2;

const rubocopSpec = function rubocopSpec(advisory: AdvisoryContext): ScanSpec {
    return {
        failed: (result) => result.status === TOOL_ERROR,
        failure: (exit) =>
            toolFailure(
                advisory,
                toolErrorBecause(
                    TOOL,
                    TOOL_ERROR,
                    "a malformed config or internal error",
                    tailLines(exit.stderr, NO_STDERR_DETAIL),
                ),
            ),
        parse: (result) => parseRubocopOutput(result.stdout, advisory.ecosystem),
    };
};

const rubocopCall = function rubocopCall(context: RunnerContext, configFile: string, withFix: boolean): ToolCall {
    const args = ["--config", configFile, "--format", "json", ...(withFix ? ["-a"] : []), ...context.paths];
    return { args, bin: TOOL, cwd: context.root };
};

const runRubocop = async function runRubocop(context: RunnerContext): Promise<RunResult> {
    const configFile = writeToolFile(
        context.root,
        CONFIG_FILE,
        await nativeToolConfig(context.root, LANGUAGE, CONFIG_FILE),
    );
    const advisory = gatingAdvisory(context, TOOL, installHint(TOOL));
    const spec = rubocopSpec(advisory);
    return fixCycle(
        passTool(advisory, rubocopCall(context, configFile, false), spec),
        (findings) => context.fix && findings.length > 0,
        (reported) => residualOf(reported, passTool(advisory, rubocopCall(context, configFile, true), spec)),
    );
};

defineTool({ ecosystems: [LANGUAGE], run: runRubocop, tool: TOOL });