# core/producers/tool.gosec.producer.ts

> 37 lines of code and 9 definitions.

Tree: GovLab Quality
Language: typescript
Layer: application
Canonical: https://banes-lab.com/anatomy/quality#file-quality-core-producers-tool-gosec-producer-ts
Source text: https://banes-lab.com/source/quality/core/producers/tool.gosec.producer.ts.txt

Listed in [core/producers](https://banes-lab.com/api/source/quality/core/producers.md), after [core/producers/tool.golangci-lint.producer.ts](https://banes-lab.com/source/quality/core/producers/tool.golangci-lint.producer.ts.md) and before [core/producers/tool.hadolint.producer.ts](https://banes-lab.com/source/quality/core/producers/tool.hadolint.producer.ts.md).

## Definitions

- `TOOL` (lexical_declaration, line 7)
- `VERSION` (lexical_declaration, line 8)
- `SOURCE` (lexical_declaration, line 9)
- `DOCS` (lexical_declaration, line 10)
- `ENTRY_MARKER` (lexical_declaration, line 11)
- `ruleOf` (lexical_declaration, line 13)
- `[, id, , desc = ""]` (lexical_declaration, line 17)
- `produce` (lexical_declaration, line 36)
- `rules` (lexical_declaration, line 37)

## Contained in

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

## Source

```typescript
import type { CatalogProduct, CatalogRule } from "#types/catalog.types";
import { byRuleId } from "#core/comparators/rule.comparator";
import { defineProducer } from "#core/registries/producer.registry";
import { distinctRules } from "#core/selectors/catalog.selector";
import { remoteText } from "#core/adapters/remote.adapter";

const TOOL = "gosec";
const VERSION = "repo-master";
const SOURCE = "https://raw.githubusercontent.com/securego/gosec/master/rules/rulelist.go";
const DOCS = "https://securego.io/docs/rules";
const ENTRY_MARKER = '{"G';

const ruleOf = function ruleOf(line: string): CatalogRule[] {
    if (!line.includes(ENTRY_MARKER)) {
        return [];
    }
    const [, id, , desc = ""] = line.split('"');
    if (typeof id !== "string" || !id.startsWith("G")) {
        return [];
    }
    return [
        {
            canonical: null,
            category: "security",
            description: desc === "" ? null : desc,
            ecosystem: "go",
            name: desc === "" ? id : desc,
            ruleId: id,
            tool: TOOL,
            toolVersion: VERSION,
            url: `${DOCS}/${id.toLowerCase()}.html`,
        },
    ];
};

const produce = async function produce(): Promise<CatalogProduct[]> {
    const rules = distinctRules(((await remoteText(SOURCE)) ?? "").split("\n").flatMap(ruleOf)).toSorted(byRuleId);
    return [{ rules, source: TOOL, summary: { tool: TOOL, toolVersion: VERSION, total: rules.length } }];
};

defineProducer({ name: TOOL, produce, refresh: "manual" });
```