@hominis/fireforge 0.54.0 → 0.60.0

package/dist/src/core/config-validate-check.js

@@ -1,219 +0,0 @@
-// SPDX-License-Identifier: EUPL-1.2
-/**
- * Validation for the `check` block (`fireforge check`).
- *
- * Split out of `config-validate.ts`, which is at its per-file line budget,
- * following the `config-validate-build-audit.ts` precedent. Unknown keys are
- * refused: a misspelt `extraSteps` would otherwise drop a project audit from
- * the gate without a word.
- */
-import { ConfigError } from '../errors/config.js';
-import { CHECK_BUILTIN_STEPS, } from '../types/config.js';
-import { isContainedRelativePath } from '../utils/paths.js';
-import { isObject } from '../utils/validation.js';
-const STEP_NAME_PATTERN = /^[a-z0-9][a-z0-9-]*$/;
-function assertKnownKeys(raw, field, known) {
-    for (const key of Object.keys(raw)) {
-        if (!known.includes(key)) {
-            throw new ConfigError(`Config field "${field}" has unknown key "${key}"`);
-        }
-    }
-}
-function parseStringList(raw, field) {
-    if (!Array.isArray(raw) || raw.some((entry) => typeof entry !== 'string' || entry === '')) {
-        throw new ConfigError(`Config field "${field}" must be an array of non-empty strings`);
-    }
-    return raw;
-}
-function parseNonNegativeInteger(raw, field) {
-    if (typeof raw !== 'number' || !Number.isInteger(raw) || raw < 0) {
-        throw new ConfigError(`Config field "${field}" must be a non-negative integer`);
-    }
-    return raw;
-}
-function isBuiltinStep(value) {
-    return CHECK_BUILTIN_STEPS.includes(value);
-}
-function parseSkip(raw) {
-    const skip = parseStringList(raw, 'check.skip');
-    for (const entry of skip) {
-        if (!isBuiltinStep(entry)) {
-            throw new ConfigError(`Config field "check.skip" names unknown step "${entry}". Valid: ${CHECK_BUILTIN_STEPS.join(', ')}`);
-        }
-    }
-    return skip;
-}
-function parseStatusPolicy(raw) {
-    if (!isObject(raw))
-        throw new ConfigError('Config field "check.status" must be a plain object');
-    assertKnownKeys(raw, 'check.status', ['failOn', 'allow', 'failOnUnknown']);
-    const out = {};
-    if (raw['failOn'] !== undefined)
-        out.failOn = parseStringList(raw['failOn'], 'check.status.failOn');
-    if (raw['allow'] !== undefined)
-        out.allow = parseStringList(raw['allow'], 'check.status.allow');
-    if (raw['failOnUnknown'] !== undefined) {
-        if (typeof raw['failOnUnknown'] !== 'boolean') {
-            throw new ConfigError('Config field "check.status.failOnUnknown" must be a boolean');
-        }
-        out.failOnUnknown = raw['failOnUnknown'];
-    }
-    return out;
-}
-function parseMaxWarnings(raw) {
-    if (!isObject(raw)) {
-        throw new ConfigError('Config field "check.maxWarnings" must be a plain object');
-    }
-    assertKnownKeys(raw, 'check.maxWarnings', ['lint', 'furnace']);
-    const out = {};
-    if (raw['lint'] !== undefined) {
-        out.lint = parseNonNegativeInteger(raw['lint'], 'check.maxWarnings.lint');
-    }
-    if (raw['furnace'] !== undefined) {
-        out.furnace = parseNonNegativeInteger(raw['furnace'], 'check.maxWarnings.furnace');
-    }
-    return out;
-}
-function parseExtraStep(raw, field) {
-    if (!isObject(raw)) {
-        throw new ConfigError(`Config field "${field}" must be a plain object with "name" and "command"`);
-    }
-    assertKnownKeys(raw, field, ['name', 'command', 'cwd', 'timeout', 'after']);
-    const name = raw['name'];
-    if (typeof name !== 'string' || !STEP_NAME_PATTERN.test(name)) {
-        throw new ConfigError(`Config field "${field}.name" must be lowercase letters, digits and dashes (e.g. "policy-audit")`);
-    }
-    if (isBuiltinStep(name)) {
-        throw new ConfigError(`Config field "${field}.name" "${name}" is a built-in step name`);
-    }
-    const command = raw['command'];
-    if (typeof command !== 'string' || command.trim() === '') {
-        throw new ConfigError(`Config field "${field}.command" must be a non-empty string`);
-    }
-    const step = { name, command };
-    if (raw['cwd'] !== undefined) {
-        const cwd = raw['cwd'];
-        if (typeof cwd !== 'string' || cwd.trim() === '' || !isContainedRelativePath(cwd)) {
-            throw new ConfigError(`Config field "${field}.cwd" must be a project-relative path`);
-        }
-        step.cwd = cwd;
-    }
-    if (raw['timeout'] !== undefined) {
-        step.timeout = parsePositiveSeconds(raw['timeout'], `${field}.timeout`);
-    }
-    if (raw['after'] !== undefined)
-        step.after = parseStringList(raw['after'], `${field}.after`);
-    return step;
-}
-function parsePositiveSeconds(raw, field) {
-    const seconds = parseNonNegativeInteger(raw, field);
-    if (seconds === 0) {
-        throw new ConfigError(`Config field "${field}" must be a positive number of seconds`);
-    }
-    return seconds;
-}
-/**
- * Checks every `after` names a known step and the extra steps' ordering
- * has no cycle: a cycle would leave its steps waiting forever.
- */
-function assertExtraStepOrdering(steps) {
-    const extras = new Map(steps.map((step) => [step.name, step]));
-    for (const [index, step] of steps.entries()) {
-        for (const dependency of step.after ?? []) {
-            if (dependency === step.name) {
-                throw new ConfigError(`Config field "check.extraSteps[${String(index)}].after" names the step itself`);
-            }
-            if (!isBuiltinStep(dependency) && !extras.has(dependency)) {
-                throw new ConfigError(`Config field "check.extraSteps[${String(index)}].after" names unknown step "${dependency}"`);
-            }
-        }
-    }
-    const state = new Map();
-    const visit = (name, path) => {
-        if (state.get(name) === 'done')
-            return;
-        if (state.get(name) === 'visiting') {
-            throw new ConfigError(`Config field "check.extraSteps" orders its steps in a cycle: ${[...path, name].join(' -> ')}`);
-        }
-        state.set(name, 'visiting');
-        for (const dependency of extras.get(name)?.after ?? []) {
-            if (extras.has(dependency))
-                visit(dependency, [...path, name]);
-        }
-        state.set(name, 'done');
-    };
-    for (const step of steps)
-        visit(step.name, []);
-}
-function parseTimeouts(raw) {
-    if (!isObject(raw))
-        throw new ConfigError('Config field "check.timeouts" must be a plain object');
-    assertKnownKeys(raw, 'check.timeouts', [...CHECK_BUILTIN_STEPS]);
-    const out = {};
-    for (const [name, value] of Object.entries(raw)) {
-        if (isBuiltinStep(name))
-            out[name] = parsePositiveSeconds(value, `check.timeouts.${name}`);
-    }
-    return out;
-}
-function parseExtraSteps(raw) {
-    if (!Array.isArray(raw))
-        throw new ConfigError('Config field "check.extraSteps" must be an array');
-    const steps = raw.map((entry, index) => parseExtraStep(entry, `check.extraSteps[${String(index)}]`));
-    const seen = new Set();
-    for (const step of steps) {
-        if (seen.has(step.name)) {
-            throw new ConfigError(`Config field "check.extraSteps" repeats the step name "${step.name}"`);
-        }
-        seen.add(step.name);
-    }
-    assertExtraStepOrdering(steps);
-    return steps;
-}
-/**
- * Parses the `check` block.
- *
- * @param raw - The raw `check` value from fireforge.json
- * @returns The validated block
- */
-export function parseCheckConfig(raw) {
-    if (!isObject(raw))
-        throw new ConfigError('Config field "check" must be a plain object');
-    assertKnownKeys(raw, 'check', [
-        'skip',
-        'status',
-        'maxWarnings',
-        'extraSteps',
-        'timeout',
-        'timeouts',
-        'failOnSkipped',
-        'lintReport',
-    ]);
-    const out = {};
-    if (raw['skip'] !== undefined)
-        out.skip = parseSkip(raw['skip']);
-    if (raw['status'] !== undefined)
-        out.status = parseStatusPolicy(raw['status']);
-    if (raw['maxWarnings'] !== undefined)
-        out.maxWarnings = parseMaxWarnings(raw['maxWarnings']);
-    if (raw['extraSteps'] !== undefined)
-        out.extraSteps = parseExtraSteps(raw['extraSteps']);
-    if (raw['timeout'] !== undefined)
-        out.timeout = parsePositiveSeconds(raw['timeout'], 'check.timeout');
-    if (raw['timeouts'] !== undefined)
-        out.timeouts = parseTimeouts(raw['timeouts']);
-    if (raw['failOnSkipped'] !== undefined) {
-        if (typeof raw['failOnSkipped'] !== 'boolean') {
-            throw new ConfigError('Config field "check.failOnSkipped" must be a boolean');
-        }
-        out.failOnSkipped = raw['failOnSkipped'];
-    }
-    if (raw['lintReport'] !== undefined) {
-        const path = raw['lintReport'];
-        if (typeof path !== 'string' || path.trim() === '' || !isContainedRelativePath(path)) {
-            throw new ConfigError('Config field "check.lintReport" must be a project-relative path');
-        }
-        out.lintReport = path;
-    }
-    return out;
-}

