Skip to content

Lint rules ​

netherite lint checks every item and reports problems with a rule name, a severity and a place in the file. --fail-on decides which severity makes it exit 1 (default error; the repository's own check uses warning). netherite lint --fix applies the fixes marked below, never commits, and --dry-run shows the diff first. Pass paths to check only some files.

RuleSeverityWhat it reportsFix
frontmattererrorno frontmatter, invalid YAML, or frontmatter that is not a mapping
schemaerrora field that breaks the type's schema: missing, wrong type, not an allowed value, or a state that is not in the config
duplicate-iderrortwo files use the same ID (usually after a merge); netherite renumber resolves it
missing-aliaserroraliases does not include the item's own ID, so [[ID]] would not resolve in Obsidianadd the alias
broken-linkerrora [[link]] or relation that matches no item
ambiguous-linkerror or warninga link that matches several items; an error if the ambiguity is an ID or alias, a warning if it is a title or file name
broken-headingwarning[[ID#Heading]] where the item has no such heading
file-name-idwarningthe file name does not start with the item's IDrename the file
outside-type-folderwarningan item sits outside its type's folder
stalewarninga doc's covered files changed in many commits since it was reviewed
driftingwarningthe same, but fewer commits (see freshness in the config)
due-before-createdwarninga due date earlier than the day the item was created
milestone-without-duewarninga project has a milestone but no due date, so it cannot sit on the Timeline
invalid-horizonwarninga goal's horizon is not forever or a length such as 10 years, 6 months, 90d
template-unknown-fieldwarninga template of your own under templates/ in the content folder names a frontmatter field its type does not have, so every item made from it would carry that field unchecked
source-missinginfoan imported item whose source is a path in the repository that is no longer there: the original may have been moved or deleted
orphaninfonothing links to this item (exempt: a context item given to agents, since context sync uses it; a doc or runbook that sets explains, project or covers)
unknown-fieldinfoa frontmatter field the schema does not know (it is kept as it is)

stale and drifting need git history and are skipped with --no-git or when the workspace is not in a repository. The --json output lists every problem with its rule, severity, path, line and column, for use in CI or an editor.

MIT licensed. Nothing is sent anywhere: it runs on your machine.