@qulib/core 0.1.0

package/dist/tools/repo-scanner.js

@@ -0,0 +1,147 @@
+import { readFile } from 'node:fs/promises';
+import { relative, basename } from 'node:path';
+import glob from 'fast-glob';
+import { RepoAnalysisSchema } from '../schemas/repo-analysis.schema.js';
+const IGNORE_PATTERNS = ['**/node_modules/**', '**/.next/**', '**/dist/**', '**/build/**'];
+function toPosix(path) {
+    return path.split('\\').join('/');
+}
+function normalizeRoutePath(path) {
+    const normalized = `/${path}`.replace(/\/+/g, '/').replace(/\/$/, '');
+    return normalized === '' ? '/' : normalized;
+}
+function detectTestType(filePath, content) {
+    const normalizedPath = toPosix(filePath);
+    if (normalizedPath.includes('cypress/e2e'))
+        return 'cypress-e2e';
+    if (normalizedPath.includes('cypress/component'))
+        return 'cypress-component';
+    if ((normalizedPath.includes('playwright') || normalizedPath.includes('e2e')) &&
+        normalizedPath.endsWith('.spec.ts')) {
+        return 'playwright';
+    }
+    if (/\bfrom\s+['"]vitest['"]|\brequire\(['"]vitest['"]\)/.test(content))
+        return 'vitest';
+    if (/\bfrom\s+['"]jest['"]|\brequire\(['"]jest['"]\)/.test(content))
+        return 'jest';
+    return 'other';
+}
+function extractCoveredPaths(content) {
+    const matches = [...content.matchAll(/['"`](\/[a-zA-Z0-9\/_\-\[\]]+)['"`]/g)].map((m) => m[1]);
+    return [...new Set(matches)];
+}
+export async function scanRepo(repoPath) {
+    const routes = [];
+    const appRouterFiles = await glob(['app/**/page.tsx', 'app/**/page.ts'], {
+        cwd: repoPath,
+        onlyFiles: true,
+        absolute: true,
+        ignore: IGNORE_PATTERNS,
+    });
+    for (const file of appRouterFiles) {
+        const rel = toPosix(relative(repoPath, file));
+        const routeSegment = rel.replace(/^app\//, '').replace(/\/page\.tsx?$/, '');
+        const routePath = normalizeRoutePath(routeSegment);
+        routes.push({ path: routePath, file: rel, method: 'GET' });
+    }
+    const pagesRouterFiles = await glob(['pages/**/*.tsx', 'pages/**/*.ts'], {
+        cwd: repoPath,
+        onlyFiles: true,
+        absolute: true,
+        ignore: IGNORE_PATTERNS,
+    });
+    for (const file of pagesRouterFiles) {
+        const rel = toPosix(relative(repoPath, file));
+        const name = basename(rel);
+        if (name.startsWith('_'))
+            continue;
+        const routeSegment = rel.replace(/^pages\//, '').replace(/\.tsx?$/, '');
+        const routePath = routeSegment === 'index'
+            ? '/'
+            : normalizeRoutePath(routeSegment.replace(/\/index$/, ''));
+        routes.push({ path: routePath, file: rel, method: 'GET' });
+    }
+    const expressFiles = await glob(['src/**/*.ts', 'src/**/*.js'], {
+        cwd: repoPath,
+        onlyFiles: true,
+        absolute: true,
+        ignore: IGNORE_PATTERNS,
+    });
+    for (const file of expressFiles) {
+        const rel = toPosix(relative(repoPath, file));
+        const content = await readFile(file, 'utf8');
+        const routeRegex = /router\.(get|post|put|delete|patch)\s*\(\s*['"`]([^'"`]+)/gi;
+        for (const match of content.matchAll(routeRegex)) {
+            const method = match[1]?.toUpperCase();
+            const routePath = normalizeRoutePath(match[2] ?? '/');
+            routes.push({ path: routePath, file: rel, method });
+        }
+    }
+    const testFilePaths = await glob([
+        '**/*.spec.ts',
+        '**/*.test.ts',
+        '**/*.spec.tsx',
+        '**/*.test.tsx',
+        '**/cypress/e2e/**/*.ts',
+        '**/cypress/e2e/**/*.cy.ts',
+    ], {
+        cwd: repoPath,
+        onlyFiles: true,
+        absolute: true,
+        ignore: IGNORE_PATTERNS,
+    });
+    const testFiles = [];
+    for (const file of [...new Set(testFilePaths)]) {
+        const rel = toPosix(relative(repoPath, file));
+        const content = await readFile(file, 'utf8');
+        testFiles.push({
+            file: rel,
+            type: detectTestType(rel, content),
+            coveredPaths: extractCoveredPaths(content),
+        });
+    }
+    const cypressRoot = await glob(['cypress'], { cwd: repoPath, onlyDirectories: true, absolute: false, deep: 1 });
+    const e2eFolder = await glob(['cypress/e2e'], { cwd: repoPath, onlyDirectories: true, absolute: false, deep: 1 });
+    const componentFolder = await glob(['cypress/component'], { cwd: repoPath, onlyDirectories: true, absolute: false, deep: 1 });
+    const fixturesFolder = await glob(['cypress/fixtures'], { cwd: repoPath, onlyDirectories: true, absolute: false, deep: 1 });
+    const supportFolder = await glob(['cypress/support'], { cwd: repoPath, onlyDirectories: true, absolute: false, deep: 1 });
+    const commandsFile = await glob(['cypress/support/commands.ts'], { cwd: repoPath, onlyFiles: true, absolute: false });
+    const existingE2eFiles = await glob(['cypress/e2e/**/*.cy.ts'], { cwd: repoPath, onlyFiles: true, absolute: false });
+    const existingComponentFiles = await glob(['cypress/component/**/*.cy.tsx'], {
+        cwd: repoPath,
+        onlyFiles: true,
+        absolute: false,
+    });
+    const tsxFiles = await glob(['**/*.tsx'], {
+        cwd: repoPath,
+        onlyFiles: true,
+        absolute: true,
+        ignore: [...IGNORE_PATTERNS, '**/*.spec.tsx'],
+    });
+    const missingTestIds = [];
+    for (const file of tsxFiles) {
+        const rel = toPosix(relative(repoPath, file));
+        const content = await readFile(file, 'utf8');
+        const hasInteractive = content.includes('<button') || content.includes('<input') || content.includes('<a ');
+        if (hasInteractive && !content.includes('data-testid')) {
+            missingTestIds.push(rel);
+        }
+    }
+    return RepoAnalysisSchema.parse({
+        scannedAt: new Date().toISOString(),
+        repoPath,
+        routes,
+        testFiles,
+        missingTestIds: [...new Set(missingTestIds)],
+        cypressStructure: {
+            detected: cypressRoot.length > 0,
+            e2eFolder: e2eFolder[0],
+            componentFolder: componentFolder[0],
+            fixturesFolder: fixturesFolder[0],
+            supportFolder: supportFolder[0],
+            hasCommandsFile: commandsFile.length > 0,
+            existingE2eFiles,
+            existingComponentFiles,
+        },
+    });
+}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@qulib/core",
+  "version": "0.1.0",
+  "description": "Qulib — analyze deployed web apps for honest quality gaps (CLI + programmatic API)",
+  "license": "MIT",
+  "author": "Tapesh Nagarwal",
+  "homepage": "https://github.com/TapeshN/qulib#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TapeshN/qulib.git",
+    "directory": "packages/core"
+  },
+  "bugs": {
+    "url": "https://github.com/TapeshN/qulib/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "bin",
+    "README.md"
+  ],
+  "bin": {
+    "qulib": "./bin/qulib.js"
+  },
+  "scripts": {
+    "dev": "tsx src/cli/index.ts",
+    "analyze": "tsx src/cli/index.ts analyze",
+    "clean": "tsx src/cli/index.ts clean",
+    "build": "tsc"
+  },
+  "dependencies": {
+    "@axe-core/playwright": "^4.9.0",
+    "@playwright/test": "^1.44.0",
+    "commander": "^12.1.0",
+    "fast-glob": "^3.3.2",
+    "zod": "^3.23.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "tsx": "^4.11.0",
+    "typescript": "^5.4.0"
+  }
+}