@drkmttr/adhere 0.24.0 → 0.24.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@drkmttr/adhere",
-  "version": "0.24.0",
+  "version": "0.24.1",
   "private": false,
   "description": "Lints a repository against the rules in .adhere/, judged by Jev.",
   "license": "MIT",
@@ -93,10 +93,10 @@
     "--force"
   ],
   "optionalDependencies": {
-    "@drkmttr/adhere-darwin-arm64": "0.24.0",
-    "@drkmttr/adhere-darwin-x64": "0.24.0",
-    "@drkmttr/adhere-linux-arm64": "0.24.0",
-    "@drkmttr/adhere-linux-x64": "0.24.0",
-    "@drkmttr/adhere-win32-x64": "0.24.0"
+    "@drkmttr/adhere-darwin-arm64": "0.24.1",
+    "@drkmttr/adhere-darwin-x64": "0.24.1",
+    "@drkmttr/adhere-linux-arm64": "0.24.1",
+    "@drkmttr/adhere-linux-x64": "0.24.1",
+    "@drkmttr/adhere-win32-x64": "0.24.1"
   }
 }

package/skills/adhere/SKILL.md

@@ -411,10 +411,12 @@ Oxlint. `adhere validate` reports rules left over that a linter could check.
 An organization keeps its instructions, rules, and lint settings in one repo,
 scaffolded by `adhere init --shared org/repo`. Its `README.md` carries a
 managed guide between `<!-- adhere:rules:start -->` and
-`<!-- adhere:rules:end -->`: a contents list nesting every rule under its
-topic, the rules grouped by topic with each bold statement and rule id opening
-that rule's `RULE.md` verbatim: examples and explanation, then a source link
-under a stable permalink, every enabled native setting in `oxlint/rules.json`
+`<!-- adhere:rules:end -->`: a contents list linking the rules, lint settings,
+and custom plugin sections. Under a level-two Rules heading, rules sort by
+topic and id without visible topic headings. Each rule id opens an expandable
+entry containing its description, its `RULE.md` examples and explanation,
+and a source link under a stable permalink. The guide also lists every enabled
+native setting in `oxlint/rules.json`
 with its severity, and each custom plugin's enabled rules, linked to
 `oxlint/plugins/<name>.js` when that is a local file. A `RULE.ts` is linked as
 TypeScript source only: the guide never reads or runs it, and plugin code is

package/src/readme-guide.ts

@@ -356,15 +356,15 @@ const ruleEntry = (rule: ReadmeRule, anchor: string, used: Set<string>): Readonl
     `<a id="${anchor}"></a>`,
     "",
     "<details>",
-    rule.name === "RULE.ts"
-      ? `<summary><strong>TypeScript rule</strong> ${label}</summary>`
-      : `<summary><strong>${statement}</strong> ${label}</summary>`,
+    `<summary><h3>${label}</h3></summary>`,
     "",
     ...(rule.name === "RULE.ts"
       ? [
           `This rule is TypeScript, so the guide does not read or run it: [\`${rule.id}\`](${source}).`,
         ]
       : [
+          statement,
+          "",
           ...(body === "" ? [] : [embedBody(source, anchor, body, used), ""]),
           `Source: [\`${rule.id}\`](${source}).`,
         ]),
@@ -374,32 +374,25 @@ const ruleEntry = (rule: ReadmeRule, anchor: string, used: Set<string>): Readonl
 };
 
 /**
- * The managed block's body: a contents list naming every rule, each topic's
- * rules as expandable entries, then the lint settings and plugins. Rules sort
- * by id and topics by name, so the same checkout always writes the same text.
+ * The managed block's body: section links, rules as expandable entries, then
+ * the lint settings and plugins. Rules sort by id and topics by name, so the
+ * same checkout always writes the same text.
  */
 export const renderReadmeIndex = (rules: ReadonlyArray<ReadmeRule>, config: LintConfig): string => {
   const entries = lintEntries(config);
   const { topics, used } = topicsOf(rules);
   const contents = [
     `- [Rules](#${RULES_ANCHOR})`,
-    ...topics.flatMap(({ name, anchor, rules: group }) => [
-      `  - [\`${name}\`](#${anchor})`,
-      ...group.map(({ rule, anchor: at }) => `    - [\`${rule.id}\`](#${at})`),
-    ]),
     `- [Lint settings](#${LINT_SETTINGS_ANCHOR})`,
     `- [Custom lint plugins](#${PLUGINS_ANCHOR})`,
   ];
   const body =
     topics.length === 0
       ? ["- None.", ""]
-      : topics.flatMap(({ name, anchor, rules: group }) => [
+      : topics.flatMap(({ anchor, rules: group }) => [
           `<a id="${anchor}"></a>`,
           "",
-          `#### ${name}`,
-          "",
           ...group.flatMap(({ rule, anchor: at }) => [...ruleEntry(rule, at, used), ""]),
-          backToContents,
           "",
         ]);
   return [
@@ -411,7 +404,7 @@ export const renderReadmeIndex = (rules: ReadonlyArray<ReadmeRule>, config: Lint
     "",
     `<a id="${RULES_ANCHOR}"></a>`,
     "",
-    "### Rules",
+    "## Rules",
     "",
     ...body,
     `<a id="${LINT_SETTINGS_ANCHOR}"></a>`,