Custom node

warningcustom-node

A custom node is a hole in the model: the catalogue has no word for it, so no rule can check anything about it. It is meant to be temporary, and naming it in the catalogue closes the hole.

Severity: warning
Selects: every node of kind custom
Components in scope: 1

What it checks

It looks at every node of kind custom, and fires when:

— the node's `anyProperty` has no value

Message

Node '{{node.id}}' is custom: no rule can judge it. Replace it with a catalogue component or contribute one (docs/governance.md).

{{node.id}} style paths are filled in from the node, the edge or the design the finding is about.

Applies to · 1 components

Custom custom

Tripped by · 1

Reference designs whose broken twin names this rule in its header. The gate reads the same header, and fails when a rule no design trips.

custom-escape-hatchreference

Source

1# yaml-language-server: $schema=../schema/rule.schema.json
2# A custom node is a hole in the model: the catalogue does not name it, so nothing can be
3# checked about it. Fires on every custom node, unconditionally. Tripped by
4# designs/reference/custom-escape-hatch/design.broken.yaml.
5schemaVersion: "1"
6type: "rule"
7id: "custom-node"
8severity: "warning"
9select:
10  node:
11    kind: "custom"
12# `when` is required and the custom kind defines no properties, so nothing ever resolves on
13# one of these nodes: this predicate is how the fixed predicate set spells "always".
14when:
15  prop: "anyProperty"
16  exists: false
17message: "Node '{{node.id}}' is custom: no rule can judge it. Replace it with a catalogue component or contribute one (docs/governance.md)."

The same page as markdown, for an agent: /catalogue/rules/custom-node.md