package/dist/src/core/config-validate-file-size.d.ts

@@ -1,15 +0,0 @@
-/**
- * Validation for the size-rule keys of `patchLint`: `fileSizeThresholds`,
- * `fileSizeMetric`, `patchSizeThresholds`, `patchSizeMetric` and
- * `patchSizeRegistrationFiles`.
- *
- * Split out of `config-validate.ts`, which is at its per-file line budget.
- */
-import type { PatchLintConfig } from '../types/config.js';
-/**
- * Parses every size-rule key of the `patchLint` block.
- *
- * @param read - Reads one raw `patchLint` field by key
- * @returns The parsed fields, only those present
- */
-export declare function parsePatchLintSizeFields(read: (key: string) => unknown): Pick<PatchLintConfig, 'fileSizeThresholds' | 'fileSizeMetric' | 'patchSizeThresholds' | 'patchSizeMetric' | 'patchSizeRegistrationFiles'>;

package/dist/src/core/config-validate-file-size.js

@@ -1,154 +0,0 @@
-// SPDX-License-Identifier: EUPL-1.2
-/**
- * Validation for the size-rule keys of `patchLint`: `fileSizeThresholds`,
- * `fileSizeMetric`, `patchSizeThresholds`, `patchSizeMetric` and
- * `patchSizeRegistrationFiles`.
- *
- * Split out of `config-validate.ts`, which is at its per-file line budget.
- */
-import { ConfigError } from '../errors/config.js';
-import { isObject } from '../utils/validation.js';
-import { DEFAULT_FILE_SIZE_THRESHOLDS } from './patch-lint-file-size.js';
-import { resolvePatchSizeThresholds, } from './patch-lint-size-thresholds.js';
-/**
- * Parses one `patchLint.fileSizeThresholds.<tier>` triple. Every field is
- * optional and merges over the built-in default. Values must be positive
- * integers and stay ordered `notice <= warning <= error`, because an
- * out-of-order triple would silently disable a band instead of failing.
- */
-function parseFileSizeTier(raw, field) {
-    if (!isObject(raw)) {
-        throw new ConfigError(`Config field "${field}" must be a plain object`);
-    }
-    const out = {};
-    for (const key of ['notice', 'warning', 'error']) {
-        const value = raw[key];
-        if (value === undefined)
-            continue;
-        if (typeof value !== 'number' || !Number.isInteger(value) || value <= 0) {
-            throw new ConfigError(`Config field "${field}.${key}" must be a positive integer`);
-        }
-        out[key] = value;
-    }
-    for (const key of Object.keys(raw)) {
-        if (!['notice', 'warning', 'error'].includes(key)) {
-            throw new ConfigError(`Config field "${field}" has unknown key "${key}"`);
-        }
-    }
-    return out;
-}
-/**
- * Parses the `patchLint.fileSizeThresholds` block. Ordering is validated
- * against the merged triple (overrides on top of the defaults), so setting
- * only `warning` cannot land below the default `notice`.
- */
-function parsePatchLintFileSizeThresholds(raw) {
-    if (!isObject(raw)) {
-        throw new ConfigError('Config field "patchLint.fileSizeThresholds" must be a plain object');
-    }
-    const out = {};
-    for (const tier of ['general', 'test']) {
-        const value = raw[tier];
-        if (value === undefined)
-            continue;
-        const parsed = parseFileSizeTier(value, `patchLint.fileSizeThresholds.${tier}`);
-        const merged = { ...DEFAULT_FILE_SIZE_THRESHOLDS[tier], ...parsed };
-        if (merged.notice > merged.warning || merged.warning > merged.error) {
-            throw new ConfigError(`Config field "patchLint.fileSizeThresholds.${tier}" must satisfy notice <= warning <= error ` +
-                `(resolved: ${merged.notice}/${merged.warning}/${merged.error})`);
-        }
-        out[tier] = parsed;
-    }
-    for (const key of Object.keys(raw)) {
-        if (key !== 'general' && key !== 'test') {
-            throw new ConfigError(`Config field "patchLint.fileSizeThresholds" has unknown key "${key}"`);
-        }
-    }
-    return out;
-}
-/** Throws unless `merged` is ordered `notice <= warning <= error` (a `null` error is unbounded). */
-function assertOrderedTriple(merged, field) {
-    if (merged.notice > merged.warning || (merged.error !== null && merged.warning > merged.error)) {
-        throw new ConfigError(`Config field "${field}" must satisfy notice <= warning <= error ` +
-            `(resolved: ${merged.notice}/${merged.warning}/${merged.error ?? 'none'})`);
-    }
-}
-/**
- * Parses one `patchLint.patchSizeThresholds.<tier>` entry: optional
- * `lines` and `files` triples, each validated against its merged result.
- */
-function parsePatchSizeTier(raw, tier) {
-    const field = `patchLint.patchSizeThresholds.${tier}`;
-    if (!isObject(raw)) {
-        throw new ConfigError(`Config field "${field}" must be a plain object`);
-    }
-    const out = {};
-    for (const key of Object.keys(raw)) {
-        if (key !== 'lines' && key !== 'files') {
-            throw new ConfigError(`Config field "${field}" has unknown key "${key}"`);
-        }
-        out[key] = parseFileSizeTier(raw[key], `${field}.${key}`);
-    }
-    const merged = resolvePatchSizeThresholds(tier, { [tier]: out });
-    assertOrderedTriple(merged.lines, `${field}.lines`);
-    assertOrderedTriple(merged.files, `${field}.files`);
-    return out;
-}
-/** Parses the `patchLint.patchSizeThresholds` block. */
-function parsePatchLintPatchSizeThresholds(raw) {
-    if (!isObject(raw)) {
-        throw new ConfigError('Config field "patchLint.patchSizeThresholds" must be a plain object');
-    }
-    const out = {};
-    for (const key of Object.keys(raw)) {
-        if (key !== 'general' && key !== 'test' && key !== 'branding') {
-            throw new ConfigError(`Config field "patchLint.patchSizeThresholds" has unknown key "${key}"`);
-        }
-        out[key] = parsePatchSizeTier(raw[key], key);
-    }
-    return out;
-}
-/** Parses an enum-valued `patchLint` key, naming the allowed values on failure. */
-function parseEnum(raw, field, values) {
-    if (typeof raw !== 'string' || !values.includes(raw)) {
-        throw new ConfigError(`Config field "${field}" must be one of: ${values.join(', ')}`);
-    }
-    return raw;
-}
-/**
- * Parses every size-rule key of the `patchLint` block.
- *
- * @param read - Reads one raw `patchLint` field by key
- * @returns The parsed fields, only those present
- */
-export function parsePatchLintSizeFields(read) {
-    const out = {};
-    const fileSizeThresholds = read('fileSizeThresholds');
-    if (fileSizeThresholds !== undefined) {
-        out.fileSizeThresholds = parsePatchLintFileSizeThresholds(fileSizeThresholds);
-    }
-    const fileSizeMetric = read('fileSizeMetric');
-    if (fileSizeMetric !== undefined) {
-        out.fileSizeMetric = parseEnum(fileSizeMetric, 'patchLint.fileSizeMetric', ['raw', 'code']);
-    }
-    const patchSizeThresholds = read('patchSizeThresholds');
-    if (patchSizeThresholds !== undefined) {
-        out.patchSizeThresholds = parsePatchLintPatchSizeThresholds(patchSizeThresholds);
-    }
-    const patchSizeMetric = read('patchSizeMetric');
-    if (patchSizeMetric !== undefined) {
-        out.patchSizeMetric = parseEnum(patchSizeMetric, 'patchLint.patchSizeMetric', [
-            'diff',
-            'addedCode',
-        ]);
-    }
-    const registration = read('patchSizeRegistrationFiles');
-    if (registration !== undefined) {
-        if (!Array.isArray(registration) ||
-            registration.some((v) => typeof v !== 'string' || v.trim() === '')) {
-            throw new ConfigError('Config field "patchLint.patchSizeRegistrationFiles" must be an array of non-empty strings');
-        }
-        out.patchSizeRegistrationFiles = registration;
-    }
-    return out;
-}

