josharsh/md-pdf-md

Add more helpful error messages for common CLI mistakes

Open

#2 opened on Oct 30, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (2 forks)auto 404
clienhancementgood first issuehelp wanted

Repository metrics

Stars
 (7 stars)
PR merge metrics
 (PR metrics pending)

Description

Make error messages more user-friendly when users make common mistakes.

Tasks:

  • Add specific error when file doesn't exist
  • Add hint when Ollama is not running (for PDF→MD)
  • Add suggestion when wrong file type is provided
  • Improve error formatting with colors (using chalk)

Files to modify:

  • src/cli.ts
  • src/converters/pdf-to-markdown.ts

Good First Issue: Simple TypeScript changes with clear requirements!

Contributor guide

Research direction
Examine src/cli.ts and src/converters/pdf to markdown.ts to identify where error messages are generated. Add specific checks: file existence, Ollama running status, file type validation. Use chalk for colored output.
Tech stack
typescript
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85