Hermex Output Review

← all cases

comply-all-rule-types

unchanged

Asserts — Every one of the nine rule types in one table, at three severities — the only case that renders engine_version, codeowners and both package-field shapes.

Ran hermex comply in fixtures/repos/all-rule-types → exit 1, as asserted

Config fixtures/repos/all-rule-types/hermex.config.ts · Fixture fixtures/repos/all-rule-types (overview) · Case comply-all-rule-types (dossier)

_{Reproduce locally: pnpm run test:output -- --filter comply-all-rule-types}

Config

fixtures/repos/all-rule-types/hermex.config.ts

import type { HermexConfigInput } from '../../../src/config/types.ts';

/**
 * Every rule type hermex has, all firing at once, at three different
 * severities. The primary fixture repo only ever trips three of the nine —
 * so without this repo the rules table has never been reviewed with an
 * `engine_version` row, a `codeowners` row, or either of the
 * package-field shapes in it, and nothing would catch a renderer that
 * mishandles `fieldPath` / `installedRange` / a long `matchedFiles` list.
 *
 * Scoped to `src/` so `jest.config.js` is found by `detect_files` without
 * also being parsed as source.
 */
export default {
  includes: ['src/**/*.{tsx,jsx,ts,js}'],
  rules: {
    detect_files: [
      {
        severity: 'error',
        patterns: ['jest.config.*', '.babelrc'],
        message: 'Use vitest + Vite',
      },
    ],
    require_files: [{ severity: 'error', patterns: ['.nvmrc'] }],
    forbid_packages: [
      { severity: 'error', patterns: ['moment'], message: 'Use date-fns or dayjs' },
    ],
    require_packages: [
      { severity: 'error', patterns: ['typescript'], message: 'TypeScript is required' },
    ],
    require_scripts: [
      { severity: 'error', patterns: ['build', 'test'], message: 'Required npm scripts' },
    ],
    // Missing outright, so the violation reports the absence.
    require_package_fields: [{ severity: 'warn', patterns: ['license'] }],
    // Present, so the violation reports the offending value — the other
    // half of the package-field renderer.
    forbid_package_fields: [
      {
        severity: 'warn',
        patterns: ['publishConfig.registry'],
        message: 'Publish to the public registry',
      },
    ],
    // engines.node is ">=16", so this reports both ranges rather than the
    // "not specified" shape.
    engine_version: { severity: 'error', range: '>=20', message: 'Minimum Node 20 required' },
    // CODEOWNERS covers two of the three scanned files, and one of those
    // belongs to a team outside `requiredOwners` — so this produces both
    // codeowners violations, unowned and wrong-owner.
    //
    // The baseline currently describes both as "have no owner", which is
    // wrong for src/legacy.tsx: it has an owner, just not a required one.
    // That is #95, left unfixed on purpose — the recorded output is the
    // evidence, and refreshing this baseline is how the fix gets reviewed.
    codeowners: {
      severity: 'info',
      requiredOwners: ['@org/platform'],
      message: 'Every file needs a platform owner',
    },
  },
  output: {
    packages: false,
    components: false,
    patterns: false,
    versus: false,
  },
} satisfies HermexConfigInput;

Full output

stdout.txt

hermex v<version>
- Parsing lockfile...
✔ Found pnpm lockfile (supports: v5, v6, v9) - 2 packages
✔ Found 3 files
✔ Analysis complete! Analyzed 3/3 files

🔍 Rules

┌──────────────────┬───────────────────────────────────────────────────────────────────────────────────────────────┐
│ Rule             │ Description                                                                                   │
├──────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ forbid_packages  │ 🔴 moment is forbidden — Use date-fns or dayjs                                                │
├──────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ require_packages │ 🔴 typescript not installed — TypeScript is required                                          │
├──────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ detect_files     │ 🔴 jest.config.*, .babelrc detected (jest.config.js, .babelrc) — Use vitest + Vite            │
├──────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ require_files    │ 🔴 .nvmrc not found                                                                           │
├──────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ require_scripts  │ 🔴 script build, test missing in package.json — Required npm scripts                          │
├──────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ package_fields   │ 🟡 field license missing in package.json                                                      │
├──────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ package_fields   │ 🟡 field publishConfig.registry is forbidden in package.json — Publish to the public registry │
├──────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ engine_version   │ 🔴 engines.node is >=16, required >=20 — Minimum Node 20 required                             │
├──────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ codeowners       │ 🔵 1 scanned file(s) have no owner: src/orphan.tsx — Every file needs a platform owner        │
├──────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────┤
│ codeowners       │ 🔵 1 scanned file(s) have no owner: src/legacy.tsx — Every file needs a platform owner        │
└──────────────────┴───────────────────────────────────────────────────────────────────────────────────────────────┘

6 errors, 2 warnings

🔴 NOT COMPLIANT
  6 mandatory violations found

stderr.txt

This site is open source. Improve this page.