package/dist/src/core/config-validate-history.d.ts

@@ -1,11 +0,0 @@
-import type { FireForgeConfig } from '../types/config.js';
-import type { ParsedRecord } from '../utils/parse.js';
-/**
- * Whether a `history.path` value is usable: a non-empty, project-relative
- * path that stays inside the project and names a file, not the root.
- * Shared with the history writer, which reads the raw config and must agree
- * with validation about what it may write to.
- */
-export declare function isValidHistoryPath(value: unknown): value is string;
-/** Parses the optional `history` block. */
-export declare function parseHistoryBlock(rec: ParsedRecord, config: FireForgeConfig): void;

package/dist/src/core/config-validate-history.js

@@ -1,38 +0,0 @@
-// SPDX-License-Identifier: EUPL-1.2
-import { ConfigError } from '../errors/config.js';
-import { isContainedRelativePath } from '../utils/paths.js';
-/**
- * Whether a `history.path` value is usable: a non-empty, project-relative
- * path that stays inside the project and names a file, not the root.
- * Shared with the history writer, which reads the raw config and must agree
- * with validation about what it may write to.
- */
-export function isValidHistoryPath(value) {
-    return (typeof value === 'string' &&
-        value.trim() !== '' &&
-        value.trim() !== '.' &&
-        !/[\n\r]/.test(value) &&
-        isContainedRelativePath(value));
-}
-/** Parses the optional `history` block. */
-export function parseHistoryBlock(rec, config) {
-    const raw = rec.raw('history');
-    if (raw === undefined)
-        return;
-    let historyRec;
-    try {
-        historyRec = rec.object('history');
-    }
-    catch {
-        throw new ConfigError('Config field "history" must be an object');
-    }
-    const out = {};
-    const path = historyRec.raw('path');
-    if (path !== undefined) {
-        if (!isValidHistoryPath(path)) {
-            throw new ConfigError('Config field "history.path" must be a project-relative file path inside the project');
-        }
-        out.path = path;
-    }
-    config.history = out;
-}

package/dist/src/core/config-validate-patch-policy.d.ts

@@ -1,7 +0,0 @@
-/**
- * Validation helpers for `fireforge.json#patchPolicy`.
- */
-import type { PatchPolicyConfig } from '../types/config.js';
-import { type ParsedRecord } from '../utils/parse.js';
-/** Parses and validates the optional patch policy config block. */
-export declare function parsePatchPolicyBlock(rec: ParsedRecord): PatchPolicyConfig;