handbook-origin
Discover the philosophy behind Stimulus, explore its principles for JavaScript frameworks, and understand its server-rendered HTML approach with detailed insights.
Instructions
Learn why Stimulus was created by DHH - covers the philosophy of modest JavaScript frameworks, server-rendered HTML, and how Stimulus differs from mainstream JavaScript frameworks like React
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/index.ts:17-45 (registration)Dynamic registration of the 'handbook-origin' tool (and all other doc tools) via loop over docFiles from config. Each tool gets a name, description, and inline async handler that reads the specific markdown file using readMarkdownFile and returns it as text content, with error handling.docFiles.forEach(({ folder, file, name, description }) => { server.tool( name, description, async () => { try { const content = await readMarkdownFile(path.join(folder, file)); return { content: [ { type: "text", text: content } ] }; } catch (error) { const errorMessage = error instanceof Error ? error.message : String(error); return { content: [ { type: "text", text: `Error reading ${file}: ${errorMessage}` } ] }; } } ); });
- src/config.ts:15-20 (schema)Metadata definition for the 'handbook-origin' tool within the docFiles array, specifying folder, file path, tool name, and description used in registration.{ folder: 'handbook', file: '00_the_origin_of_stimulus.md', name: 'handbook-origin', description: 'Learn why Stimulus was created by DHH - covers the philosophy of modest JavaScript frameworks, server-rendered HTML, and how Stimulus differs from mainstream JavaScript frameworks like React' },
- src/documentReader.ts:14-61 (handler)Core handler logic executed by the tool: readMarkdownFile fetches the markdown content for 'handbook/00_the_origin_of_stimulus.md' from cache, GitHub raw, or local fallback, with commit-based caching.export async function readMarkdownFile(filename: string): Promise<string> { const filePath = path.join(docsFolder, filename); if (!filePath.startsWith(docsFolder)) { throw new Error("Invalid file path"); } // Get current commit info if we don't have it yet if (!mainBranchInfo) { try { const commitInfo = await fetchMainBranchInformation(); const cacheKey = `${commitInfo.sha.substring(0, 7)}-${commitInfo.timestamp}`; mainBranchInfo = { ...commitInfo, cacheKey }; } catch (shaError) { console.error('Failed to get GitHub commit info, falling back to direct fetch'); } } // Try to read from cache first if we have commit info if (mainBranchInfo) { const cachedFilePath = path.join(cacheFolder, mainBranchInfo.cacheKey, filename); try { const content = await fs.promises.readFile(cachedFilePath, "utf-8"); console.error(`Using cached content for ${mainBranchInfo.cacheKey}: ${filename}`); return content; } catch (cacheError) { // Cache miss, continue to fetch from GitHub } } // Fetch from GitHub try { return await fetchFromGitHub(filename, mainBranchInfo?.cacheKey); } catch (githubError) { console.error(`GitHub fetch failed: ${githubError}, attempting to read from local files...`); // Fallback: read from local files try { return await fs.promises.readFile(filePath, "utf-8"); } catch (localError) { const githubErrorMessage = githubError instanceof Error ? githubError.message : String(githubError); const localErrorMessage = localError instanceof Error ? localError.message : String(localError); throw new Error(`Failed to read file from GitHub (${githubErrorMessage}) and locally (${localErrorMessage})`); } } }
- src/utils.ts:50-74 (helper)Helper function fetchFromGitHub used by readMarkdownFile to retrieve and cache the raw markdown content from GitHub.export async function fetchFromGitHub(filename: string, cacheKey?: string): Promise<string> { const githubUrl = `${GITHUB_RAW_BASE_URL}/${filename}`; const response = await fetch(githubUrl); if (!response.ok) { throw new Error(`GitHub fetch failed: ${response.status} ${response.statusText}`); } const content = await response.text(); // Cache the content with cache key if available if (cacheKey) { try { const cacheFolder = path.resolve(__dirname, "../cache"); const cachedFilePath = path.join(cacheFolder, cacheKey, filename); await fs.promises.mkdir(path.dirname(cachedFilePath), { recursive: true }); await fs.promises.writeFile(cachedFilePath, content, "utf-8"); console.error(`Cached GitHub content for ${cacheKey}: ${filename}`); } catch (cacheError) { console.error(`Failed to cache content: ${cacheError}`); } } return content; }