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
@@ -0,0 +1,59 @@
|
||||
import { describe, it, expect, beforeAll, afterEach } from 'vitest';
|
||||
import * as fs from 'fs';
|
||||
import * as path from 'path';
|
||||
import * as os from 'os';
|
||||
import { CodeGraph } from '../src';
|
||||
import { initGrammars, loadAllGrammars } from '../src/extraction/grammars';
|
||||
|
||||
beforeAll(async () => {
|
||||
await initGrammars();
|
||||
await loadAllGrammars();
|
||||
});
|
||||
|
||||
describe('Django end-to-end framework extraction', () => {
|
||||
let tmpDir: string | undefined;
|
||||
afterEach(() => {
|
||||
if (tmpDir) fs.rmSync(tmpDir, { recursive: true, force: true });
|
||||
tmpDir = undefined;
|
||||
});
|
||||
|
||||
it('creates a route->view edge from urls.py to view class', async () => {
|
||||
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'cg-django-'));
|
||||
fs.writeFileSync(path.join(tmpDir, 'manage.py'), '# marker\n');
|
||||
fs.writeFileSync(path.join(tmpDir, 'requirements.txt'), 'django==4.2\n');
|
||||
fs.mkdirSync(path.join(tmpDir, 'users'));
|
||||
fs.writeFileSync(path.join(tmpDir, 'users/__init__.py'), '');
|
||||
fs.writeFileSync(
|
||||
path.join(tmpDir, 'users/views.py'),
|
||||
'class UserListView:\n def get(self, request): pass\n'
|
||||
);
|
||||
fs.writeFileSync(
|
||||
path.join(tmpDir, 'users/urls.py'),
|
||||
'from django.urls import path\n' +
|
||||
'from users.views import UserListView\n' +
|
||||
'urlpatterns = [path("users/", UserListView.as_view(), name="user-list")]\n'
|
||||
);
|
||||
|
||||
const cg = CodeGraph.initSync(tmpDir);
|
||||
await cg.indexAll();
|
||||
|
||||
// Route node exists
|
||||
const routes = cg.getNodesByKind('route');
|
||||
expect(routes.length).toBeGreaterThan(0);
|
||||
const route = routes.find((n) => n.name === 'users/');
|
||||
expect(route).toBeDefined();
|
||||
|
||||
// View class exists
|
||||
const classNodes = cg.getNodesByKind('class');
|
||||
const view = classNodes.find((n) => n.name === 'UserListView');
|
||||
expect(view).toBeDefined();
|
||||
|
||||
// Edge route -> view exists
|
||||
const edges = cg.getOutgoingEdges(route!.id);
|
||||
const toView = edges.find((e) => e.target === view!.id);
|
||||
expect(toView).toBeDefined();
|
||||
expect(toView!.kind).toBe('references');
|
||||
|
||||
cg.close();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,464 @@
|
||||
import { describe, it, expect } from 'vitest';
|
||||
import type { FrameworkResolver, UnresolvedRef } from '../src/resolution/types';
|
||||
import type { Node } from '../src/types';
|
||||
|
||||
describe('FrameworkResolver.extract interface', () => {
|
||||
it('extract() returns { nodes, references }', () => {
|
||||
const resolver: FrameworkResolver = {
|
||||
name: 'fake',
|
||||
detect: () => true,
|
||||
resolve: () => null,
|
||||
languages: ['python'],
|
||||
extract: (_filePath: string, _content: string) => ({
|
||||
nodes: [] as Node[],
|
||||
references: [] as UnresolvedRef[],
|
||||
}),
|
||||
};
|
||||
const result = resolver.extract!('foo.py', '');
|
||||
expect(result).toEqual({ nodes: [], references: [] });
|
||||
});
|
||||
});
|
||||
|
||||
import { getApplicableFrameworks } from '../src/resolution/frameworks';
|
||||
import type { FrameworkResolver } from '../src/resolution/types';
|
||||
|
||||
describe('getApplicableFrameworks', () => {
|
||||
const pyFw: FrameworkResolver = { name: 'py', languages: ['python'], detect: () => true, resolve: () => null };
|
||||
const jsFw: FrameworkResolver = { name: 'js', languages: ['javascript', 'typescript'], detect: () => true, resolve: () => null };
|
||||
const anyFw: FrameworkResolver = { name: 'any', detect: () => true, resolve: () => null };
|
||||
|
||||
it('filters by language', () => {
|
||||
const result = getApplicableFrameworks([pyFw, jsFw, anyFw], 'python');
|
||||
expect(result.map(r => r.name)).toEqual(['py', 'any']);
|
||||
});
|
||||
|
||||
it('returns anyFw-only when language has no matches', () => {
|
||||
const result = getApplicableFrameworks([pyFw, jsFw, anyFw], 'rust');
|
||||
expect(result.map(r => r.name)).toEqual(['any']);
|
||||
});
|
||||
});
|
||||
|
||||
import { djangoResolver } from '../src/resolution/frameworks/python';
|
||||
|
||||
describe('djangoResolver.extract', () => {
|
||||
it('extracts route node and reference for path() with CBV.as_view()', () => {
|
||||
const src = `
|
||||
from django.urls import path
|
||||
from users.views import UserListView
|
||||
|
||||
urlpatterns = [
|
||||
path('users/', UserListView.as_view(), name='user-list'),
|
||||
]
|
||||
`;
|
||||
const { nodes, references } = djangoResolver.extract!('users/urls.py', src);
|
||||
expect(nodes).toHaveLength(1);
|
||||
expect(nodes[0].kind).toBe('route');
|
||||
expect(nodes[0].name).toBe('users/');
|
||||
expect(references).toHaveLength(1);
|
||||
expect(references[0].referenceName).toBe('UserListView');
|
||||
expect(references[0].referenceKind).toBe('references');
|
||||
expect(references[0].fromNodeId).toBe(nodes[0].id);
|
||||
});
|
||||
|
||||
it('extracts route for path() with dotted module.Class.as_view()', () => {
|
||||
const src = `from django.urls import path\nfrom api.v1 import views as api_v1_views\nurlpatterns = [path('api/', api_v1_views.UserListView.as_view())]\n`;
|
||||
const { nodes, references } = djangoResolver.extract!('api/urls.py', src);
|
||||
expect(nodes).toHaveLength(1);
|
||||
expect(references[0].referenceName).toBe('UserListView');
|
||||
});
|
||||
|
||||
it('extracts route for path() with bare function view', () => {
|
||||
const src = `from django.urls import path\nurlpatterns = [path('home/', home_view, name='home')]\n`;
|
||||
const { nodes, references } = djangoResolver.extract!('home/urls.py', src);
|
||||
expect(references[0].referenceName).toBe('home_view');
|
||||
});
|
||||
|
||||
it('extracts route for path() with include()', () => {
|
||||
const src = `from django.urls import path, include\nurlpatterns = [path('api/', include('api.urls'))]\n`;
|
||||
const { nodes, references } = djangoResolver.extract!('root/urls.py', src);
|
||||
expect(nodes).toHaveLength(1);
|
||||
expect(nodes[0].kind).toBe('route');
|
||||
expect(references[0].referenceName).toBe('api.urls');
|
||||
expect(references[0].referenceKind).toBe('imports');
|
||||
});
|
||||
|
||||
it('extracts routes for re_path and url', () => {
|
||||
const src = `from django.urls import re_path, url\nurlpatterns = [re_path(r'^users/$', UserView), url(r'^old/$', OldView)]\n`;
|
||||
const { nodes } = djangoResolver.extract!('legacy/urls.py', src);
|
||||
expect(nodes).toHaveLength(2);
|
||||
expect(nodes.map(n => n.name)).toEqual(['^users/$', '^old/$']);
|
||||
});
|
||||
|
||||
it('returns empty result for a non-urls.py python file', () => {
|
||||
const src = `def foo(): return 1\n`;
|
||||
const { nodes, references } = djangoResolver.extract!('views.py', src);
|
||||
expect(nodes).toEqual([]);
|
||||
expect(references).toEqual([]);
|
||||
});
|
||||
});
|
||||
|
||||
import { flaskResolver, fastapiResolver } from '../src/resolution/frameworks/python';
|
||||
|
||||
describe('flaskResolver.extract', () => {
|
||||
it('extracts route and reference from @app.route', () => {
|
||||
const src = `
|
||||
@app.route('/users')
|
||||
def list_users():
|
||||
return []
|
||||
`;
|
||||
const { nodes, references } = flaskResolver.extract!('app.py', src);
|
||||
expect(nodes).toHaveLength(1);
|
||||
expect(nodes[0].kind).toBe('route');
|
||||
expect(nodes[0].name).toBe('GET /users');
|
||||
expect(references[0].referenceName).toBe('list_users');
|
||||
});
|
||||
|
||||
it('extracts blueprint routes', () => {
|
||||
const src = `
|
||||
@users_bp.route('/<id>', methods=['POST'])
|
||||
def create_user(id):
|
||||
pass
|
||||
`;
|
||||
const { nodes, references } = flaskResolver.extract!('routes.py', src);
|
||||
expect(nodes[0].name).toBe('POST /<id>');
|
||||
expect(references[0].referenceName).toBe('create_user');
|
||||
});
|
||||
});
|
||||
|
||||
describe('fastapiResolver.extract', () => {
|
||||
it('extracts route and reference from @app.get', () => {
|
||||
const src = `
|
||||
@app.get('/users')
|
||||
async def list_users():
|
||||
return []
|
||||
`;
|
||||
const { nodes, references } = fastapiResolver.extract!('main.py', src);
|
||||
expect(nodes[0].name).toBe('GET /users');
|
||||
expect(references[0].referenceName).toBe('list_users');
|
||||
});
|
||||
|
||||
it('extracts route from router.post', () => {
|
||||
const src = `
|
||||
@router.post('/items')
|
||||
def create_item(item: Item):
|
||||
pass
|
||||
`;
|
||||
const { nodes, references } = fastapiResolver.extract!('items.py', src);
|
||||
expect(nodes[0].name).toBe('POST /items');
|
||||
expect(references[0].referenceName).toBe('create_item');
|
||||
});
|
||||
});
|
||||
|
||||
import { expressResolver } from '../src/resolution/frameworks/express';
|
||||
|
||||
describe('expressResolver.extract', () => {
|
||||
it('extracts route with inline handler reference', () => {
|
||||
const src = `app.get('/users', listUsers);\n`;
|
||||
const { nodes, references } = expressResolver.extract!('routes.ts', src);
|
||||
expect(nodes).toHaveLength(1);
|
||||
expect(nodes[0].name).toBe('GET /users');
|
||||
expect(references[0].referenceName).toBe('listUsers');
|
||||
});
|
||||
|
||||
it('extracts route with router.post and middleware chain', () => {
|
||||
const src = `router.post('/items', auth, createItem);\n`;
|
||||
const { nodes, references } = expressResolver.extract!('items.ts', src);
|
||||
expect(nodes[0].name).toBe('POST /items');
|
||||
// Multiple handlers: prefer the LAST one (convention: middleware first, handler last)
|
||||
expect(references[0].referenceName).toBe('createItem');
|
||||
});
|
||||
|
||||
it('extracts route with controller method reference', () => {
|
||||
const src = `app.get('/x', userController.list);\n`;
|
||||
const { nodes, references } = expressResolver.extract!('routes.ts', src);
|
||||
expect(references[0].referenceName).toBe('list');
|
||||
});
|
||||
});
|
||||
|
||||
import { laravelResolver } from '../src/resolution/frameworks/laravel';
|
||||
|
||||
describe('laravelResolver.extract', () => {
|
||||
it('extracts route with controller tuple syntax', () => {
|
||||
const src = `Route::get('/users', [UserController::class, 'index']);\n`;
|
||||
const { nodes, references } = laravelResolver.extract!('routes/web.php', src);
|
||||
expect(nodes[0].name).toBe('GET /users');
|
||||
expect(references[0].referenceName).toBe('index');
|
||||
});
|
||||
|
||||
it('extracts route with Controller@action syntax', () => {
|
||||
const src = `Route::post('/users', 'UserController@store');\n`;
|
||||
const { nodes, references } = laravelResolver.extract!('routes/web.php', src);
|
||||
expect(references[0].referenceName).toBe('store');
|
||||
});
|
||||
|
||||
it('extracts resource route', () => {
|
||||
const src = `Route::resource('users', UserController::class);\n`;
|
||||
const { nodes, references } = laravelResolver.extract!('routes/web.php', src);
|
||||
expect(nodes[0].kind).toBe('route');
|
||||
expect(references[0].referenceName).toBe('UserController');
|
||||
});
|
||||
});
|
||||
|
||||
import { railsResolver } from '../src/resolution/frameworks/ruby';
|
||||
|
||||
describe('railsResolver.extract', () => {
|
||||
it('extracts route with controller#action syntax', () => {
|
||||
const src = `get '/users', to: 'users#index'\n`;
|
||||
const { nodes, references } = railsResolver.extract!('config/routes.rb', src);
|
||||
expect(nodes[0].name).toBe('GET /users');
|
||||
expect(references[0].referenceName).toBe('index');
|
||||
});
|
||||
|
||||
it('extracts route without to: keyword', () => {
|
||||
const src = `post '/items' => 'items#create'\n`;
|
||||
const { nodes, references } = railsResolver.extract!('config/routes.rb', src);
|
||||
expect(references[0].referenceName).toBe('create');
|
||||
});
|
||||
});
|
||||
|
||||
import { springResolver } from '../src/resolution/frameworks/java';
|
||||
|
||||
describe('springResolver.extract', () => {
|
||||
it('extracts route with @GetMapping and next method', () => {
|
||||
const src = `
|
||||
@GetMapping("/users")
|
||||
public List<User> listUsers() {
|
||||
return users;
|
||||
}
|
||||
`;
|
||||
const { nodes, references } = springResolver.extract!('UserController.java', src);
|
||||
expect(nodes[0].name).toBe('GET /users');
|
||||
expect(references[0].referenceName).toBe('listUsers');
|
||||
});
|
||||
});
|
||||
|
||||
import { goResolver } from '../src/resolution/frameworks/go';
|
||||
|
||||
describe('goResolver.extract', () => {
|
||||
it('extracts route from r.GET', () => {
|
||||
const src = `r.GET("/users", listUsers)\n`;
|
||||
const { nodes, references } = goResolver.extract!('main.go', src);
|
||||
expect(nodes[0].name).toBe('GET /users');
|
||||
expect(references[0].referenceName).toBe('listUsers');
|
||||
});
|
||||
|
||||
it('extracts route from router.HandleFunc', () => {
|
||||
const src = `router.HandleFunc("/items", createItem)\n`;
|
||||
const { nodes, references } = goResolver.extract!('main.go', src);
|
||||
expect(references[0].referenceName).toBe('createItem');
|
||||
});
|
||||
});
|
||||
|
||||
import { rustResolver } from '../src/resolution/frameworks/rust';
|
||||
|
||||
describe('rustResolver.extract', () => {
|
||||
it('extracts route from axum .route with get()', () => {
|
||||
const src = `let app = Router::new().route("/users", get(list_users));\n`;
|
||||
const { nodes, references } = rustResolver.extract!('main.rs', src);
|
||||
expect(nodes[0].name).toBe('GET /users');
|
||||
expect(references[0].referenceName).toBe('list_users');
|
||||
});
|
||||
});
|
||||
|
||||
import { aspnetResolver } from '../src/resolution/frameworks/csharp';
|
||||
|
||||
describe('aspnetResolver.extract', () => {
|
||||
it('extracts route from [HttpGet] attribute', () => {
|
||||
const src = `
|
||||
[HttpGet("/users")]
|
||||
public IActionResult ListUsers()
|
||||
{
|
||||
return Ok();
|
||||
}
|
||||
`;
|
||||
const { nodes, references } = aspnetResolver.extract!('UserController.cs', src);
|
||||
expect(nodes[0].name).toBe('GET /users');
|
||||
expect(references[0].referenceName).toBe('ListUsers');
|
||||
});
|
||||
});
|
||||
|
||||
import { vaporResolver } from '../src/resolution/frameworks/swift';
|
||||
|
||||
describe('vaporResolver.extract', () => {
|
||||
it('extracts route from app.get with use:', () => {
|
||||
const src = `app.get("users", use: listUsers)\n`;
|
||||
const { nodes, references } = vaporResolver.extract!('routes.swift', src);
|
||||
expect(nodes[0].name).toBe('GET users');
|
||||
expect(references[0].referenceName).toBe('listUsers');
|
||||
});
|
||||
});
|
||||
|
||||
import { reactResolver } from '../src/resolution/frameworks/react';
|
||||
import { svelteResolver } from '../src/resolution/frameworks/svelte';
|
||||
|
||||
describe('reactResolver.extract (smoke)', () => {
|
||||
it('returns { nodes, references } shape', () => {
|
||||
const src = `<Route path="/users" element={<UsersPage/>}/>`;
|
||||
const result = reactResolver.extract!('App.tsx', src);
|
||||
expect(result).toHaveProperty('nodes');
|
||||
expect(result).toHaveProperty('references');
|
||||
expect(Array.isArray(result.nodes)).toBe(true);
|
||||
expect(Array.isArray(result.references)).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe('svelteResolver.extract (smoke)', () => {
|
||||
it('returns { nodes, references } shape', () => {
|
||||
const result = svelteResolver.extract!('+page.svelte', '');
|
||||
expect(result).toHaveProperty('nodes');
|
||||
expect(result).toHaveProperty('references');
|
||||
});
|
||||
});
|
||||
|
||||
// Regression tests: commented-out and docstring route examples must NOT
|
||||
// surface as phantom route nodes. These would have failed before the
|
||||
// strip-comments wiring (the regex would happily scan comments/docstrings).
|
||||
describe('framework extractors ignore commented-out routes', () => {
|
||||
it('django: skips line-comment and docstring routes', () => {
|
||||
const src = `
|
||||
# urls.py example:
|
||||
# path('/admin/', AdminPanel.as_view())
|
||||
"""
|
||||
Other routing example:
|
||||
path('/users/', UserListView.as_view())
|
||||
"""
|
||||
urlpatterns = [path('/real/', RealView.as_view())]
|
||||
`;
|
||||
const result = djangoResolver.extract!('app/urls.py', src);
|
||||
const urls = result.nodes.map((n) => n.name);
|
||||
expect(urls).toEqual(['/real/']);
|
||||
});
|
||||
|
||||
it('flask: skips commented-out @app.route', () => {
|
||||
const src = `
|
||||
# @app.route('/fake')
|
||||
# def fake_view():
|
||||
# return ''
|
||||
|
||||
@app.route('/real')
|
||||
def real_view():
|
||||
return ''
|
||||
`;
|
||||
const { nodes, references } = flaskResolver.extract!('app.py', src);
|
||||
expect(nodes.map((n) => n.name)).toEqual(['GET /real']);
|
||||
expect(references.map((r) => r.referenceName)).toEqual(['real_view']);
|
||||
});
|
||||
|
||||
it('fastapi: skips docstring example routes', () => {
|
||||
const src = `
|
||||
"""
|
||||
Example:
|
||||
@app.get('/in-docstring')
|
||||
async def doc():
|
||||
pass
|
||||
"""
|
||||
@app.get('/real')
|
||||
async def real_handler():
|
||||
return {}
|
||||
`;
|
||||
const { nodes, references } = fastapiResolver.extract!('main.py', src);
|
||||
expect(nodes.map((n) => n.name)).toEqual(['GET /real']);
|
||||
expect(references.map((r) => r.referenceName)).toEqual(['real_handler']);
|
||||
});
|
||||
|
||||
it('express: skips // and /* */ commented routes', () => {
|
||||
const src = `
|
||||
// app.get('/fake', fakeHandler);
|
||||
/* router.post('/also-fake', otherHandler); */
|
||||
app.get('/real', realHandler);
|
||||
`;
|
||||
const { nodes, references } = expressResolver.extract!('routes.ts', src);
|
||||
expect(nodes.map((n) => n.name)).toEqual(['GET /real']);
|
||||
expect(references.map((r) => r.referenceName)).toEqual(['realHandler']);
|
||||
});
|
||||
|
||||
it('laravel: skips // # and /* */ commented Route::* calls', () => {
|
||||
const src = `<?php
|
||||
// Route::get('/fake', [FakeController::class, 'index']);
|
||||
# Route::get('/also-fake', 'FakeController@show');
|
||||
/* Route::post('/another-fake', [X::class, 'y']); */
|
||||
Route::get('/real', [RealController::class, 'index']);
|
||||
`;
|
||||
const { nodes, references } = laravelResolver.extract!('routes/web.php', src);
|
||||
expect(nodes.map((n) => n.name)).toEqual(['GET /real']);
|
||||
expect(references.map((r) => r.referenceName)).toEqual(['index']);
|
||||
});
|
||||
|
||||
it('rails: skips =begin/=end and # commented routes', () => {
|
||||
const src = `
|
||||
# get '/fake', to: 'fake#index'
|
||||
=begin
|
||||
get '/also-fake', to: 'fake#show'
|
||||
=end
|
||||
get '/real', to: 'real#index'
|
||||
`;
|
||||
const { nodes, references } = railsResolver.extract!('config/routes.rb', src);
|
||||
expect(nodes.map((n) => n.name)).toEqual(['GET /real']);
|
||||
expect(references.map((r) => r.referenceName)).toEqual(['index']);
|
||||
});
|
||||
|
||||
it('spring: skips // and /* */ commented @GetMapping', () => {
|
||||
const src = `
|
||||
// @GetMapping("/fake")
|
||||
// public List<X> fake() { return null; }
|
||||
|
||||
/* @PostMapping("/also-fake")
|
||||
public void alsoFake() {} */
|
||||
|
||||
@GetMapping("/real")
|
||||
public List<User> listUsers() { return users; }
|
||||
`;
|
||||
const { nodes, references } = springResolver.extract!('UserController.java', src);
|
||||
expect(nodes.map((n) => n.name)).toEqual(['GET /real']);
|
||||
expect(references.map((r) => r.referenceName)).toEqual(['listUsers']);
|
||||
});
|
||||
|
||||
it('go: skips // and /* */ commented router.METHOD calls', () => {
|
||||
const src = `
|
||||
// r.GET("/fake", fakeHandler)
|
||||
/* r.POST("/also-fake", anotherHandler) */
|
||||
r.GET("/real", listUsers)
|
||||
`;
|
||||
const { nodes, references } = goResolver.extract!('main.go', src);
|
||||
expect(nodes.map((n) => n.name)).toEqual(['GET /real']);
|
||||
expect(references.map((r) => r.referenceName)).toEqual(['listUsers']);
|
||||
});
|
||||
|
||||
it('rust: skips // and nested /* */ commented .route() calls', () => {
|
||||
const src = `
|
||||
// .route("/fake", get(fake_handler))
|
||||
/* outer /* inner .route("/inner-fake", get(x)) */ still .route("/outer-fake", get(y)) */
|
||||
let app = Router::new().route("/real", get(list_users));
|
||||
`;
|
||||
const { nodes, references } = rustResolver.extract!('main.rs', src);
|
||||
expect(nodes.map((n) => n.name)).toEqual(['GET /real']);
|
||||
expect(references.map((r) => r.referenceName)).toEqual(['list_users']);
|
||||
});
|
||||
|
||||
it('aspnet: skips // and /* */ commented [HttpGet] attributes', () => {
|
||||
const src = `
|
||||
// [HttpGet("/fake")]
|
||||
// public IActionResult Fake() { return Ok(); }
|
||||
|
||||
/* [HttpPost("/also-fake")]
|
||||
public IActionResult AlsoFake() { return Ok(); } */
|
||||
|
||||
[HttpGet("/real")]
|
||||
public IActionResult ListUsers() { return Ok(); }
|
||||
`;
|
||||
const { nodes, references } = aspnetResolver.extract!('UserController.cs', src);
|
||||
expect(nodes.map((n) => n.name)).toEqual(['GET /real']);
|
||||
expect(references.map((r) => r.referenceName)).toEqual(['ListUsers']);
|
||||
});
|
||||
|
||||
it('vapor: skips // and /* */ commented app.METHOD calls', () => {
|
||||
const src = `
|
||||
// app.get("fake", use: fakeHandler)
|
||||
/* app.post("also-fake", use: anotherHandler) */
|
||||
app.get("real", use: listUsers)
|
||||
`;
|
||||
const { nodes, references } = vaporResolver.extract!('routes.swift', src);
|
||||
expect(nodes.map((n) => n.name)).toEqual(['GET real']);
|
||||
expect(references.map((r) => r.referenceName)).toEqual(['listUsers']);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,134 @@
|
||||
import { describe, it, expect } from 'vitest';
|
||||
import { stripCommentsForRegex } from '../src/resolution/strip-comments';
|
||||
|
||||
describe('stripCommentsForRegex', () => {
|
||||
it('python: strips line comments', () => {
|
||||
const src = "x = 1 # path('/fake/', View)\nreal = 2";
|
||||
const out = stripCommentsForRegex(src, 'python');
|
||||
expect(out).not.toMatch(/path\('\/fake\//);
|
||||
expect(out).toMatch(/real = 2/);
|
||||
});
|
||||
|
||||
it('python: strips triple-quoted docstrings', () => {
|
||||
const src = `"""
|
||||
path('/in-docstring/', View)
|
||||
"""
|
||||
real = 1
|
||||
`;
|
||||
const out = stripCommentsForRegex(src, 'python');
|
||||
expect(out).not.toMatch(/in-docstring/);
|
||||
expect(out).toMatch(/real = 1/);
|
||||
});
|
||||
|
||||
it('python: keeps # inside strings', () => {
|
||||
const src = `path('#/fragment/', View)\n`;
|
||||
const out = stripCommentsForRegex(src, 'python');
|
||||
expect(out).toContain("'#/fragment/'");
|
||||
});
|
||||
|
||||
it('python: handles triple-single-quoted docstrings', () => {
|
||||
const src = `'''\npath('/fake/')\n'''\nreal = 1\n`;
|
||||
const out = stripCommentsForRegex(src, 'python');
|
||||
expect(out).not.toMatch(/fake/);
|
||||
expect(out).toMatch(/real = 1/);
|
||||
});
|
||||
|
||||
it('typescript: strips //, /* */', () => {
|
||||
const src =
|
||||
"// app.get('/fake', x)\n/* app.get('/also-fake', y) */\napp.get('/real', z)";
|
||||
const out = stripCommentsForRegex(src, 'typescript');
|
||||
expect(out).not.toMatch(/fake/);
|
||||
expect(out).toMatch(/'\/real'/);
|
||||
});
|
||||
|
||||
it('typescript: keeps // inside strings', () => {
|
||||
const src = `const url = "https://example.com/path";\n`;
|
||||
const out = stripCommentsForRegex(src, 'typescript');
|
||||
expect(out).toContain('https://example.com/path');
|
||||
});
|
||||
|
||||
it('php: strips //, #, and /* */', () => {
|
||||
const src =
|
||||
"// Route::get('/a', X::class)\n# Route::get('/b', Y::class)\n/* Route::get('/c', Z::class) */\nReal::go();";
|
||||
const out = stripCommentsForRegex(src, 'php');
|
||||
expect(out).not.toMatch(/'\/a'/);
|
||||
expect(out).not.toMatch(/'\/b'/);
|
||||
expect(out).not.toMatch(/'\/c'/);
|
||||
expect(out).toContain('Real::go();');
|
||||
});
|
||||
|
||||
it('ruby: strips =begin/=end', () => {
|
||||
const src =
|
||||
"=begin\nget '/fake', to: 'x#y'\n=end\nget '/real', to: 'a#b'\n";
|
||||
const out = stripCommentsForRegex(src, 'ruby');
|
||||
expect(out).not.toMatch(/fake/);
|
||||
expect(out).toMatch(/'\/real'/);
|
||||
});
|
||||
|
||||
it('ruby: strips # comments', () => {
|
||||
const src = "# get '/fake', to: 'x#y'\nget '/real', to: 'a#b'\n";
|
||||
const out = stripCommentsForRegex(src, 'ruby');
|
||||
expect(out).not.toMatch(/fake/);
|
||||
expect(out).toMatch(/'\/real'/);
|
||||
});
|
||||
|
||||
it('rust: handles nested block comments', () => {
|
||||
const src =
|
||||
'/* outer /* inner */ still in outer */ .route("/real", get(h))';
|
||||
const out = stripCommentsForRegex(src, 'rust');
|
||||
expect(out).not.toMatch(/inner/);
|
||||
expect(out).toMatch(/\/real/);
|
||||
});
|
||||
|
||||
it('go: keeps backtick raw strings intact, strips // comments', () => {
|
||||
const src = '// r.GET("/fake", h)\nr.GET(`/real`, h2)\n';
|
||||
const out = stripCommentsForRegex(src, 'go');
|
||||
expect(out).not.toMatch(/fake/);
|
||||
// backtick raw string contents preserved
|
||||
expect(out).toMatch(/`\/real`/);
|
||||
});
|
||||
|
||||
it('go: strips block comments containing route-shaped text', () => {
|
||||
const src = '/* r.GET("/fake", h) */\nr.GET("/real", h2)\n';
|
||||
const out = stripCommentsForRegex(src, 'go');
|
||||
expect(out).not.toMatch(/fake/);
|
||||
expect(out).toMatch(/"\/real"/);
|
||||
});
|
||||
|
||||
it('java: strips // and /* */ comments', () => {
|
||||
const src =
|
||||
'// @GetMapping("/fake")\n/* @PostMapping("/also-fake") */\n@GetMapping("/real")\n';
|
||||
const out = stripCommentsForRegex(src, 'java');
|
||||
expect(out).not.toMatch(/fake/);
|
||||
expect(out).toMatch(/"\/real"/);
|
||||
});
|
||||
|
||||
it('csharp: strips // and /* */ comments', () => {
|
||||
const src =
|
||||
'// [HttpGet("/fake")]\n/* [HttpPost("/also-fake")] */\n[HttpGet("/real")]\n';
|
||||
const out = stripCommentsForRegex(src, 'csharp');
|
||||
expect(out).not.toMatch(/fake/);
|
||||
expect(out).toMatch(/"\/real"/);
|
||||
});
|
||||
|
||||
it('swift: strips // and /* */ comments', () => {
|
||||
const src =
|
||||
'// app.get("fake", use: x)\n/* app.get("also-fake", use: y) */\napp.get("real", use: z)\n';
|
||||
const out = stripCommentsForRegex(src, 'swift');
|
||||
expect(out).not.toMatch(/fake/);
|
||||
expect(out).toMatch(/"real"/);
|
||||
});
|
||||
|
||||
it('preserves line numbers (newlines retained)', () => {
|
||||
const src = "line1\n# comment with path('/fake/')\nline3";
|
||||
const out = stripCommentsForRegex(src, 'python');
|
||||
expect(out.split('\n').length).toBe(3);
|
||||
expect(out.split('\n')[2]).toBe('line3');
|
||||
});
|
||||
|
||||
it('preserves overall length so source offsets stay valid', () => {
|
||||
const src = "x = 1 # path('/fake/', View)\nreal = 2";
|
||||
const out = stripCommentsForRegex(src, 'python');
|
||||
expect(out.length).toBe(src.length);
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user