package-detector
Version:
A fast and comprehensive Node.js CLI tool to analyze your project's package.json and detect various package-related issues
196 lines (195 loc) ā¢ 8.36 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
const reporter_1 = require("../src/reporter");
jest.mock('chalk', () => {
return {
red: jest.fn((text) => text),
green: jest.fn((text) => text),
blue: jest.fn((text) => text),
yellow: jest.fn((text) => text),
magenta: jest.fn((text) => text),
cyan: jest.fn((text) => text),
gray: jest.fn((text) => text)
};
});
describe('Reporter', () => {
let reporter;
beforeEach(() => {
reporter = new reporter_1.Reporter();
jest.clearAllMocks();
});
describe('Result Management', () => {
it('should add single result', () => {
const result = {
type: 'unused',
packageName: 'test-package',
message: 'Test message',
severity: 'medium'
};
reporter.addResult(result);
const results = reporter.getResults();
expect(results).toHaveLength(1);
expect(results[0]).toEqual(result);
});
it('should add multiple results', () => {
const results = [
{
type: 'unused',
packageName: 'package1',
message: 'Message 1',
severity: 'low'
},
{
type: 'outdated',
packageName: 'package2',
message: 'Message 2',
severity: 'high'
}
];
reporter.addResults(results);
const storedResults = reporter.getResults();
expect(storedResults).toHaveLength(2);
expect(storedResults).toEqual(results);
});
it('should clear results', () => {
const result = {
type: 'unused',
packageName: 'test-package',
message: 'Test message',
severity: 'medium'
};
reporter.addResult(result);
expect(reporter.getResults()).toHaveLength(1);
reporter.clearResults();
expect(reporter.getResults()).toHaveLength(0);
});
it('should return copy of results', () => {
const result = {
type: 'unused',
packageName: 'test-package',
message: 'Test message',
severity: 'medium'
};
reporter.addResult(result);
const results = reporter.getResults();
// Modify the returned array
results.push({
type: 'outdated',
packageName: 'another-package',
message: 'Another message',
severity: 'high'
});
// Original results should not be affected
expect(reporter.getResults()).toHaveLength(1);
});
});
describe('Output Methods', () => {
beforeEach(() => {
jest.clearAllMocks();
});
it('should print header', () => {
reporter.printHeader();
expect(console.log).toHaveBeenCalledWith('\nš Package Detector Analysis Report');
expect(console.log).toHaveBeenCalledWith('='.repeat(50));
});
it('should print help', () => {
reporter.printHelp();
expect(console.log).toHaveBeenCalledWith('\nš Package Detector Usage:');
expect(console.log).toHaveBeenCalledWith(' npx package-detector [options]');
});
it('should print error message', () => {
const errorMessage = 'Test error message';
reporter.printError(errorMessage);
expect(console.log).toHaveBeenCalledWith(`ā Error: ${errorMessage}`);
});
it('should print warning message', () => {
const warningMessage = 'Test warning message';
reporter.printWarning(warningMessage);
expect(console.log).toHaveBeenCalledWith(`ā ļø Warning: ${warningMessage}`);
});
it('should print info message', () => {
const infoMessage = 'Test info message';
reporter.printInfo(infoMessage);
expect(console.log).toHaveBeenCalledWith(`ā¹ļø Info: ${infoMessage}`);
});
it('should print success message', () => {
const successMessage = 'Test success message';
reporter.printSuccess(successMessage);
expect(console.log).toHaveBeenCalledWith(`ā
${successMessage}`);
});
});
describe('Results Display', () => {
beforeEach(() => {
jest.clearAllMocks();
});
it('should display no issues when no results', () => {
reporter.printResults();
expect(console.log).toHaveBeenCalledWith('ā
No issues detected! Your package.json looks clean.');
});
it('should display unused packages', () => {
const consoleSpy = jest.spyOn(console, 'log').mockImplementation();
reporter.addResult({
type: 'unused',
packageName: 'unused-package',
message: 'Not imported anywhere'
});
reporter.printResults();
expect(console.log).toHaveBeenCalledWith('\nā Truly Unused Packages:');
expect(console.log).toHaveBeenCalledWith(' ā¢ unused-package - Not imported anywhere');
consoleSpy.mockRestore();
});
it('should display outdated packages', () => {
const outdatedResult = {
type: 'outdated',
packageName: 'outdated-package',
message: 'Current: 1.0.0, Latest: 2.0.0',
severity: 'high'
};
reporter.addResult(outdatedResult);
reporter.printResults();
expect(console.log).toHaveBeenCalledWith('\nā ļø Outdated Packages:');
expect(console.log).toHaveBeenCalledWith(' ā¢ outdated-package - Current: 1.0.0, Latest: 2.0.0');
});
it('should display duplicate packages', () => {
const duplicateResult = {
type: 'duplicate',
packageName: 'duplicate-package',
message: 'Multiple versions found',
severity: 'medium'
};
reporter.addResult(duplicateResult);
reporter.printResults();
expect(console.log).toHaveBeenCalledWith('\nš” Duplicate Packages:');
expect(console.log).toHaveBeenCalledWith(' ā¢ duplicate-package - Multiple versions found');
});
it('should display heavy packages', () => {
const heavyResult = {
type: 'heavy',
packageName: 'heavy-package',
message: 'Large package: 500 KB',
severity: 'high'
};
reporter.addResult(heavyResult);
reporter.printResults();
expect(console.log).toHaveBeenCalledWith('\nšļø Heavy Packages:');
expect(console.log).toHaveBeenCalledWith(' ā¢ heavy-package - Large package: 500 KB');
});
it('should display summary with correct counts', () => {
const results = [
{ type: 'unused', packageName: 'p1', message: 'msg1', severity: 'low' },
{ type: 'unused', packageName: 'p2', message: 'msg2', severity: 'medium' },
{ type: 'outdated', packageName: 'p3', message: 'msg3', severity: 'high' },
{ type: 'duplicate', packageName: 'p4', message: 'msg4', severity: 'medium' },
{ type: 'heavy', packageName: 'p5', message: 'msg5', severity: 'high' }
];
reporter.addResults(results);
reporter.printResults();
expect(console.log).toHaveBeenCalledWith('š Summary:');
expect(console.log).toHaveBeenCalledWith(' Total issues found: 5');
expect(console.log).toHaveBeenCalledWith(' Truly unused packages: 2');
expect(console.log).toHaveBeenCalledWith(' Outdated packages: 1');
expect(console.log).toHaveBeenCalledWith(' Duplicate packages: 1');
expect(console.log).toHaveBeenCalledWith(' Heavy packages: 1');
});
});
});