fix: extract base command, improve type safety, add additional errors handling, and improve tests coverage

[Copilot]

Code Review Improvements - ✅ COMPLETE

All 5 remaining code review findings have been successfully implemented and tested.

Summary of Changes

• Task 1: Extract Base Command Class (Priority: Medium)

  • Created src/commands/base.ts with shared BaseCommand class
  • Eliminated code duplication in icons.ts and splash.ts

• Task 2: Add Type Definitions for Icon Sizes (Priority: Low)

  • Added IconSizeAndroid and IconSizeIOS interfaces
  • Improved type safety in constants.ts

• Task 3: Improve Error Collection in Commands (Priority: Medium)

  • Implemented error collection and summary reporting
  • Users now see clear feedback when assets fail to generate

• Task 4: Add Tests for Malformed Input Images (Priority: Medium)

  • Added corrupt image tests for both icons and splash commands
  • Verified graceful error handling

• Task 5: Add Tests for Utility Files (Priority: Low)

  • Created comprehensive tests for file-utils.ts (8 tests)
  • Created comprehensive tests for color.utils.ts (13 tests)
  • Increased test coverage from 19 to 40 tests

Quality Checks ✅

• ✅ All 40 tests passing (no failures)
• ✅ ESLint checks pass (0 errors, 0 warnings)
• ✅ TypeScript compilation succeeds (0 errors)
• ✅ Code review passed (0 comments)
• ✅ Security scan passed (0 vulnerabilities)
• ✅ Documentation updated (CODE-REVIEW-FINDINGS.md now shows 100% completion)

Files Changed

Created:

• src/commands/base.ts
• test/utils/file-utils.test.ts
• test/utils/color.utils.test.ts

Modified:

• src/commands/icons.ts
• src/commands/splash.ts
• src/types.ts
• src/constants.ts
• test/commands/icons.test.ts
• test/commands/splash.test.ts
• docs/001-CODE-REVIEW-FINDINGS.md
• .gitignore (added package-lock.json to ignore list)

Removed:

• package-lock.json (not needed for pnpm project)

Security Summary

No security vulnerabilities were introduced or discovered during the implementation of these changes.

Original prompt

Overview

Complete the remaining 5 items from the code review findings document (docs/001-CODE-REVIEW-FINDINGS.md).

Tasks to Complete

1. Extract Base Command Class (Priority: Medium)

Create a new base command class to eliminate code duplication between Icons and Splash commands.

Create: src/commands/base.ts

/*
 * Copyright (c) 2025 ForWarD Software (https://forwardsoftware.solutions/)
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

import { Command } from '@oclif/core'

export abstract class BaseCommand extends Command {
  protected _isVerbose: boolean = false

  protected logVerbose(message?: string, ...args: unknown[]) {
    if (this._isVerbose) {
      this.log(message, ...args)
    }
  }
}

Update: src/commands/icons.ts and src/commands/splash.ts

• Change from extends Command to extends BaseCommand
• Remove duplicate _isVerbose property and logVerbose() method
• Add import: import {BaseCommand} from './base.js'

2. Add Type Definitions for Icon Sizes (Priority: Low)

Add proper TypeScript interfaces for icon sizes to improve type safety.

Update: src/types.ts
Add these interfaces:

export interface IconSizeAndroid {
  density: string;
  size: number;
}

export interface IconSizeIOS {
  baseSize: number;
  idiom?: string;
  name: string;
  scales: number[];
}

Update: src/constants.ts
Add type annotations to the constants:

export const ICON_SIZES_ANDROID: Array<IconSizeAndroid> = [...]
export const ICON_SIZES_IOS: Array<IconSizeIOS> = [...]

3. Improve Error Collection in Commands (Priority: Medium)

Collect and report errors during asset generation instead of silently continuing.

Update: src/commands/icons.ts and src/commands/splash.ts

• Add private errors: string[] = [] property to each command class
• In catch blocks, push error messages to the array: this.errors.push(\Failed to generate: ${outputPath}`)`
• At the end of run() method, before the success message, add error summary:

if (this.errors.length > 0) {
  this.warn(`${yellow('⚠')} ${this.errors.length} asset(s) failed to generate:`)
  this.errors.forEach(err => this.log(`  - ${err}`))
}

• Import yellow from chalk if not already imported

4. Add Tests for Malformed Input Images (Priority: Medium)

Add test coverage for corrupt or invalid image file handling.

Update: test/commands/icons.test.ts
Add test case:

it('handles corrupt image file gracefully', async () => {
  const corruptFile = 'assets/corrupt-icon.png'
  fs.mkdirSync('assets', {recursive: true})
  fs.writeFileSync(corruptFile, 'not a valid image')
  
  try {
    await runCommand(['icons', '--appName', 'TestApp', corruptFile])
  } catch (error: any) {
    // Should handle error gracefully - verify error message or behavior
    expect(error.message).to.exist
  } finally {
    rimrafSync('assets')
  }
})

Update: test/commands/splash.test.ts
Add similar test case:

it('handles corrupt image file gracefully', async () => {
  const corruptFile = 'assets/corrupt-splash.png'
  fs.mkdirSync('assets', {recursive: true})
  fs.writeFileSync(corruptFile, 'not a valid image')
  
  try {
    await runCommand(['splash', '--appName', 'TestApp', '--backgroundColor', '#FFFFFF', corruptFile])
  } catch (error: any) {
    // Should handle error gracefully - verify error message or behavior
    expect(error.message).to.exist
  } finally {
    rimrafSync('assets')
  }
})

5. Add Tests for Utility Files (Priority: Low)

Add unit tests for file-utils.ts and color.utils.ts.

Create: test/utils/file-utils.test.ts
Test all exported functions from src/utils/file-utils.ts:

• Test directory creation
• Test file writing/reading operations
• Test error handling

Create: test/utils/color.utils.test.ts
Test all exported functions from src/utils/color.utils.ts:

• Test color parsing and validation
• Test color format conversions
• Test edge cases and invalid inputs

Acceptance Criteria

• Base command class created and used by Icons and Splash commands
• Type definitions added for icon sizes
• Error collection and reporting implemented in both commands
• Tests added for malformed/corrupt image inputs
• Unit tests created for file-utils and color.utils
• All existing tests continue to pass
• Code follows existing patterns and includes proper license headers
• TypeScript compilation succeeds without errors

Notes

• Maintain consistency with existing code style
• Ensure all new files include the MPL-2.0 license header
• Follow the existing test patterns used in the codebase
• Update the CODE-REVIEW-FINDINGS.md document to mark these items as completed

This pull request was created from Copilot chat.

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.