Skip to content
Archangel

must-contain

Markdown for agents

Rule violations. This text is what archangel docs must-contain prints.

An instance of a part, or a folder, in a mustContain rule has no file that matches the rule’s pattern.

Example

Section titled “Example”
// rule({ files: 'slice', mustContain: 'index.ts' }), with slice: 'src/features/{slice}/**'
// src/features/billing, which has no index.ts

A list of patterns is met by any one of them, so ['model.*', 'model/**'] takes a file or a folder. In folders, a pattern that starts with ! leaves the folders it matches out, as in .gitignore:

rule({ folders: ['src/shared/*', '!src/shared/{ui,lib}'], mustContain: 'index.*' })

What to do

Section titled “What to do”

Add the file the message names. The pattern is relative to the instance’s root, or to each folder for a rule about folders, and any file counts, whether or not archangel reads it, so README.md is found.