Module
PuduLangDocgen.Constants.Codes
Stable diagnostic codes reported by every phase
Constants
| Name | Description |
|---|---|
UNCLOSED_BLOCK |
A code fence or math block runs to the end of its container. |
INCLUDE_MISSING |
An included file is not part of the loaded files. |
INCLUDE_CYCLE |
Files include one another in a cycle. |
NESTING_TOO_DEEP |
Content nests past the parser's depth bound and is kept as text. |
EXCERPT_MISSING |
A code excerpt names a file that is not loaded. |
EXCERPT_INVALID |
A code excerpt's region, range, or options cannot be applied. |
UNKNOWN_ALERT |
A quote names an alert kind that is not configured. |
DIRECTIVE_INVALID |
A container directive is unsupported or lacks a required attribute. |
FRONT_MATTER_INVALID |
A YAML header is unclosed or not a mapping. |
DIRECTIVE_UNCLOSED |
A container directive has no matching end line. |
PATH_INVALID |
An include or excerpt path is absolute, encoded, or not portable. |
UNSAFE_DESTINATION |
A link destination uses a scheme or form that is never linked. |
DESTINATION_ESCAPES |
A local destination leaves the project root. |
LINK_BROKEN |
A local link names a file that is not published. |
XREF_UNRESOLVED |
A cross reference names an identity no page or map declares. |
FRAGMENT_MISSING |
A link names a section its target page does not have. |
IMAGE_MISSING |
An image names a file that is not published. |
VIDEO_INSECURE |
An embedded video does not use HTTPS. |
TOC_SYNTAX |
A table of contents is not valid YAML or JSON. |
TOC_SHAPE |
A table of contents or one of its items has the wrong shape. |
TOC_HEADING_EMPTY |
A Markdown table of contents heading has no title. |
TOC_UNSAFE |
A table of contents destination is unsafe. |
TOC_TOO_DEEP |
A table of contents nests past its depth bound. |
TOC_UNKNOWN_FIELD |
A table of contents item declares an unknown field. |
TOC_NAMELESS |
A table of contents item has neither a name nor a uid. |
TOC_UID_UNKNOWN |
A table of contents item names an unknown uid. |
TOC_TARGET_MISSING |
A table of contents destination is not published. |
TOC_CYCLE |
Tables of contents include one another in a cycle or too deeply. |
UID_DUPLICATE |
Two pages declare the same uid. |
TEMPLATE_INVALID |
A layout or partial template does not parse. |
CONFIG_INVALID |
A configuration value is missing, unknown, or of the wrong type. |
CONFIG_UNREADABLE |
A configuration file cannot be read or decoded. |
CONTENT_UNREADABLE |
A content file listed by the configuration cannot be read. |
CONTENT_INVALID |
A structured content file does not decode or describes an invalid interface. |
CONTENT_UNSUPPORTED |
A content file has a type the build does not publish. |
OVERWRITE_INVALID |
An overwrite section header is malformed or names no uid. |
OUTPUT_INVALID |
An output path is not portable. |
OUTPUT_COLLISION |
Two outputs share a path, or a file takes a folder's path. |
NOTHING_TO_BUILD |
A configuration selects no content and no API sources. |
FILE_UNREADABLE |
A project file or folder cannot be read safely. |
PUBLISH_FAILED |
Output could not be written, or a publication path is unsafe. |
XREF_UNAVAILABLE |
A cross-reference map could not be fetched or read. |
TOOL_FAILED |
An external tool the command needs is missing or failed. |
UNCLOSED_BLOCK
const UNCLOSED_BLOCK: Str = "DG101"A code fence or math block runs to the end of its container.
Type
Str
INCLUDE_MISSING
const INCLUDE_MISSING: Str = "DG102"An included file is not part of the loaded files.
Type
Str
INCLUDE_CYCLE
const INCLUDE_CYCLE: Str = "DG103"Files include one another in a cycle.
Type
Str
NESTING_TOO_DEEP
const NESTING_TOO_DEEP: Str = "DG104"Content nests past the parser's depth bound and is kept as text.
Type
Str
EXCERPT_MISSING
const EXCERPT_MISSING: Str = "DG105"A code excerpt names a file that is not loaded.
Type
Str
EXCERPT_INVALID
const EXCERPT_INVALID: Str = "DG106"A code excerpt's region, range, or options cannot be applied.
Type
Str
UNKNOWN_ALERT
const UNKNOWN_ALERT: Str = "DG107"A quote names an alert kind that is not configured.
Type
Str
DIRECTIVE_INVALID
const DIRECTIVE_INVALID: Str = "DG108"A container directive is unsupported or lacks a required attribute.
Type
Str
FRONT_MATTER_INVALID
const FRONT_MATTER_INVALID: Str = "DG109"A YAML header is unclosed or not a mapping.
Type
Str
DIRECTIVE_UNCLOSED
const DIRECTIVE_UNCLOSED: Str = "DG110"A container directive has no matching end line.
Type
Str
PATH_INVALID
const PATH_INVALID: Str = "DG111"An include or excerpt path is absolute, encoded, or not portable.
Type
Str
UNSAFE_DESTINATION
const UNSAFE_DESTINATION: Str = "DG121"A link destination uses a scheme or form that is never linked.
Type
Str
DESTINATION_ESCAPES
const DESTINATION_ESCAPES: Str = "DG122"A local destination leaves the project root.
Type
Str
LINK_BROKEN
const LINK_BROKEN: Str = "DG123"A local link names a file that is not published.
Type
Str
XREF_UNRESOLVED
const XREF_UNRESOLVED: Str = "DG124"A cross reference names an identity no page or map declares.
Type
Str
FRAGMENT_MISSING
const FRAGMENT_MISSING: Str = "DG127"A link names a section its target page does not have.
Type
Str
IMAGE_MISSING
const IMAGE_MISSING: Str = "DG125"An image names a file that is not published.
Type
Str
VIDEO_INSECURE
const VIDEO_INSECURE: Str = "DG126"An embedded video does not use HTTPS.
Type
Str
TOC_SYNTAX
const TOC_SYNTAX: Str = "DG201"A table of contents is not valid YAML or JSON.
Type
Str
TOC_SHAPE
const TOC_SHAPE: Str = "DG202"A table of contents or one of its items has the wrong shape.
Type
Str
TOC_HEADING_EMPTY
const TOC_HEADING_EMPTY: Str = "DG203"A Markdown table of contents heading has no title.
Type
Str
TOC_UNSAFE
const TOC_UNSAFE: Str = "DG204"A table of contents destination is unsafe.
Type
Str
TOC_TOO_DEEP
const TOC_TOO_DEEP: Str = "DG205"A table of contents nests past its depth bound.
Type
Str
TOC_UNKNOWN_FIELD
const TOC_UNKNOWN_FIELD: Str = "DG206"A table of contents item declares an unknown field.
Type
Str
TOC_NAMELESS
const TOC_NAMELESS: Str = "DG207"A table of contents item has neither a name nor a uid.
Type
Str
TOC_UID_UNKNOWN
const TOC_UID_UNKNOWN: Str = "DG210"A table of contents item names an unknown uid.
Type
Str
TOC_TARGET_MISSING
const TOC_TARGET_MISSING: Str = "DG211"A table of contents destination is not published.
Type
Str
TOC_CYCLE
const TOC_CYCLE: Str = "DG212"Tables of contents include one another in a cycle or too deeply.
Type
Str
UID_DUPLICATE
const UID_DUPLICATE: Str = "DG301"Two pages declare the same uid.
Type
Str
TEMPLATE_INVALID
const TEMPLATE_INVALID: Str = "DG401"A layout or partial template does not parse.
Type
Str
CONFIG_INVALID
const CONFIG_INVALID: Str = "DG501"A configuration value is missing, unknown, or of the wrong type.
Type
Str
CONFIG_UNREADABLE
const CONFIG_UNREADABLE: Str = "DG502"A configuration file cannot be read or decoded.
Type
Str
CONTENT_UNREADABLE
const CONTENT_UNREADABLE: Str = "DG601"A content file listed by the configuration cannot be read.
Type
Str
CONTENT_INVALID
const CONTENT_INVALID: Str = "DG602"A structured content file does not decode or describes an invalid interface.
Type
Str
CONTENT_UNSUPPORTED
const CONTENT_UNSUPPORTED: Str = "DG603"A content file has a type the build does not publish.
Type
Str
OVERWRITE_INVALID
const OVERWRITE_INVALID: Str = "DG701"An overwrite section header is malformed or names no uid.
Type
Str
OUTPUT_INVALID
const OUTPUT_INVALID: Str = "DG801"An output path is not portable.
Type
Str
OUTPUT_COLLISION
const OUTPUT_COLLISION: Str = "DG802"Two outputs share a path, or a file takes a folder's path.
Type
Str
NOTHING_TO_BUILD
const NOTHING_TO_BUILD: Str = "DG901"A configuration selects no content and no API sources.
Type
Str
FILE_UNREADABLE
const FILE_UNREADABLE: Str = "DG902"A project file or folder cannot be read safely.
Type
Str
PUBLISH_FAILED
const PUBLISH_FAILED: Str = "DG903"Output could not be written, or a publication path is unsafe.
Type
Str
XREF_UNAVAILABLE
const XREF_UNAVAILABLE: Str = "DG904"A cross-reference map could not be fetched or read.
Type
Str
TOOL_FAILED
const TOOL_FAILED: Str = "DG905"An external tool the command needs is missing or failed.
Type
Str