Oak Builder GitHub

Purpose & User Intent: The Oak Builder GitHub tool provides domain-focused analysis and scaffolding for Oak-based repositories on GitHub. Target users are developers and engineering teams starting or restructuring projects that use the Oak framework (primarily associated with Deno). It is used when evaluating repository structure, middleware usage, routing patterns, dependency health, test and CI readiness, and deployment considerations. The tool outputs concrete scaffolding plans and architecture guidance to accelerate onboarding and maintainability.
\n\nCore Logic & Features: The tool ingests a GitHub repo URL or local path, detects Oak-related patterns, and builds a domain graph of modules, routes, middleware, and dependencies. Required features include repo ingestion, Oak pattern detection, dependency graph, and a scaffold/template generator. Optional/advanced features include security hints, performance hotspots, version migration plans, and GitHub PR-ready scaffolds. Unique differentiators are Oak-specific middleware patterns, migration guidance to newer Oak versions, and automated scaffold generation aligned with common Oak project templates.
\n\nInputs & Outputs: Inputs include repo_url (string), analysis_scope (enum: full/modular), oak_version (string, optional), include_tests (boolean), target_platform (string: deno/node). Outputs include analysis_report (JSON), recommended_structure (array of folders/files), scaffold_plan (object with steps and templates), and risk_score (0-100). Outputs also provide export options to GitHub as a PR template or patch.
\n\nAlgorithms & Calculations: The tool uses static analysis, AST-based pattern detection, and a lightweight dependency graph to estimate risk and readiness. It computes a quality score from lint/test coverage and dependency health, and a structural recommendation score for scaffolding. Formulas: risk_score = w1*missing_tests + w2*outdated_deps + w3*complexity + w4*unverified_middlewares. All figures are heuristic and explainable.
\n\nError & Edge Cases: Handles invalid URL, private or inaccessible repos, rate limits, missing inputs, or ambiguous Oak version with explicit error codes and fallback guidance. External data unavailability yields conservative recommendations and clearly labeled gaps.
\n\nIndustry/Region & Localization: Aligns with GitHub workflows and Node/Deno ecosystems; uses ISO date/time formatting and UTC timestamps in reports; units are code-related (files, lines, dependencies). Localization defaults to English.
\n\nAssumptions & Exclusions: Assumes public or access-authorized repos; does not execute runtime code or perform deep security scanning; excludes UI rendering, and not responsible for production deployment decisions.