repomix
Version:
A tool to pack repository contents to single file for AI consumption
166 lines (165 loc) • 8.55 kB
JavaScript
import path from 'node:path';
import pc from 'picocolors';
import { logger } from '../shared/logger.js';
import { reportTokenCountTree } from './reporters/tokenCountTreeReporter.js';
export const getDisplayPath = (absolutePath, cwd) => {
return absolutePath.startsWith(cwd) ? path.relative(cwd, absolutePath) : absolutePath;
};
export const reportResults = (cwd, packResult, config, options = {}) => {
logger.log('');
if (config.output.topFilesLength > 0) {
reportTopFiles(packResult.fileCharCounts, packResult.fileTokenCounts, config.output.topFilesLength, packResult.totalTokens);
logger.log('');
}
if (config.output.tokenCountTree) {
reportTokenCountTree(packResult.processedFiles, packResult.fileTokenCounts, config);
logger.log('');
}
reportSecurityCheck(cwd, packResult.suspiciousFilesResults, packResult.suspiciousGitDiffResults, packResult.suspiciousGitLogResults, config);
logger.log('');
reportSkippedFiles(cwd, packResult.skippedFiles);
logger.log('');
reportSummary(cwd, packResult, config, options);
logger.log('');
reportCompletion();
};
export const reportSummary = (cwd, packResult, config, options = {}) => {
let securityCheckMessage = '';
if (config.security.enableSecurityCheck) {
if (packResult.suspiciousFilesResults.length > 0) {
securityCheckMessage = pc.yellow(`${packResult.suspiciousFilesResults.length.toLocaleString()} suspicious file(s) detected and excluded`);
}
else {
securityCheckMessage = '✔ No suspicious files detected';
}
}
else {
securityCheckMessage = pc.dim('Security check disabled');
}
logger.log('📊 Pack Summary:');
logger.log(pc.dim('────────────────'));
logger.log(` Total Files: ${packResult.totalFiles.toLocaleString()} files`);
logger.log(` Total Tokens: ${packResult.totalTokens.toLocaleString()} tokens`);
logger.log(` Total Chars: ${packResult.totalCharacters.toLocaleString()} chars`);
if (config.skillGenerate !== undefined && options.skillDir) {
const displayPath = getDisplayPath(options.skillDir, cwd);
logger.log(` Output: ${displayPath} ${pc.dim('(skill directory)')}`);
}
else {
if (packResult.outputFiles && packResult.outputFiles.length > 0) {
const first = packResult.outputFiles[0];
const last = packResult.outputFiles[packResult.outputFiles.length - 1];
const firstDisplayPath = getDisplayPath(path.resolve(cwd, first), cwd);
const lastDisplayPath = getDisplayPath(path.resolve(cwd, last), cwd);
logger.log(` Output: ${firstDisplayPath} ${pc.dim('…')} ${lastDisplayPath} ${pc.dim(`(${packResult.outputFiles.length} parts)`)}`);
}
else {
const outputPath = path.resolve(cwd, config.output.filePath);
const displayPath = getDisplayPath(outputPath, cwd);
logger.log(` Output: ${displayPath}`);
}
}
logger.log(` Security: ${securityCheckMessage}`);
if (config.output.git?.includeDiffs) {
let gitDiffsMessage = '';
if (packResult.gitDiffTokenCount) {
gitDiffsMessage = `✔ Git diffs included ${pc.dim(`(${packResult.gitDiffTokenCount.toLocaleString()} tokens)`)}`;
}
else {
gitDiffsMessage = pc.dim('✖ No git diffs included');
}
logger.log(` Git Diffs: ${gitDiffsMessage}`);
}
if (config.output.git?.includeLogs) {
let gitLogsMessage = '';
if (packResult.gitLogTokenCount) {
gitLogsMessage = `✔ Git logs included ${pc.dim(`(${packResult.gitLogTokenCount.toLocaleString()} tokens)`)}`;
}
else {
gitLogsMessage = pc.dim('✖ No git logs included');
}
logger.log(` Git Logs: ${gitLogsMessage}`);
}
};
export const reportSecurityCheck = (rootDir, suspiciousFilesResults, suspiciousGitDiffResults, suspiciousGitLogResults, config) => {
if (!config.security.enableSecurityCheck) {
return;
}
logger.log('🔎 Security Check:');
logger.log(pc.dim('──────────────────'));
if (suspiciousFilesResults.length === 0) {
logger.log(`${pc.green('✔')} No suspicious files detected.`);
}
else {
logger.log(pc.yellow(`${suspiciousFilesResults.length} suspicious file(s) detected and excluded from the output:`));
suspiciousFilesResults.forEach((suspiciousFilesResult, index) => {
const relativeFilePath = path.relative(rootDir, suspiciousFilesResult.filePath);
const indexString = `${index + 1}.`.padEnd(3, ' ');
logger.log(`${indexString}${relativeFilePath}`);
const issueCount = suspiciousFilesResult.messages.length;
const issueText = issueCount === 1 ? 'security issue' : 'security issues';
logger.log(pc.dim(` - ${issueCount} ${issueText} detected`));
});
logger.log(pc.yellow('\nThese files have been excluded from the output for security reasons.'));
logger.log(pc.yellow('Please review these files for potential sensitive information.'));
}
reportSuspiciousGitContent('Git diffs', suspiciousGitDiffResults);
reportSuspiciousGitContent('Git logs', suspiciousGitLogResults);
};
const reportSuspiciousGitContent = (title, results) => {
if (results.length === 0) {
return;
}
logger.log('');
logger.log(pc.yellow(`${results.length} security issue(s) found in ${title}:`));
results.forEach((suspiciousResult, index) => {
const indexString = `${index + 1}.`.padEnd(3, ' ');
logger.log(`${indexString}${suspiciousResult.filePath}`);
const issueCount = suspiciousResult.messages.length;
const issueText = issueCount === 1 ? 'security issue' : 'security issues';
logger.log(pc.dim(` - ${issueCount} ${issueText} detected`));
});
logger.log(pc.yellow(`\nNote: ${title} with security issues are still included in the output.`));
logger.log(pc.yellow(`Please review the ${title.toLowerCase()} before sharing the output.`));
};
export const reportTopFiles = (fileCharCounts, fileTokenCounts, topFilesLength, totalTokens) => {
const topFilesLengthStrLen = topFilesLength.toString().length;
logger.log(`📈 Top ${topFilesLength} Files by Token Count:`);
logger.log(pc.dim(`─────────────────────────────${'─'.repeat(topFilesLengthStrLen)}`));
const filesWithTokenCounts = Object.entries(fileTokenCounts)
.filter(([, tokenCount]) => tokenCount > 0)
.sort((a, b) => b[1] - a[1])
.slice(0, topFilesLength);
filesWithTokenCounts.forEach(([filePath, tokenCount], index) => {
const charCount = fileCharCounts[filePath];
const percentageOfTotal = totalTokens > 0 ? Number(((tokenCount / totalTokens) * 100).toFixed(1)) : 0;
const indexString = `${index + 1}.`.padEnd(3, ' ');
logger.log(`${indexString} ${filePath} ${pc.dim(`(${tokenCount.toLocaleString()} tokens, ${charCount.toLocaleString()} chars, ${percentageOfTotal}%)`)}`);
});
};
export const reportSkippedFiles = (_rootDir, skippedFiles) => {
const binaryContentFiles = skippedFiles.filter((file) => file.reason === 'binary-content');
if (binaryContentFiles.length === 0) {
return;
}
logger.log('📄 Binary Files Detected:');
logger.log(pc.dim('─────────────────────────'));
if (binaryContentFiles.length === 1) {
logger.log(pc.yellow('1 file detected as binary by content inspection:'));
}
else {
logger.log(pc.yellow(`${binaryContentFiles.length} files detected as binary by content inspection:`));
}
binaryContentFiles.forEach((file, index) => {
const indexString = `${index + 1}.`.padEnd(3, ' ');
logger.log(`${indexString}${file.path}`);
});
logger.log(pc.yellow('\nThese files have been excluded from the output.'));
logger.log(pc.yellow('Please review these files if you expected them to contain text content.'));
};
export const reportCompletion = () => {
logger.log(pc.green('🎉 All Done!'));
logger.log('Your repository has been successfully packed.');
logger.log('');
logger.log(`💡 Repomix is now available in your browser! Try it at ${pc.underline('https://repomix.com')}`);
};