feat: wire up framework route extraction (#89)
* docs: add framework extract wiring plan
* feat(resolution): replace extractNodes with extract() returning nodes and references
* feat(resolution): add getApplicableFrameworks helper for per-language dispatch
* feat(django): emit route nodes and route->view references in extract()
* feat(flask,fastapi): emit route nodes and route->handler references
* feat(express): emit route nodes and route->handler references
* feat(laravel): emit route nodes and route->handler references
* feat(rails): emit route nodes and route->handler references
* feat(spring): emit route nodes and route->handler references
* feat(go): emit route nodes and route->handler references
* feat(rust): emit route nodes and route->handler references
* feat(aspnet): emit route nodes and route->handler references
* feat(swift,vapor): emit route nodes and route->handler references
* chore(react,svelte): migrate resolvers to extract() interface
* feat(extraction): run framework extractors after tree-sitter parse
* docs: document framework route extraction
* feat(strip-comments): add per-language comment stripper for framework extractors
Replaces comment characters and string-literal contents with spaces (not
removal) so source offsets stay valid for downstream regex match index ->
line number conversion. Handles Python triple-quoted docstrings, Ruby
=begin/=end, Rust nested block comments, and the standard //, #, /* */
forms across the supported languages.
This is consumed by framework extract() methods in a follow-up commit so
that commented-out / docstring routing examples don't surface as phantom
route nodes in the graph.
* feat(frameworks): strip comments before regex extraction (prevents phantom routes)
Pipes the per-language stripCommentsForRegex helper into every framework
extract() that scans raw source: django/flask/fastapi (python.ts),
express, laravel, rails, spring, go, rust, aspnet, vapor, plus
swiftui/uikit struct extraction in swift.ts.
Without this, examples like:
# path('/admin/', AdminPanel.as_view())
""" path('/users/', UserListView.as_view()) """
urlpatterns = [path('/real/', RealView.as_view())]
produced 3 phantom route nodes. Now only the real one is extracted.
Each framework gets a regression test in __tests__/frameworks.test.ts
asserting that line-, block-, docstring- and (where relevant)
heredoc-style commented-out routes do not surface as nodes.
---------
Co-authored-by: Colby McHenry <me@colbymchenry.com>
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
timomeara
co-authored by
Colby McHenry
Claude Opus 4.7
Colby McHenry
Claude Opus 4.7
parent
5ab81746e8
commit
74327814ee
@@ -6,6 +6,7 @@
|
||||
|
||||
import { Node } from '../../types';
|
||||
import { FrameworkResolver, UnresolvedRef, ResolvedRef, ResolutionContext } from '../types';
|
||||
import { stripCommentsForRegex } from '../strip-comments';
|
||||
|
||||
/**
|
||||
* Laravel facade mappings to underlying classes
|
||||
@@ -36,6 +37,7 @@ export const FACADE_MAPPINGS: Record<string, string> = {
|
||||
|
||||
export const laravelResolver: FrameworkResolver = {
|
||||
name: 'laravel',
|
||||
languages: ['php'],
|
||||
|
||||
detect(context: ResolutionContext): boolean {
|
||||
// Check for artisan file (Laravel signature)
|
||||
@@ -90,63 +92,115 @@ export const laravelResolver: FrameworkResolver = {
|
||||
return null;
|
||||
},
|
||||
|
||||
extractNodes(filePath: string, content: string): Node[] {
|
||||
extract(filePath, content) {
|
||||
if (!filePath.endsWith('.php')) return { nodes: [], references: [] };
|
||||
const nodes: Node[] = [];
|
||||
const references: UnresolvedRef[] = [];
|
||||
const now = Date.now();
|
||||
const safe = stripCommentsForRegex(content, 'php');
|
||||
|
||||
// Extract route definitions
|
||||
const routePatterns = [
|
||||
// Route::get('/path', ...)
|
||||
/Route::(get|post|put|patch|delete|options|any)\(\s*['"]([^'"]+)['"]/g,
|
||||
// Route::resource('name', ...)
|
||||
/Route::resource\(\s*['"]([^'"]+)['"]/g,
|
||||
// Route::apiResource('name', ...)
|
||||
/Route::apiResource\(\s*['"]([^'"]+)['"]/g,
|
||||
];
|
||||
// Route::METHOD('/path', handler-expr)
|
||||
// handler-expr can be: [Class::class, 'method'] | 'Controller@method' | Closure | Class::class
|
||||
const routeRegex = /Route::(get|post|put|patch|delete|options|any)\s*\(\s*['"]([^'"]+)['"]\s*,\s*([^)]+)\)/g;
|
||||
let match: RegExpExecArray | null;
|
||||
while ((match = routeRegex.exec(safe)) !== null) {
|
||||
const [, method, routePath, handlerExpr] = match;
|
||||
const line = safe.slice(0, match.index).split('\n').length;
|
||||
const upper = method!.toUpperCase();
|
||||
const routeNode: Node = {
|
||||
id: `route:${filePath}:${line}:${upper}:${routePath}`,
|
||||
kind: 'route',
|
||||
name: `${upper} ${routePath}`,
|
||||
qualifiedName: `${filePath}::route:${routePath}`,
|
||||
filePath,
|
||||
startLine: line,
|
||||
endLine: line,
|
||||
startColumn: 0,
|
||||
endColumn: match[0].length,
|
||||
language: 'php',
|
||||
updatedAt: now,
|
||||
};
|
||||
nodes.push(routeNode);
|
||||
|
||||
for (const pattern of routePatterns) {
|
||||
let match;
|
||||
while ((match = pattern.exec(content)) !== null) {
|
||||
if (pattern.source.includes('resource')) {
|
||||
const [, resourceName] = match;
|
||||
const line = content.slice(0, match.index).split('\n').length;
|
||||
nodes.push({
|
||||
id: `route:${filePath}:resource:${resourceName}:${line}`,
|
||||
kind: 'route',
|
||||
name: `resource:${resourceName}`,
|
||||
qualifiedName: `${filePath}::resource:${resourceName}`,
|
||||
const handlerName = extractLaravelHandler(handlerExpr!);
|
||||
if (handlerName) {
|
||||
references.push({
|
||||
fromNodeId: routeNode.id,
|
||||
referenceName: handlerName,
|
||||
referenceKind: 'references',
|
||||
line,
|
||||
column: 0,
|
||||
filePath,
|
||||
language: 'php',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
// Route::resource('name', Controller::class) / Route::apiResource('name', Controller::class)
|
||||
const resourceRegex = /Route::(resource|apiResource)\s*\(\s*['"]([^'"]+)['"]\s*(?:,\s*([^)]+))?\)/g;
|
||||
while ((match = resourceRegex.exec(safe)) !== null) {
|
||||
const [, _fn, resourceName, handlerExpr] = match;
|
||||
const line = safe.slice(0, match.index).split('\n').length;
|
||||
const routeNode: Node = {
|
||||
id: `route:${filePath}:${line}:RESOURCE:${resourceName}`,
|
||||
kind: 'route',
|
||||
name: `resource:${resourceName}`,
|
||||
qualifiedName: `${filePath}::route:${resourceName}`,
|
||||
filePath,
|
||||
startLine: line,
|
||||
endLine: line,
|
||||
startColumn: 0,
|
||||
endColumn: match[0].length,
|
||||
language: 'php',
|
||||
updatedAt: now,
|
||||
};
|
||||
nodes.push(routeNode);
|
||||
|
||||
if (handlerExpr) {
|
||||
const controllerName = extractLaravelHandler(handlerExpr);
|
||||
if (controllerName) {
|
||||
references.push({
|
||||
fromNodeId: routeNode.id,
|
||||
referenceName: controllerName,
|
||||
referenceKind: 'imports',
|
||||
line,
|
||||
column: 0,
|
||||
filePath,
|
||||
startLine: line,
|
||||
endLine: line,
|
||||
startColumn: 0,
|
||||
endColumn: match[0].length,
|
||||
language: 'php',
|
||||
updatedAt: now,
|
||||
});
|
||||
} else {
|
||||
const [, method, path] = match;
|
||||
const line = content.slice(0, match.index).split('\n').length;
|
||||
nodes.push({
|
||||
id: `route:${filePath}:${method!.toUpperCase()}:${path}:${line}`,
|
||||
kind: 'route',
|
||||
name: `${method!.toUpperCase()} ${path}`,
|
||||
qualifiedName: `${filePath}::${method!.toUpperCase()}:${path}`,
|
||||
filePath,
|
||||
startLine: line,
|
||||
endLine: line,
|
||||
startColumn: 0,
|
||||
endColumn: match[0].length,
|
||||
language: 'php',
|
||||
updatedAt: now,
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return nodes;
|
||||
return { nodes, references };
|
||||
},
|
||||
};
|
||||
|
||||
/**
|
||||
* Parse a Laravel route handler expression and return the symbol to link.
|
||||
* - `[Class::class, 'method']` -> `method`
|
||||
* - `'Controller@method'` -> `method`
|
||||
* - `Class::class` -> `Class`
|
||||
* - anything else (closure etc) -> null
|
||||
*/
|
||||
function extractLaravelHandler(expr: string): string | null {
|
||||
const trimmed = expr.trim();
|
||||
|
||||
// [Class::class, 'method'] — grab the string literal
|
||||
const tupleMatch = trimmed.match(/^\[\s*[^,]+,\s*['"]([^'"]+)['"]\s*\]/);
|
||||
if (tupleMatch) return tupleMatch[1]!;
|
||||
|
||||
// 'Controller@method'
|
||||
const atMatch = trimmed.match(/^['"]([^'"@]+)@([^'"]+)['"]$/);
|
||||
if (atMatch) return atMatch[2]!;
|
||||
|
||||
// Controller::class
|
||||
const classMatch = trimmed.match(/^([A-Za-z_][A-Za-z0-9_]*)::class/);
|
||||
if (classMatch) return classMatch[1]!;
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolve a Model::method() call
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user