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

> 40 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-perlcritic-adapter-ts
Source text: https://banes-lab.com/source/quality/core/adapters/tool.perlcritic.adapter.ts.txt

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

## Definitions

- `runPerlcritic` (lexical_declaration, line 20)
- `TOOL` (lexical_declaration, line 14)
- `LANGUAGE` (lexical_declaration, line 15)
- `PROFILE_FILE` (lexical_declaration, line 16)
- `DEFAULTS` (lexical_declaration, line 17)
- `VERBOSE_FORMAT` (lexical_declaration, line 18)
- `{ command, severity }` (lexical_declaration, line 21)
- `{ bin, prefix }` (lexical_declaration, line 23)
- `advisory` (lexical_declaration, line 24)
- `spec` (lexical_declaration, line 25)
- `args` (lexical_declaration, line 30)

## 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)
- [core/resolvers/tool.resolver.ts](https://banes-lab.com/source/quality/core/resolvers/tool.resolver.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)
- [core/resolvers](https://banes-lab.com/anatomy/quality/folder-quality-core-resolvers.md)

## Source

```typescript
import { PERLCRITIC_DELIMITER, parsePerlcriticOutput } from "#core/parsers/tool.perlcritic.parser";
import type { RunnerContext, ScanSpec } from "#types/tool.types";
import { commandHint, toolErrorMessage } from "#configuration/strings/tool.strings";
import { nativeToolConfig, toolSetting } from "#core/resolvers/tool.resolver";
import { toolCacheRelative, writeToolFile } 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 { quietGatingAdvisory } from "#core/factories/tool.factory";
import { scanTool } from "#core/adapters/tool.adapter";
import { toolFailure } from "#core/factories/finding.factory";

const TOOL = "perlcritic";
const LANGUAGE = "perl";
const PROFILE_FILE = ".perlcriticrc";
const DEFAULTS = { command: TOOL, severity: "3" };
const VERBOSE_FORMAT = ["%f", "%l", "%c", "%s", "%p", "%m%n"].join(PERLCRITIC_DELIMITER);

const runPerlcritic = async function runPerlcritic(context: RunnerContext): Promise<RunResult> {
    const { command, severity } = await toolSetting(context.root, TOOL, DEFAULTS);
    writeToolFile(context.root, PROFILE_FILE, await nativeToolConfig(context.root, LANGUAGE, PROFILE_FILE));
    const { bin, prefix } = commandOf(command, TOOL);
    const advisory = quietGatingAdvisory(context, TOOL, commandHint(TOOL, bin));
    const spec: ScanSpec = {
        failed: (result, findings) => findings.length === 0 && (result.status ?? 0) !== 0,
        failure: (exit) => toolFailure(advisory, toolErrorMessage(TOOL, exit.status, exitDetail(exit))),
        parse: (result) => parsePerlcriticOutput(result.stdout, context.ecosystem),
    };
    const args = [
        ...prefix,
        "--profile",
        toolCacheRelative(PROFILE_FILE),
        "--severity",
        severity,
        "--verbose",
        VERBOSE_FORMAT,
        ...context.paths,
    ];
    return scanTool(advisory, { args, bin, cwd: context.root }, spec);
};

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