pi-lens/dist/clients/typos-config.js

Real-time code feedback for pi — LSP, linters, formatters, type-checking, structural analysis & booboo

import * as fs from "node:fs";
import * as path from "node:path";
import { walkUpDirs } from "./path-utils.js";
/**
 * typos (source-code spell checker) configuration discovery. typos runs as a
 * cross-cutting auxiliary LSP (#283); like Opengrep's local-rules gate and
 * zizmor's `zizmor.yml` gate, the PRESENCE of a repo-local typos config is the
 * project's deliberate opt-in to let spelling findings BLOCK (it carries the
 * team's curated allow-list / `extend-words` / severity). Advisory otherwise.
 *
 * typos discovers its config as `typos.toml`, `_typos.toml`, or `.typos.toml`
 * at the project root (see typos' configuration docs). We only need to know if
 * one EXISTS for the blocking gate — the `typos-lsp` server reads it itself.
 *
 * Note: `files.*` ignore globs in the config have NO effect under the LSP
 * (CLI-only), so a `.typos.toml` does not exclude paths from the LSP scan — it
 * only tunes the dictionary/severity. The blocking gate keys purely on presence.
 */
export const LOCAL_TYPOS_CONFIG_NAMES = [
    "typos.toml",
    "_typos.toml",
    ".typos.toml",
];
export function findLocalTyposConfig(startDir) {
    for (const dir of walkUpDirs(startDir || process.cwd())) {
        for (const name of LOCAL_TYPOS_CONFIG_NAMES) {
            const candidate = path.join(dir, name);
            if (fs.existsSync(candidate))
                return candidate;
        }
    }
    return undefined;
}