/**
* Spinner Utility Tests
*/
import {
describe,
it,
expect,
vi,
beforeEach,
afterEach,
beforeAll,
afterAll,
} from 'vitest';
describe('Spinner', () => {
let originalWrite: typeof process.stdout.write;
let writtenOutput: string[];
let originalMaxListeners: number;
beforeAll(() => {
// Increase max listeners to avoid warnings during tests
originalMaxListeners = process.getMaxListeners();
process.setMaxListeners(30);
});
afterAll(() => {
// Restore original max listeners
process.setMaxListeners(originalMaxListeners);
});
beforeEach(() => {
vi.resetModules();
vi.clearAllMocks();
vi.useFakeTimers();
// Capture stdout writes
writtenOutput = [];
originalWrite = process.stdout.write;
process.stdout.write = vi.fn((chunk: string | Uint8Array) => {
writtenOutput.push(chunk.toString());
return true;
}) as typeof process.stdout.write;
});
afterEach(() => {
vi.useRealTimers();
process.stdout.write = originalWrite;
});
describe('Spinner class', () => {
it('should create a spinner instance', async () => {
const { Spinner } = await import('../../src/utils/spinner.js');
const spinner = new Spinner('Loading...');
expect(spinner).toBeInstanceOf(Spinner);
});
it('should start and display spinning animation', async () => {
const { Spinner } = await import('../../src/utils/spinner.js');
const spinner = new Spinner('Loading...');
spinner.start();
// Advance time to trigger frame update
vi.advanceTimersByTime(80);
expect(writtenOutput.length).toBeGreaterThan(0);
// Should contain the text
expect(writtenOutput.some(output => output.includes('Loading...'))).toBe(
true
);
spinner.stop();
});
it('should hide cursor on start', async () => {
const { Spinner } = await import('../../src/utils/spinner.js');
const spinner = new Spinner('Test');
spinner.start();
// Should contain cursor hide sequence
expect(writtenOutput.some(output => output.includes('\x1B[?25l'))).toBe(
true
);
spinner.stop();
});
it('should show cursor on stop', async () => {
const { Spinner } = await import('../../src/utils/spinner.js');
const spinner = new Spinner('Test');
spinner.start();
spinner.stop();
// Should contain cursor show sequence
expect(writtenOutput.some(output => output.includes('\x1B[?25h'))).toBe(
true
);
});
it('should allow changing text on start', async () => {
const { Spinner } = await import('../../src/utils/spinner.js');
const spinner = new Spinner('Initial');
spinner.start('Updated text');
vi.advanceTimersByTime(80);
expect(
writtenOutput.some(output => output.includes('Updated text'))
).toBe(true);
spinner.stop();
});
it('should succeed with green checkmark', async () => {
const { Spinner } = await import('../../src/utils/spinner.js');
const spinner = new Spinner('Processing');
spinner.start();
spinner.succeed('Done!');
expect(writtenOutput.some(output => output.includes('Done!'))).toBe(true);
expect(writtenOutput.some(output => output.includes('✓'))).toBe(true);
});
it('should fail with red X', async () => {
const { Spinner } = await import('../../src/utils/spinner.js');
const spinner = new Spinner('Processing');
spinner.start();
spinner.fail('Error occurred');
expect(
writtenOutput.some(output => output.includes('Error occurred'))
).toBe(true);
expect(writtenOutput.some(output => output.includes('✗'))).toBe(true);
});
it('should show info with blue i', async () => {
const { Spinner } = await import('../../src/utils/spinner.js');
const spinner = new Spinner('Processing');
spinner.start();
spinner.info('Information');
expect(writtenOutput.some(output => output.includes('Information'))).toBe(
true
);
expect(writtenOutput.some(output => output.includes('ℹ'))).toBe(true);
});
it('should show warning with yellow symbol', async () => {
const { Spinner } = await import('../../src/utils/spinner.js');
const spinner = new Spinner('Processing');
spinner.start();
spinner.warn('Warning message');
expect(
writtenOutput.some(output => output.includes('Warning message'))
).toBe(true);
expect(writtenOutput.some(output => output.includes('⚠'))).toBe(true);
});
it('should return this for method chaining', async () => {
const { Spinner } = await import('../../src/utils/spinner.js');
const spinner = new Spinner('Test');
const startResult = spinner.start();
expect(startResult).toBe(spinner);
const stopResult = spinner.stop();
expect(stopResult).toBe(spinner);
});
it('should stop gracefully when called multiple times', async () => {
const { Spinner } = await import('../../src/utils/spinner.js');
const spinner = new Spinner('Test');
spinner.start();
spinner.stop();
spinner.stop(); // Should not throw
expect(true).toBe(true);
});
it('should cycle through animation frames', async () => {
const { Spinner } = await import('../../src/utils/spinner.js');
const spinner = new Spinner('Loading');
spinner.start();
// Advance through multiple frames
for (let i = 0; i < 10; i++) {
vi.advanceTimersByTime(80);
}
spinner.stop();
// Should have output multiple frames
expect(writtenOutput.length).toBeGreaterThan(5);
});
it('should use default success symbol and color', async () => {
const { Spinner } = await import('../../src/utils/spinner.js');
const spinner = new Spinner('Test');
spinner.start();
spinner.stop(); // Default stop uses ✓ and green
expect(writtenOutput.some(output => output.includes('✓'))).toBe(true);
});
it('should use custom symbol and color on stop', async () => {
const { Spinner } = await import('../../src/utils/spinner.js');
const spinner = new Spinner('Test');
spinner.start();
spinner.stop('★', 'yellow');
expect(writtenOutput.some(output => output.includes('★'))).toBe(true);
});
it('should clear output and restore cursor', async () => {
const { Spinner } = await import('../../src/utils/spinner.js');
const spinner = new Spinner('Clearing...');
spinner.start();
vi.advanceTimersByTime(80);
const clearResult = spinner.clear();
// Should return this for chaining
expect(clearResult).toBe(spinner);
// Should contain cursor show sequence after clear
expect(writtenOutput.some(output => output.includes('\x1B[?25h'))).toBe(
true
);
// Should contain line clear sequence
expect(writtenOutput.some(output => output.includes('\x1B[2K'))).toBe(
true
);
});
it('should handle clear when not running', async () => {
const { Spinner } = await import('../../src/utils/spinner.js');
const spinner = new Spinner('Test');
// Clear without starting should not throw
const result = spinner.clear();
expect(result).toBe(spinner);
});
it('should handle start with custom indent', async () => {
const { Spinner } = await import('../../src/utils/spinner.js');
const spinner = new Spinner('Indented');
spinner.start('Indented', 4);
vi.advanceTimersByTime(80);
// Output should contain spaces for indent
expect(
writtenOutput.some(
output => output.includes(' ') || output.includes('Indented')
)
).toBe(true);
spinner.stop();
});
it('should succeed without custom text', async () => {
const { Spinner } = await import('../../src/utils/spinner.js');
const spinner = new Spinner('Original');
spinner.start();
spinner.succeed(); // No custom text
expect(writtenOutput.some(output => output.includes('Original'))).toBe(
true
);
});
it('should fail without custom text', async () => {
const { Spinner } = await import('../../src/utils/spinner.js');
const spinner = new Spinner('Original');
spinner.start();
spinner.fail(); // No custom text
expect(writtenOutput.some(output => output.includes('Original'))).toBe(
true
);
});
it('should info without custom text', async () => {
const { Spinner } = await import('../../src/utils/spinner.js');
const spinner = new Spinner('Original');
spinner.start();
spinner.info(); // No custom text
expect(writtenOutput.some(output => output.includes('Original'))).toBe(
true
);
});
it('should warn without custom text', async () => {
const { Spinner } = await import('../../src/utils/spinner.js');
const spinner = new Spinner('Original');
spinner.start();
spinner.warn(); // No custom text
expect(writtenOutput.some(output => output.includes('Original'))).toBe(
true
);
});
it('should work with empty constructor', async () => {
const { Spinner } = await import('../../src/utils/spinner.js');
const spinner = new Spinner();
spinner.start('New text');
vi.advanceTimersByTime(80);
expect(writtenOutput.some(output => output.includes('New text'))).toBe(
true
);
spinner.stop();
});
});
});
