Hexcheck

Hexcheck

Configure .hexcheck.yaml by mapping repo paths to roles. Folder names do not matter; roles do.

Testing status: hexcheck is in a testing phase. If behavior, configuration, diagnostics, or documentation seem off, report it by creating an issue at https://github.com/bnema/hexcheck/issues. Include the repo layout, .hexcheck.yaml, command run, output, and what looked wrong.

Roles:

• core: domain/core business logic
• usecase: application use cases/orchestration
• ports: interfaces/contracts
• adapter: infra, persistence, external services, outbound adapters
• entrypoint: CLI/HTTP/UI/bootstrap
• ignore: generated code, mocks, vendor

Minimal shape:

version: 1
components:
  core: { role: core, paths: [internal/domain/**, internal/core/**] }
  usecases: { role: usecase, paths: [internal/application/usecase/**, internal/application/usecases/**, internal/usecases/**] }
  ports: { role: ports, paths: [internal/application/port/**, internal/domain/repository/**] }
  adapters: { role: adapter, paths: [internal/infrastructure/**, internal/adapters/**] }
  entrypoints: { role: entrypoint, paths: [cmd/**] }
  generated: { role: ignore, paths: ['**/mocks/**', '**/generated/**', '**/*_templ.go', '**/*_gen.go'] }

For repos using boundaries, map by role, e.g. boundaries/in -> entrypoint, boundaries/out -> adapter, boundaries/ports -> ports.

Recommended rules:

rules:
  no-adapter-imports-in-core: error
  no-infra-imports-in-usecase: error
  no-framework-types-in-core: error
  no-infra-types-in-ports: error
  no-adapter-to-adapter-imports: warn
  suspicious-business-logic-in-adapter: warn
  no-local-fakes-for-ports: warn
  missing-generated-mock-for-port: warn
  prefer-generated-mocks: warn

Mock config:

mocking:
  generatedMockPaths: [internal/mocks/**, internal/application/mocks/**, internal/application/port/mocks/**]
  generatedMockNamePatterns: ['Mock{{Interface}}', '{{Interface}}Mock']

Run:

hexcheck -hexcheck.config .hexcheck.yaml -hexcheck.root . ./...

Agent checklist: read repo architecture docs, map paths to roles, ignore generated/mocks, configure mock paths, run once, tune ruleSettings.*.excludePaths only after inspecting examples.