fix(docs): show inline read_when hints in docs:list (#95243) · openclaw/openclaw@3cc05d5

Recent Commits to openclaw:main

hugenshen · 2026-06-22 · via Recent Commits to openclaw:main

Original file line number	Diff line number	Diff line change
`@@ -116,6 +116,11 @@ function extractMetadata(fullPath) {`
`116`	`116`	`} catch {`
`117`	`117`	`// ignore malformed inline arrays`
`118`	`118`	`}`
	`119`	`+} else if (`
	`120`	`+(inline.startsWith('"') && inline.endsWith('"')) \|\|`
	`121`	`+(inline.startsWith("'") && inline.endsWith("'"))`
	`122`	`+) {`
	`123`	`+readWhen.push(...compactStrings([inline.slice(1, -1)]));`
`119`	`124`	`}`
`120`	`125`	`continue;`
`121`	`126`	`}`

Original file line number	Diff line number	Diff line change
`@@ -1026,6 +1026,7 @@ const TOOLING_SOURCE_TEST_TARGETS = new Map([`
`1026`	`1026`	`"scripts/deadcode-unused-files.allowlist.mjs",`
`1027`	`1027`	`["test/scripts/check-deadcode-unused-files.test.ts"],`
`1028`	`1028`	`],`
	`1029`	`+["scripts/docs-list.js", ["test/scripts/docs-list.test.ts"]],`
`1029`	`1030`	`["scripts/docs-link-audit.mjs", ["src/scripts/docs-link-audit.test.ts"]],`
`1030`	`1031`	`["scripts/lib/arg-utils.mjs", ["test/scripts/arg-utils.test.ts"]],`
`1031`	`1032`	`[`

Original file line number	Diff line number	Diff line change
`@@ -887,6 +887,7 @@ describe("test-projects args", () => {`
`887`	`887`	`"test/scripts/codex-install-assertions.test.ts",`
`888`	`888`	`"test/scripts/config-reload-mutate-metadata.test.ts",`
`889`	`889`	`"test/scripts/control-ui-i18n.test.ts",`
	`890`	`+"test/scripts/docs-list.test.ts",`
`890`	`891`	`"test/scripts/doctor-install-switch-wrapper.test.ts",`
`891`	`892`	`"test/scripts/e2e-text-file-utils.test.ts",`
`892`	`893`	`"test/scripts/fixture-common.test.ts",`

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,46 @@`
	`1`	`+// docs-list tests cover source docs metadata discovery for docs-aware tooling.`
	`2`	`+import { execFileSync } from "node:child_process";`
	`3`	`+import { mkdirSync, writeFileSync } from "node:fs";`
	`4`	`+import path from "node:path";`
	`5`	`+import { afterEach, describe, expect, it } from "vitest";`
	`6`	`+import { cleanupTempDirs, makeTempDir } from "../helpers/temp-dir.js";`
	`7`	`+`
	`8`	`+const tempDirs: string[] = [];`
	`9`	`+const repoRoot = path.resolve(import.meta.dirname, "../..");`
	`10`	`+const docsListScriptPath = path.join(repoRoot, "scripts", "docs-list.js");`
	`11`	`+`
	`12`	`+function makeTempRepoRoot(prefix: string): string {`
	`13`	`+return makeTempDir(tempDirs, prefix);`
	`14`	`+}`
	`15`	`+`
	`16`	`+function runDocsList(cwd: string): string {`
	`17`	`+return execFileSync(process.execPath, [docsListScriptPath], {`
	`18`	`+ cwd,`
	`19`	`+encoding: "utf8",`
	`20`	`+});`
	`21`	`+}`
	`22`	`+`
	`23`	`+afterEach(() => {`
	`24`	`+cleanupTempDirs(tempDirs);`
	`25`	`+});`
	`26`	`+`
	`27`	`+describe("docs-list", () => {`
	`28`	`+it("prints single-line read_when strings as read hints", () => {`
	`29`	`+const tempRepoRoot = makeTempRepoRoot("openclaw-docs-list-");`
	`30`	`+mkdirSync(path.join(tempRepoRoot, "docs"), { recursive: true });`
	`31`	`+writeFileSync(`
	`32`	`+path.join(tempRepoRoot, "docs", "page.md"),`
	`33`	+`---
	`34`	`+summary: "Single-line read_when page"`
	`35`	`+read_when: "Read this page when the hint is inline."`
	`36`	`+---`
	`37`	+`,
	`38`	`+"utf8",`
	`39`	`+);`
	`40`	`+`
	`41`	`+const output = runDocsList(tempRepoRoot);`
	`42`	`+`
	`43`	`+expect(output).toContain("page.md - Single-line read_when page");`
	`44`	`+expect(output).toContain("Read when: Read this page when the hint is inline.");`
	`45`	`+});`
	`46`	`+});`

Original file line number	Diff line number	Diff line change
`@@ -1389,6 +1389,11 @@ describe("scripts/test-projects changed-target routing", () => {`
`1389`	`1389`	`targets: ["test/scripts/update-clawtributors.test.ts"],`
`1390`	`1390`	`});`
`1391`	`1391`
	`1392`	`+expect(resolveChangedTestTargetPlan(["scripts/docs-list.js"])).toEqual({`
	`1393`	`+mode: "targets",`
	`1394`	`+targets: ["test/scripts/docs-list.test.ts"],`
	`1395`	`+});`
	`1396`	`+`
`1392`	`1397`	`expect(resolveChangedTestTargetPlan(["scripts/docs-link-audit.mjs"])).toEqual({`
`1393`	`1398`	`mode: "targets",`
`1394`	`1399`	`targets: ["src/scripts/docs-link-audit.test.ts"],`

此内容由惯性聚合(RSS阅读器)自动聚合整理，仅供阅读参考。原文来自 — 版权归原作者所有。

推荐订阅源

Recent Commits to openclaw:main