Fix relative links to README file

Resolves #3006

Author: Gerrit0

CHANGELOG.md

@@ -9,6 +9,9 @@ title: Changelog
 - Variables marked with `@enum` now work for symbols imported from another module, #3003.
 - Improved magic introduced with #2999 to work with imported symbols, #3003.
 - Fixed relative link resolution to file names containing percent encoded URLs, #3006.
+- Linking to the project's README file with a relative link will now behave as expected, #3006.
+- Reduced unnecessary HTML element rendering in default theme.
+  API: `Reflection.hasComment` and `Comment.hasVisibleComponent` now accepts an optional `notRenderedTags` parameter.
 
 ## v0.28.11 (2025-08-25)
 

eslint.config.mjs

@@ -53,6 +53,13 @@ const config = {
         // This is sometimes useful for clarity
         "@typescript-eslint/no-unnecessary-type-arguments": "off",
 
+        // It'd be kind of nice to be able to turn this on, but it doesn't seem to be worth the additional
+        // pain at this point. Turning it on adds ~300 lint errors, of which manual review found 1 bug, and
+        // whose suggestions would have introduced 3 bugs that I noticed, and potentially more... and it
+        // also didn't catch the bug which I originally turned it on for! Ideally, I'd like a version of
+        // this which ONLY checks for boolean comparisons of type number.
+        "@typescript-eslint/strict-boolean-expressions": "off",
+
         // We still use `any` fairly frequently...
         "@typescript-eslint/ban-types": "off",
         "@typescript-eslint/no-explicit-any": "off",

package.json

@@ -50,13 +50,13 @@
         "c8": "^10.1.3",
         "dprint": "^0.50.1",
         "esbuild": "^0.25.8",
-        "eslint": "^9.32.0",
+        "eslint": "^9.34.0",
         "mocha": "^11.7.1",
         "puppeteer": "^24.11.1",
         "semver": "^7.7.2",
         "tsx": "^4.20.3",
         "typescript": "5.9.2",
-        "typescript-eslint": "^8.38.0"
+        "typescript-eslint": "^8.41.0"
     },
     "files": [
         "/bin",

pnpm-lock.yaml

@@ -141,6 +141,7 @@ export {
     type NormalizedPathOrModule,
     type NormalizedPathOrModuleOrFunction,
     type SymbolReference,
+    type TagString,
     type TranslatedString,
     translateTagName,
 } from "#utils";

src/index.ts

@@ -2,7 +2,7 @@ import assert, { ok } from "assert";
 import { parseDocument as parseYamlDoc } from "yaml";
 import type { CommentContextOptionalChecker, CommentParserConfig } from "./index.js";
 import { Comment, type CommentDisplayPart, CommentTag, type InlineTagDisplayPart } from "../../models/index.js";
-import type { MinimalSourceFile } from "#utils";
+import type { MinimalSourceFile, TagString } from "#utils";
 import { nicePath } from "../../utils/paths.js";
 import { type Token, TokenSyntaxKind } from "./lexer.js";
 import { extractTagName } from "./tagName.js";
@@ -235,7 +235,7 @@ export function parseCommentString(
     return { content, frontmatter: frontmatterData };
 }
 
-const HAS_USER_IDENTIFIER: `@${string}`[] = [
+const HAS_USER_IDENTIFIER: TagString[] = [
     "@callback",
     "@param",
     "@prop",
@@ -389,7 +389,7 @@ function blockTag(
         content = blockContent(comment, lexer, config, i18n, warning, files);
     }
 
-    return new CommentTag(tagName as `@${string}`, content);
+    return new CommentTag(tagName as TagString, content);
 }
 
 /**
@@ -613,11 +613,11 @@ function blockContent(
                     next.text = "@inheritDoc";
                 }
                 if (config.modifierTags.has(next.text)) {
-                    comment.modifierTags.add(next.text as `@${string}`);
+                    comment.modifierTags.add(next.text as TagString);
                     break;
                 } else if (!atNewLine && !config.blockTags.has(next.text)) {
                     // Treat unknown tag as a modifier, but warn about it.
-                    comment.modifierTags.add(next.text as `@${string}`);
+                    comment.modifierTags.add(next.text as TagString);
                     warning(
                         i18n.treating_unrecognized_tag_0_as_modifier(next.text),
                         next,
@@ -751,7 +751,7 @@ function inlineTag(
 
     const inlineTag: InlineTagDisplayPart = {
         kind: "inline-tag",
-        tag: tagName.text as `@${string}`,
+        tag: tagName.text as TagString,
         text: content.join(""),
     };
     if (tagName.tsLinkTarget) {

src/lib/converter/comments/parser.ts

@@ -22,6 +22,7 @@ import {
     removeIf,
     removeIfPresent,
     setIntersection,
+    type TagString,
     unique,
 } from "#utils";
 import { ConverterComponent } from "../components.js";
@@ -56,7 +57,7 @@ const NEVER_RENDERED = [
 // We might make this user configurable at some point, but for now,
 // this set is configured here.
 const MUTUALLY_EXCLUSIVE_MODIFIERS = [
-    new Set<`@${string}`>([
+    new Set<TagString>([
         "@alpha",
         "@beta",
         "@experimental",
@@ -122,10 +123,10 @@ const MUTUALLY_EXCLUSIVE_MODIFIERS = [
  */
 export class CommentPlugin extends ConverterComponent {
     @Option("excludeTags")
-    accessor excludeTags!: `@${string}`[];
+    accessor excludeTags!: TagString[];
 
     @Option("cascadedModifierTags")
-    accessor cascadedModifierTags!: `@${string}`[];
+    accessor cascadedModifierTags!: TagString[];
 
     @Option("excludeInternal")
     accessor excludeInternal!: boolean;