Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 | 1x 1x 1x 1x 25x 25x 12x 20x 20x 20x 17x 17x 12x 13x 13x 9x 36x 33x 33x 13x 18x 18x 18x 18x 27x 27x 18x 32x 32x 32x 32x 29x 29x 29x 29x 29x 2x 27x 30x 18x 18x 18x 16x 16x 17x 17x 17x 4x 13x 13x 2x 11x 11x 11x 11x 11x 10x 8x 8x 2x 6x 6x 6x 5x 5x 1x 11x 11x 3x 7x 13x 1x 12x 12x 11x 11x 1x 1x 10x 10x 1x 1x 1x 10x 10x 1x 1x 9x 9x 9x 9x 9x 9x 9x 9x 9x 9x 9x 9x 9x 9x 9x 4x 5x 5x 2x 3x 3x 3x 3x 3x 3x 3x 2x 2x 2x 9x 9x 6x 9x 9x 9x 6x 6x 6x 6x 4x 4x 3x 3x 3x 9x 1x 1x 1x 1x 1x 1x 1x 1x |
/**
* Scans docs/tools/*.md for markers:
* <!-- @autogen:tool TOOL_NAME -->...<!-- @autogen:end -->
*
* Replaces content between markers with freshly generated
* action tables from the tool registry schemas.
*
* Run: yarn inject-tool-refs
* Used in: docs.yml workflow before yarn docs:build
*/
import * as fs from "fs";
import * as path from "path";
import { RegistryManager } from "../registry-manager.js";
interface JsonSchemaProperty {
type?: string;
properties?: Record<string, JsonSchemaProperty>;
oneOf?: JsonSchemaProperty[];
enum?: unknown[];
const?: unknown;
description?: string;
[key: string]: unknown;
}
interface ActionInfo {
name: string;
description: string;
}
interface MarkerMatch {
toolName: string;
startIdx: number;
endIdx: number;
}
// Fallback action descriptions when schema doesn't provide one
const ACTION_DESCRIPTIONS: Record<string, string> = {
list: "List items with filtering and pagination",
get: "Get a single item by ID",
create: "Create a new item",
update: "Update an existing item",
delete: "Delete an item",
search: "Search for items",
diffs: "Get file changes/diffs",
compare: "Compare two branches or commits",
merge: "Merge a merge request",
approve: "Approve a merge request",
unapprove: "Remove approval from a merge request",
cancel: "Cancel a running operation",
retry: "Retry a failed operation",
play: "Run a manual job",
publish: "Publish draft notes",
resolve: "Resolve a discussion thread",
disable: "Disable the integration",
test: "Test a webhook",
};
/**
* Extract actions from a tool's inputSchema (JSON Schema format).
* Handles discriminated unions (oneOf with const) and flat enums.
*/
function extractActions(schema: JsonSchemaProperty): ActionInfo[] {
const actions: ActionInfo[] = [];
// Discriminated union: oneOf with action.const
if (schema.oneOf && Array.isArray(schema.oneOf)) {
for (const branch of schema.oneOf) {
const actionProp = branch.properties?.action;
const actionName = actionProp?.const as string | undefined;
if (actionName) {
const description =
(actionProp?.description as string) ??
ACTION_DESCRIPTIONS[actionName] ??
`Perform ${actionName} operation`;
actions.push({ name: actionName, description });
}
}
return actions;
}
// Flat schema: action.enum
const actionProp = schema.properties?.action;
if (actionProp?.enum && Array.isArray(actionProp.enum)) {
for (const actionName of actionProp.enum) {
if (typeof actionName === "string") {
const description = ACTION_DESCRIPTIONS[actionName] ?? `Perform ${actionName} operation`;
actions.push({ name: actionName, description });
}
}
}
return actions;
}
/**
* Generate markdown action table for a tool.
*/
function generateActionsTable(actions: ActionInfo[]): string {
const lines: string[] = [];
lines.push("| Action | Description |");
lines.push("|--------|-------------|");
for (const action of actions) {
const desc = action.description.replace(/\\/g, "\\\\").replace(/\|/g, "\\|");
lines.push(`| \`${action.name}\` | ${desc} |`);
}
return lines.join("\n");
}
/**
* Find all @autogen:tool markers in file content.
*/
function findMarkers(content: string): MarkerMatch[] {
const markers: MarkerMatch[] = [];
const startPattern = /<!-- @autogen:tool (\S+) -->/g;
const endPattern = "<!-- @autogen:end -->";
let match: RegExpExecArray | null;
while ((match = startPattern.exec(content)) !== null) {
const toolName = match[1];
const startIdx = match.index;
const afterStart = startIdx + match[0].length;
const endIdx = content.indexOf(endPattern, afterStart);
if (endIdx === -1) {
throw new Error(`Missing <!-- @autogen:end --> for tool "${toolName}"`);
}
markers.push({
toolName,
startIdx,
endIdx: endIdx + endPattern.length,
});
}
return markers;
}
/**
* Process a single markdown file: find markers and inject action tables.
* Returns true if file was modified.
*/
function processFile(
filePath: string,
toolSchemas: Map<string, JsonSchemaProperty>,
content?: string
): boolean {
const fileContent = content ?? fs.readFileSync(filePath, "utf8");
const markers = findMarkers(fileContent);
if (markers.length === 0) return false;
// Process markers from end to start to preserve indices
let result = fileContent;
for (let i = markers.length - 1; i >= 0; i--) {
const marker = markers[i];
const schema = toolSchemas.get(marker.toolName);
if (!schema) {
throw new Error(
`Unknown tool "${marker.toolName}" in ${filePath}. ` +
`Available tools: ${Array.from(toolSchemas.keys()).sort().join(", ")}`
);
}
const actions = extractActions(schema);
if (actions.length === 0) {
throw new Error(`Tool "${marker.toolName}" has no extractable actions in ${filePath}`);
}
const table = generateActionsTable(actions);
const startTag = `<!-- @autogen:tool ${marker.toolName} -->`;
const endTag = "<!-- @autogen:end -->";
const replacement = `${startTag}\n${table}\n${endTag}`;
result = result.slice(0, marker.startIdx) + replacement + result.slice(marker.endIdx);
}
if (result !== fileContent) {
fs.writeFileSync(filePath, result, "utf8");
return true;
}
return false;
}
interface Placeholders {
toolCount: number;
entityCount: number;
readonlyToolCount: number;
version: string;
}
/**
* Replace __TOOL_COUNT__, __ENTITY_COUNT__, __READONLY_TOOL_COUNT__, and __VERSION__ placeholders.
* Returns true if file was modified.
*/
function replacePlaceholders(filePath: string, placeholders: Placeholders): boolean {
const content = fs.readFileSync(filePath, "utf8");
const result = content
.replace(/__TOOL_COUNT__/g, String(placeholders.toolCount))
.replace(/__ENTITY_COUNT__/g, String(placeholders.entityCount))
.replace(/__READONLY_TOOL_COUNT__/g, String(placeholders.readonlyToolCount))
.replace(/__VERSION__/g, placeholders.version);
if (result !== content) {
fs.writeFileSync(filePath, result, "utf8");
return true;
}
return false;
}
/**
* Count entity types by scanning src/entities/ subdirectories with registry.ts files.
* Note: fs.existsSync is safe (returns boolean, never throws) so no try/catch needed.
*/
function countEntities(projectRoot: string): number {
const entitiesDir = path.join(projectRoot, "src", "entities");
if (!fs.existsSync(entitiesDir)) return 0;
// readdirSync may throw on permission errors, but that's a fatal misconfiguration
return fs
.readdirSync(entitiesDir, { withFileTypes: true })
.filter(d => d.isDirectory() && fs.existsSync(path.join(entitiesDir, d.name, "registry.ts")))
.length;
}
/**
* Get version from RELEASE_VERSION env var or package.json.
* RELEASE_VERSION is set by CI from the latest GitHub release tag.
*/
function getVersion(projectRoot: string): string {
// CI provides RELEASE_VERSION from latest GitHub release
if (process.env.RELEASE_VERSION) {
return process.env.RELEASE_VERSION;
}
// Fallback to package.json version (may be dev version)
const packageJsonPath = path.join(projectRoot, "package.json");
if (fs.existsSync(packageJsonPath)) {
const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf8")) as {
version?: string;
};
return packageJson.version ?? "0.0.0";
}
return "0.0.0";
}
/**
* Main entry point. Scans docs/tools/*.md and injects action tables.
* Also generates .md/.txt from .in templates with __TOOL_COUNT__, __ENTITY_COUNT__,
* __READONLY_TOOL_COUNT__, and __VERSION__ placeholders replaced by actual values.
*/
export function main(): void {
// Find project root (where package.json is)
let projectRoot = process.cwd();
while (!fs.existsSync(path.join(projectRoot, "package.json"))) {
const parent = path.dirname(projectRoot);
Iif (parent === projectRoot) break;
projectRoot = parent;
}
const docsToolsDir = path.join(projectRoot, "docs", "tools");
if (!fs.existsSync(docsToolsDir)) {
console.error(`Error: docs/tools/ directory not found at ${docsToolsDir}`);
process.exit(1);
}
// Load all tool schemas from registry
const registryManager = RegistryManager.getInstance();
const allTools = registryManager.getAllToolDefinitionsUnfiltered();
const toolSchemas = new Map<string, JsonSchemaProperty>();
for (const tool of allTools) {
toolSchemas.set(tool.name, tool.inputSchema as JsonSchemaProperty);
}
const toolCount = allTools.length;
const entityCount = countEntities(projectRoot);
// Read-only tools: browse_* (queries) + manage_context (read-only despite manage_ prefix)
// Same pattern used in prepare-release.sh for consistency
const readonlyToolCount = allTools.filter(
t => t.name.startsWith("browse_") || t.name === "manage_context"
).length;
const version = getVersion(projectRoot);
console.log(
` Tool count: ${toolCount}, Entity count: ${entityCount}, Read-only: ${readonlyToolCount}, Version: ${version}`
);
const placeholders: Placeholders = { toolCount, entityCount, readonlyToolCount, version };
// Generate docs from .in templates (*.md.in -> *.md, *.txt.in -> *.txt)
const docsDir = path.join(projectRoot, "docs");
let templateCount = 0;
if (fs.existsSync(docsDir)) {
function processTemplates(dir: string): void {
for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
const fullPath = path.join(dir, entry.name);
// Skip build artifacts and dependencies; .git/coverage/tmp are not present in docs/
if (entry.isDirectory() && !["node_modules", ".vitepress", "dist"].includes(entry.name)) {
processTemplates(fullPath);
} else Eif (
entry.isFile() &&
(entry.name.endsWith(".md.in") || entry.name.endsWith(".txt.in"))
) {
const outputPath = fullPath.replace(/\.in$/, "");
fs.copyFileSync(fullPath, outputPath);
replacePlaceholders(outputPath, placeholders);
templateCount++;
const relPath = path.relative(projectRoot, outputPath);
console.log(` Generated: ${relPath} (from ${entry.name})`);
}
}
}
processTemplates(docsDir);
Eif (templateCount > 0) {
console.log(` Generated ${templateCount} file(s) from .in templates`);
}
}
// Find all .md files in docs/tools/
const mdFiles = fs
.readdirSync(docsToolsDir)
.filter(f => f.endsWith(".md"))
.map(f => path.join(docsToolsDir, f));
let modifiedCount = 0;
let markerCount = 0;
for (const filePath of mdFiles) {
const content = fs.readFileSync(filePath, "utf8");
const markers = findMarkers(content);
markerCount += markers.length;
if (markers.length > 0) {
const modified = processFile(filePath, toolSchemas, content);
if (modified) {
modifiedCount++;
const relPath = path.relative(projectRoot, filePath);
console.log(` Updated: ${relPath} (${markers.length} marker(s))`);
}
}
}
console.log(
`inject-tool-refs: ${markerCount} marker(s) in ${mdFiles.length} file(s), ${modifiedCount} updated.`
);
}
// Exported for unit testing
export {
extractActions,
generateActionsTable,
findMarkers,
processFile,
replacePlaceholders,
countEntities,
getVersion,
};
export type { JsonSchemaProperty, ActionInfo, MarkerMatch, Placeholders };
// Auto-execute when run directly
Iif (process.env.NODE_ENV !== "test") {
main();
}
|