# core/adapters/tool.kics.adapter.ts

> 49 lines of code and 11 definitions.

Tree: GovLab Quality
Language: typescript
Layer: infrastructure
Canonical: https://banes-lab.com/anatomy/quality#file-quality-core-adapters-tool-kics-adapter-ts
Source text: https://banes-lab.com/source/quality/core/adapters/tool.kics.adapter.ts.txt

Listed in [core/adapters](https://banes-lab.com/api/source/quality/core/adapters.md), after [core/adapters/tool.jscpd.adapter.ts](https://banes-lab.com/source/quality/core/adapters/tool.jscpd.adapter.ts.md) and before [core/adapters/tool.knip.adapter.ts](https://banes-lab.com/source/quality/core/adapters/tool.knip.adapter.ts.md).

## Definitions

- `scanArgs` (lexical_declaration, line 19)
- `runKics` (lexical_declaration, line 36)
- `TOOL` (lexical_declaration, line 14)
- `DEFAULTS` (lexical_declaration, line 15)
- `REPORT_NAME` (lexical_declaration, line 16)
- `REPORT_EXTENSION` (lexical_declaration, line 17)
- `setting` (lexical_declaration, line 37)
- `{ bin, prefix }` (lexical_declaration, line 38)
- `reportFile` (lexical_declaration, line 39)
- `advisory` (lexical_declaration, line 40)
- `spec` (lexical_declaration, line 41)

## Contained in

- [core/adapters](https://banes-lab.com/anatomy/quality/folder-quality-core-adapters.md)

## Uses

- [core/adapters/tool.adapter.ts](https://banes-lab.com/source/quality/core/adapters/tool.adapter.ts.md)
- [core/persistence/tool.persistence.ts](https://banes-lab.com/source/quality/core/persistence/tool.persistence.ts.md)

## Linked from

- [core/adapters](https://banes-lab.com/anatomy/quality/folder-quality-core-adapters.md)
- [core/persistence](https://banes-lab.com/anatomy/quality/folder-quality-core-persistence.md)

## Source

```typescript
import type { RunnerContext, ScanSpec } from "#types/tool.types";
import { commandHint, incompleteScan } from "#configuration/strings/tool.strings";
import { freshToolFile, readToolReport, toolCacheRelative } from "#core/persistence/tool.persistence";
import type { RunResult } from "#types/finding.types";
import { commandOf } from "#core/lexers/invocation.lexer";
import { defineTool } from "#core/registries/tool.registry";
import { exitDetail } from "#core/selectors/failure.selector";
import { parseKicsReport } from "#core/parsers/tool.kics.parser";
import { scanTool } from "#core/adapters/tool.adapter";
import { toolAdvisory } from "#core/factories/tool.factory";
import { toolFailure } from "#core/factories/finding.factory";
import { toolSetting } from "#core/resolvers/tool.resolver";

const TOOL = "kics";
const DEFAULTS = { command: TOOL, libraries: "", queries: "" };
const REPORT_NAME = "kics";
const REPORT_EXTENSION = ".json";

const scanArgs = function scanArgs(paths: readonly string[], setting: typeof DEFAULTS): string[] {
    return [
        "scan",
        ...paths.flatMap((target) => ["-p", target]),
        ...(setting.queries.length > 0 ? ["-q", setting.queries] : []),
        ...(setting.libraries.length > 0 ? ["--libraries-path", setting.libraries] : []),
        "--report-formats",
        "json",
        "-o",
        toolCacheRelative(),
        "--output-name",
        REPORT_NAME,
        "--no-progress",
        "--ci",
    ];
};

const runKics = async function runKics(context: RunnerContext): Promise<RunResult> {
    const setting = await toolSetting(context.root, TOOL, DEFAULTS);
    const { bin, prefix } = commandOf(setting.command, TOOL);
    const reportFile = freshToolFile(context.root, `${REPORT_NAME}${REPORT_EXTENSION}`);
    const advisory = toolAdvisory(context, TOOL, commandHint(TOOL, bin));
    const spec: ScanSpec = {
        failed: () => readToolReport(reportFile).length === 0,
        failure: (exit) =>
            toolFailure(
                advisory,
                incompleteScan(TOOL, "a missing query library or an unreadable path", exitDetail(exit)),
            ),
        parse: () => parseKicsReport(readToolReport(reportFile), context.ecosystem),
    };
    return scanTool(advisory, { args: [...prefix, ...scanArgs(context.paths, setting)], bin, cwd: context.root }, spec);
};

defineTool({ ecosystems: ["ansible"], run: runKics, tool: TOOL });
```