Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 | 1x 1x 1x 12x 12x 12x 4x 4x 3x 3x 3x 3x 3x 3x 12x 11x 10x 12x 12x 12x 12x 156x 12x 12x 5x 5x 12x 19x 19x 1x 1x 1x 19x 19x 19x 19x 19x 19x 19x 1x 19x 18x 18x 54x 54x 18x 1x 19x 19x 19x 18x 19x 19x 19x 19x 17x 17x 2x 2x 2x 19x 19x 19x 4x 3x 2x 19x 19x 18x 18x 18x 18x 54x 18x 19x 18x 18x 18x 19x 19x 19x 19x 19x 19x 19x | // Copyright 2026 ForgeKit Contributors
// SPDX-License-Identifier: Apache-2.0
// https://github.com/SubhanshuMG/ForgeKit
import * as fs from 'fs';
import * as path from 'path';
import { ProjectAnalysis } from '../types';
export function analyzeProject(projectPath: string): ProjectAnalysis {
const analysis: ProjectAnalysis = {
name: path.basename(projectPath),
description: '',
packageManager: 'unknown',
scripts: {},
dependencies: [],
devDependencies: [],
hasTypeScript: false,
hasDocker: false,
hasCI: false,
entryPoints: [],
directories: [],
};
// Read package.json
const pkgPath = path.join(projectPath, 'package.json');
if (fs.existsSync(pkgPath)) {
try {
const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
analysis.name = pkg.name || analysis.name;
analysis.description = pkg.description || '';
analysis.scripts = pkg.scripts || {};
analysis.dependencies = Object.keys(pkg.dependencies || {});
analysis.devDependencies = Object.keys(pkg.devDependencies || {});
analysis.packageManager = 'npm';
} catch { /* ignore parse errors */ }
}
// Detect package manager
if (fs.existsSync(path.join(projectPath, 'pnpm-lock.yaml'))) analysis.packageManager = 'pnpm';
else if (fs.existsSync(path.join(projectPath, 'yarn.lock'))) analysis.packageManager = 'yarn';
else if (fs.existsSync(path.join(projectPath, 'Pipfile'))) analysis.packageManager = 'pip';
// Detect TypeScript
analysis.hasTypeScript = fs.existsSync(path.join(projectPath, 'tsconfig.json'));
// Detect Docker
analysis.hasDocker = fs.existsSync(path.join(projectPath, 'Dockerfile')) ||
fs.existsSync(path.join(projectPath, 'docker-compose.yml'));
// Detect CI
analysis.hasCI = fs.existsSync(path.join(projectPath, '.github', 'workflows'));
// Find entry points
const entryFiles = ['src/index.ts', 'src/index.js', 'src/main.ts', 'src/main.js', 'src/app.ts', 'src/app.js', 'index.ts', 'index.js', 'app.ts', 'app.js', 'main.py', 'app.py', 'main.go'];
analysis.entryPoints = entryFiles.filter(f => fs.existsSync(path.join(projectPath, f)));
// List top-level directories
try {
analysis.directories = fs.readdirSync(projectPath)
.filter(f => {
const fullPath = path.join(projectPath, f);
return fs.statSync(fullPath).isDirectory() && !f.startsWith('.') && f !== 'node_modules';
});
} catch { /* ignore */ }
return analysis;
}
function detectFramework(analysis: ProjectAnalysis): string {
const allDeps = [...analysis.dependencies, ...analysis.devDependencies];
if (allDeps.includes('next')) return 'Next.js';
Iif (allDeps.includes('react')) return 'React';
Iif (allDeps.includes('vue')) return 'Vue.js';
if (allDeps.includes('express')) return 'Express';
Iif (allDeps.includes('fastify')) return 'Fastify';
Iif (allDeps.includes('nestjs')) return 'NestJS';
Iif (analysis.packageManager === 'pip') return 'Python';
return '';
}
function generateBadges(analysis: ProjectAnalysis): string {
const badges: string[] = [];
const framework = detectFramework(analysis);
if (analysis.hasTypeScript) {
badges.push('');
}
if (framework) {
badges.push(`}-black?logo=${framework.toLowerCase().replace('.', '')})`);
}
if (analysis.hasDocker) {
badges.push('');
}
return badges.join(' ');
}
function generateTree(dirs: string[]): string {
Iif (dirs.length === 0) return '';
const lines = dirs.map((d, i) => {
const prefix = i === dirs.length - 1 ? '\u2514\u2500\u2500' : '\u251c\u2500\u2500';
return `${prefix} ${d}/`;
});
return '```\n' + lines.join('\n') + '\n```';
}
export function generateReadme(analysis: ProjectAnalysis): string {
const sections: string[] = [];
// Title
sections.push(`# ${analysis.name}\n`);
// Description
if (analysis.description) {
sections.push(`${analysis.description}\n`);
}
// Badges
const badges = generateBadges(analysis);
if (badges) sections.push(`${badges}\n`);
// Prerequisites
sections.push('## Prerequisites\n');
if (analysis.packageManager === 'npm' || analysis.packageManager === 'yarn' || analysis.packageManager === 'pnpm') {
sections.push('- Node.js >= 18');
sections.push(`- ${analysis.packageManager}\n`);
} else if (analysis.packageManager === 'pip') {
sections.push('- Python >= 3.8');
sections.push('- pip\n');
}
// Installation
sections.push('## Installation\n');
sections.push('```bash');
if (analysis.packageManager === 'npm') sections.push('npm install');
else if (analysis.packageManager === 'yarn') sections.push('yarn install');
else if (analysis.packageManager === 'pnpm') sections.push('pnpm install');
else if (analysis.packageManager === 'pip') sections.push('pip install -r requirements.txt');
sections.push('```\n');
// Scripts
if (Object.keys(analysis.scripts).length > 0) {
sections.push('## Available Scripts\n');
sections.push('| Script | Command |');
sections.push('|--------|---------|');
for (const [name, cmd] of Object.entries(analysis.scripts)) {
sections.push(`| \`${analysis.packageManager} run ${name}\` | ${cmd} |`);
}
sections.push('');
}
// Project structure
if (analysis.directories.length > 0) {
sections.push('## Project Structure\n');
sections.push(generateTree(analysis.directories));
sections.push('');
}
// Environment variables
const envExamplePath = path.join(process.cwd(), '.env.example');
Iif (fs.existsSync(envExamplePath)) {
sections.push('## Environment Variables\n');
sections.push('Copy `.env.example` to `.env` and fill in the values:\n');
sections.push('```bash');
sections.push('cp .env.example .env');
sections.push('```\n');
}
// License
sections.push('## License\n');
sections.push('See [LICENSE](LICENSE) for details.\n');
// Generated footer
sections.push('---\n');
sections.push('*Generated with [ForgeKit](https://github.com/SubhanshuMG/ForgeKit)*\n');
return sections.join('\n');
}
|