docs-site/outdated-references
Finds references to the retired obsidian-dev-utils package that point a reader at something that no longer exists: one of its module paths, a link into its repository, or the legacy console recipe for the shared abort controller.
The bare name obsidian-dev-utils is NOT flagged: @mnaoumov/obsidian-lib keeps it on purpose as a wire name (its debug namespace, CSS class and event prefix), and a migration note may name the package. What is flagged is the name used as an ADDRESS.
Scanned, where present: README.md, the guides under docs/src/content/docs (not the generated API reference, which is rendered from the TSDoc this also scans), and every non-test .ts file under src/ and scripts/. CHANGELOG.md is history and is not scanned. A line that names an old address on purpose, such as a migration note, carries outdated-reference-ok on that line.
Interfaces
Section titled “Interfaces”| Interface | Description |
|---|---|
| OutdatedReference | An outdated reference found in a file. |
Functions
Section titled “Functions”| Function | Description |
|---|---|
| assertNoOutdatedReferences | Finds the outdated references in the package and throws when there is one, for a gate test or script. |
| findOutdatedReferences | Finds the outdated references in the package. |
| findOutdatedReferencesInText | Finds the outdated references in one file’s text. |
| formatOutdatedReferences | Formats references one per line, as path:line - text (hint). |
Variables
Section titled “Variables”| Variable | Description |
|---|---|
| OUTDATED_REFERENCE_ALLOW_MARKER | The marker that allows an outdated reference on its line. |