TypeScript Rewrite: Info command

src/cli.ts

@@ -1,9 +1,11 @@
 import { createApp } from './app.js';
 import { registerHelpCommand } from './commands/help.js';
+import { registerInfoCommand } from './commands/info.js';
 
 const program = createApp();
 
 registerHelpCommand(program);
+registerInfoCommand(program);
 
 program.parseAsync(process.argv).catch((err) => {
   console.error(err instanceof Error ? err.message : String(err));

src/commands/info.ts

@@ -0,0 +1,71 @@
+import type { Command } from 'commander';
+import chalk from 'chalk';
+import fs from 'fs-extra';
+import path from 'node:path';
+import { getConfig } from '../config.js';
+import { PUP_VERSION } from '../app.js';
+import * as output from '../utils/output.js';
+
+/**
+ * Registers the `info` command with the CLI program.
+ *
+ * @since TBD
+ *
+ * @param {Command} program - The Commander.js program instance.
+ *
+ * @returns {void}
+ */
+export function registerInfoCommand(program: Command): void {
+  program
+    .command('info')
+    .description('Gets pup details for the current project.')
+    .action(async () => {
+      const config = getConfig();
+      const workingDir = config.getWorkingDir();
+
+      output.title('CLI Info');
+      output.log(`pup ${PUP_VERSION}`);
+
+      // Node.js version
+      output.log(`Using: Node.js ${process.version}`);
+
+      output.section('Working Directory');
+      output.log(workingDir);
+
+      output.section('File info');
+
+      const files = ['.distignore', '.distinclude', '.gitattributes', '.puprc'];
+
+      const filesError: string[] = [];
+      const filesExist: string[] = [];
+      const filesAbsent: string[] = [];
+
+      for (const file of files) {
+        const filePath = path.join(workingDir, file);
+        const exists = await fs.pathExists(filePath);
+        const styledFile = chalk.cyan(file);
+
+        if (exists && file === '.puprc') {
+          try {
+            const contents = await fs.readFile(filePath, 'utf-8');
+            JSON.parse(contents);
+            filesExist.push(`✅ ${styledFile} - ${chalk.green('exists')}`);
+          } catch (e) {
+            const reason = e instanceof SyntaxError ? e.message : String(e);
+            filesError.push(`❌ ${styledFile} - ${chalk.green('exists')} but could not be parsed: ${reason}`);
+          }
+        } else if (exists) {
+          filesExist.push(`✅ ${styledFile} - ${chalk.green('exists')}`);
+        } else {
+          filesAbsent.push(`⚫ ${styledFile} - does not exist`);
+        }
+      }
+
+      for (const line of filesError) output.log(line);
+      for (const line of filesExist) output.log(line);
+      for (const line of filesAbsent) output.log(line);
+
+      output.section('Config');
+      output.log(JSON.stringify(config.toJSON(), null, 2));
+    });
+}

src/utils/output.ts

@@ -95,7 +95,7 @@ export function info(message: string): void {
 }
 
 /**
- * Prints a bold title with an underline rule.
+ * Prints a yellow title with an underline rule.
  *
  * @since TBD
  *
@@ -105,13 +105,13 @@ export function info(message: string): void {
  */
 export function title(message: string): void {
   console.log('');
-  console.log(formatMessage(chalk.bold(message)));
-  console.log(formatMessage(chalk.bold('='.repeat(message.length))));
+  console.log(formatMessage(chalk.yellow(message)));
+  console.log(formatMessage(chalk.yellow('='.repeat(message.length))));
   console.log('');
 }
 
 /**
- * Prints a bold yellow section header.
+ * Prints a yellow section header.
  *
  * @since TBD
  *
@@ -121,8 +121,8 @@ export function title(message: string): void {
  */
 export function section(message: string): void {
   console.log('');
-  console.log(formatMessage(chalk.bold.yellow(message)));
-  console.log(formatMessage(chalk.bold.yellow('-'.repeat(message.length))));
+  console.log(formatMessage(chalk.yellow(message)));
+  console.log(formatMessage(chalk.yellow('-'.repeat(message.length))));
   console.log('');
 }
 

tests/commands/info.test.ts

@@ -0,0 +1,202 @@
+import fs from 'fs-extra';
+import path from 'node:path';
+import {
+  runPup,
+  writePuprc,
+  getPuprc,
+  createTempProject,
+  cleanupTempProjects,
+} from '../helpers/setup.js';
+
+describe('info command', () => {
+  let projectDir: string;
+
+  beforeEach(() => {
+    projectDir = createTempProject();
+    writePuprc(getPuprc(), projectDir);
+  });
+
+  afterEach(() => {
+    cleanupTempProjects();
+  });
+
+  it('should exit with code 0', async () => {
+    const result = await runPup('info', { cwd: projectDir });
+    expect(result.exitCode).toBe(0);
+  });
+
+  describe('CLI Info section', () => {
+    it('should display the CLI Info title with underline', async () => {
+      const result = await runPup('info', { cwd: projectDir });
+      expect(result.stdout).toContain('CLI Info');
+      expect(result.stdout).toContain('='.repeat('CLI Info'.length));
+    });
+
+    it('should display the pup version', async () => {
+      const result = await runPup('info', { cwd: projectDir });
+      expect(result.stdout).toMatch(/pup \d+\.\d+\.\d+/);
+    });
+
+    it('should display the Node.js version', async () => {
+      const result = await runPup('info', { cwd: projectDir });
+      expect(result.stdout).toMatch(/Using: Node\.js v\d+/);
+    });
+  });
+
+  describe('Working Directory section', () => {
+    it('should display the Working Directory section header', async () => {
+      const result = await runPup('info', { cwd: projectDir });
+      expect(result.stdout).toContain('Working Directory');
+      expect(result.stdout).toContain('-'.repeat('Working Directory'.length));
+    });
+
+    it('should display the working directory path', async () => {
+      const result = await runPup('info', { cwd: projectDir });
+      expect(result.stdout).toContain(projectDir);
+    });
+  });
+
+  describe('File info section', () => {
+    it('should display the File info section header', async () => {
+      const result = await runPup('info', { cwd: projectDir });
+      expect(result.stdout).toContain('File info');
+      expect(result.stdout).toContain('-'.repeat('File info'.length));
+    });
+
+    it('should list all four tracked files', async () => {
+      const result = await runPup('info', { cwd: projectDir });
+      expect(result.stdout).toContain('.distignore');
+      expect(result.stdout).toContain('.distinclude');
+      expect(result.stdout).toContain('.gitattributes');
+      expect(result.stdout).toContain('.puprc');
+    });
+
+    describe('when no optional files exist', () => {
+      beforeEach(() => {
+        // Remove .puprc so all files are absent
+        fs.removeSync(path.join(projectDir, '.puprc'));
+      });
+
+      it('should show absent icon for all files', async () => {
+        const result = await runPup('info', { cwd: projectDir });
+        const lines = result.stdout.split('\n');
+        const fileLines = lines.filter((l) => /\.(distignore|distinclude|gitattributes|puprc)/.test(l));
+
+        for (const line of fileLines) {
+          expect(line).toContain('⚫');
+          expect(line).toContain('does not exist');
+        }
+      });
+    });
+
+    describe('when .puprc exists and is valid', () => {
+      it('should show exists icon for .puprc', async () => {
+        const result = await runPup('info', { cwd: projectDir });
+        const puprcLine = result.stdout.split('\n').find((l) => l.includes('.puprc'));
+        expect(puprcLine).toContain('✅');
+        expect(puprcLine).toContain('exists');
+      });
+    });
+
+    describe('when .puprc exists but is invalid JSON', () => {
+      beforeEach(() => {
+        fs.writeFileSync(path.join(projectDir, '.puprc'), 'not valid json {{{');
+      });
+
+      it('should show error icon for .puprc', async () => {
+        const result = await runPup('info', { cwd: projectDir });
+        const puprcLine = result.stdout.split('\n').find((l) => l.includes('.puprc'));
+        expect(puprcLine).toContain('❌');
+        expect(puprcLine).toContain('could not be parsed');
+      });
+
+      it('should include the parse error reason', async () => {
+        const result = await runPup('info', { cwd: projectDir });
+        const puprcLine = result.stdout.split('\n').find((l) => l.includes('.puprc'));
+        expect(puprcLine).toMatch(/could not be parsed:.+/);
+      });
+    });
+
+    describe('when .distignore exists', () => {
+      beforeEach(() => {
+        fs.writeFileSync(path.join(projectDir, '.distignore'), '*.test.js\n');
+      });
+
+      it('should show exists icon for .distignore', async () => {
+        const result = await runPup('info', { cwd: projectDir });
+        const line = result.stdout.split('\n').find((l) => l.includes('.distignore'));
+        expect(line).toContain('✅');
+        expect(line).toContain('exists');
+      });
+    });
+
+    describe('when .distinclude exists', () => {
+      beforeEach(() => {
+        fs.writeFileSync(path.join(projectDir, '.distinclude'), 'vendor/\n');
+      });
+
+      it('should show exists icon for .distinclude', async () => {
+        const result = await runPup('info', { cwd: projectDir });
+        const line = result.stdout.split('\n').find((l) => l.includes('.distinclude'));
+        expect(line).toContain('✅');
+        expect(line).toContain('exists');
+      });
+    });
+
+    describe('when .gitattributes exists', () => {
+      beforeEach(() => {
+        fs.writeFileSync(path.join(projectDir, '.gitattributes'), '*.php diff=php\n');
+      });
+
+      it('should show exists icon for .gitattributes', async () => {
+        const result = await runPup('info', { cwd: projectDir });
+        const line = result.stdout.split('\n').find((l) => l.includes('.gitattributes'));
+        expect(line).toContain('✅');
+        expect(line).toContain('exists');
+      });
+    });
+
+    describe('file ordering', () => {
+      it('should show error files before existing files', async () => {
+        // Write an invalid .puprc and a valid .distignore
+        fs.writeFileSync(path.join(projectDir, '.puprc'), '{invalid');
+        fs.writeFileSync(path.join(projectDir, '.distignore'), '*.test.js\n');
+
+        const result = await runPup('info', { cwd: projectDir });
+        const lines = result.stdout.split('\n');
+        const errorIdx = lines.findIndex((l) => l.includes('❌'));
+        const existIdx = lines.findIndex((l) => l.includes('✅'));
+
+        expect(errorIdx).toBeGreaterThan(-1);
+        expect(existIdx).toBeGreaterThan(-1);
+        expect(errorIdx).toBeLessThan(existIdx);
+      });
+
+      it('should show existing files before absent files', async () => {
+        const result = await runPup('info', { cwd: projectDir });
+        const lines = result.stdout.split('\n');
+        const existIdx = lines.findIndex((l) => l.includes('✅'));
+        const absentIdx = lines.findIndex((l) => l.includes('⚫'));
+
+        expect(existIdx).toBeGreaterThan(-1);
+        expect(absentIdx).toBeGreaterThan(-1);
+        expect(existIdx).toBeLessThan(absentIdx);
+      });
+    });
+  });
+
+  describe('Config section', () => {
+    it('should display the Config section header', async () => {
+      const result = await runPup('info', { cwd: projectDir });
+      expect(result.stdout).toContain('Config');
+      expect(result.stdout).toContain('-'.repeat('Config'.length));
+    });
+
+    it('should display config as formatted JSON', async () => {
+      const result = await runPup('info', { cwd: projectDir });
+      // The config JSON should contain key fields from .puprc
+      expect(result.stdout).toContain('"zip_name"');
+      expect(result.stdout).toContain('"build"');
+    });
+  });
+});