> pmpt

readme-doctor

⭐ Pioneer ⚡ Active 📝 Documented
@Raunplaymore (10 projects) · 6 steps · 36.0 KB · 2026-02-25

Score README quality (0-100), detect missing sections, generate fix patches

#cli#readme#documentation#linter#quality

Clone via terminal:

pmpt clone readme-doctor
1

Starting Prompt

This single prompt is where the project began.

readme-doctor — Product Development Request

What I Want to Build

A CLI tool that scores README quality (0-100), detects missing/weak sections, generates improvement suggestions, and produces unified diff patches that can be applied with --write. Supports CI integration with --min-score and --strict flags.

Additional Context

Zero-cost tool. No server, no API, no database. Pure local analysis. Should work on any README.md in any project. Target: open-source maintainers, individual developers, and team leads who want consistent README quality.

Key Features

  • README score calculation (0-100)
  • Missing/weak section detection
  • Improvement suggestion generation
  • Unified diff patch generation (--write to apply)
  • CI failure conditions (--min-score, --strict)

Tech Stack Preferences

Node.js, TypeScript, commander, picocolors

Please help me build this product based on the requirements above.

  1. First, review the requirements and ask if anything is unclear.
  2. Propose a technical architecture.
  3. Outline the implementation steps.
  4. Start coding from the first step.

I'll confirm progress at each step before moving to the next.

Documentation Rule

Important: When you make progress, update .pmpt/docs/pmpt.md (the human-facing project document) at these moments:

  • When architecture or tech decisions are finalized
  • When a feature is implemented (mark as done)
  • When a development phase is completed
  • When requirements change or new decisions are made

Keep the Progress and Snapshot Log sections in pmpt.md up to date. After significant milestones, run pmpt save to create a snapshot.

2

Project Plan

The development plan AI organized from the prompt.

Idea
A CLI tool that scores README quality (0-100), detects missing/weak sections, generates improvement suggestions, and produces unified diff patches that can be applied with --write. Supports CI integration with --min-score and --strict flags.
Core Features
README score calculation (0-100); Missing/weak section detection; Improvement suggestion generation; Unified diff patch generation (--write to apply); CI failure conditions (--min-score, --strict)
Tech Stack
Node.js, TypeScript, commander, picocolors
3

Development Journey

A summary of 6 snapshots recorded during AI development. Clone the project to explore the full history.

v6 2026:02:25 0ff041c

README & Documentation

  • · Added comprehensive README.md with installation, usage, scoring breakdown, CI examples
  • · Badges: Node.js version, MIT license
  • · Contributing guide with fork/PR workflow
  • · Self-documenting: readme-doctor can now score its own README
Detail

readme-doctor

Product Idea

A CLI tool that scores README quality (0-100), detects missing/weak sections, generates improvement suggestions, and produces unified diff patches that can be applied with --write. Supports CI integration with --min-score and --strict flags.

Additional Context

Zero-cost tool. No server, no API, no database. Pure local analysis. Should work on any README.md in any project. Target: open-source maintainers, individual developers, and team leads who want consistent README quality.

Features

  • README score calculation (0-100)
  • Missing/weak section detection
  • Improvement suggestion generation
  • Unified diff patch generation (--write to apply)
  • CI failure conditions (--min-score, --strict)

Tech Stack

Node.js, TypeScript, commander, picocolors

Progress

  • Project setup
  • Core features implementation
  • Testing & polish

Snapshot Log

v6 - README & Documentation

  • Added comprehensive README.md with installation, usage, scoring breakdown, CI examples
  • Badges: Node.js version, MIT license
  • Contributing guide with fork/PR workflow
  • Self-documenting: readme-doctor can now score its own README

v5 - CI & Improvements

  • --min-score and --strict CI flags tested and working (exit code 1 on failure)
  • Default command: readme-doctor = readme-doctor check (no subcommand needed)
  • Description detection: recognizes text under H1 title as description (no separate ## needed)
  • pmpt CLI README scored: 65 → 80 (A grade) after description detection improvement

v4 - CLI Commands (check + fix)

  • check command: score display with colored output, per-item breakdown
  • fix command: generate unified diff patches for missing sections
  • --write flag: apply patches directly to README
  • --file flag: specify custom README path
  • patcher.ts: auto-generate section templates (Description, Installation, Usage, License, Contributing)

v3 - Core Scoring Logic

  • parser.ts: README markdown parsing (sections, headings, code blocks, badges)
  • scorer.ts: 100-point scoring system with 6 section rules + 3 bonus rules
  • Section rules: Title, Description, Installation, Usage, License, Contributing
  • Bonus: code blocks, badges, sufficient length
  • Grade system: A(80+) B(60+) C(40+) D(20+) F(<20)

v2 - Project Scaffolding

  • package.json, tsconfig.json, .gitignore created
  • commander + picocolors dependencies installed
  • src/ directory structure: commands/, lib/
  • Initial build passes

v1 - Initial Setup

  • Project initialized with pmpt

This document tracks your project progress. Update it as you build. AI instructions are in pmpt.ai.md — paste that into your AI tool.

Files (2)

plan.mdpmpt.ai.md
v5 2026:02:25

CI & Improvements

  • · --min-score and --strict CI flags tested and working (exit code 1 on failure)
  • · Default command: `readme-doctor` = `readme-doctor check` (no subcommand needed)
  • · Description detection: recognizes text under H1 title as description (no separate ## needed)
  • · pmpt CLI README scored: 65 → 80 (A grade) after description detection improvement
Detail

readme-doctor

Product Idea

A CLI tool that scores README quality (0-100), detects missing/weak sections, generates improvement suggestions, and produces unified diff patches that can be applied with --write. Supports CI integration with --min-score and --strict flags.

Additional Context

Zero-cost tool. No server, no API, no database. Pure local analysis. Should work on any README.md in any project. Target: open-source maintainers, individual developers, and team leads who want consistent README quality.

Features

  • README score calculation (0-100)
  • Missing/weak section detection
  • Improvement suggestion generation
  • Unified diff patch generation (--write to apply)
  • CI failure conditions (--min-score, --strict)

Tech Stack

Node.js, TypeScript, commander, picocolors

Progress

  • Project setup
  • Core features implementation
  • Testing & polish

Snapshot Log

v5 - CI & Improvements

  • --min-score and --strict CI flags tested and working (exit code 1 on failure)
  • Default command: readme-doctor = readme-doctor check (no subcommand needed)
  • Description detection: recognizes text under H1 title as description (no separate ## needed)
  • pmpt CLI README scored: 65 → 80 (A grade) after description detection improvement

v4 - CLI Commands (check + fix)

  • check command: score display with colored output, per-item breakdown
  • fix command: generate unified diff patches for missing sections
  • --write flag: apply patches directly to README
  • --file flag: specify custom README path
  • patcher.ts: auto-generate section templates (Description, Installation, Usage, License, Contributing)

v3 - Core Scoring Logic

  • parser.ts: README markdown parsing (sections, headings, code blocks, badges)
  • scorer.ts: 100-point scoring system with 6 section rules + 3 bonus rules
  • Section rules: Title, Description, Installation, Usage, License, Contributing
  • Bonus: code blocks, badges, sufficient length
  • Grade system: A(80+) B(60+) C(40+) D(20+) F(<20)

v2 - Project Scaffolding

  • package.json, tsconfig.json, .gitignore created
  • commander + picocolors dependencies installed
  • src/ directory structure: commands/, lib/
  • Initial build passes

v1 - Initial Setup

  • Project initialized with pmpt

This document tracks your project progress. Update it as you build. AI instructions are in pmpt.ai.md — paste that into your AI tool.

Files (2)

plan.mdpmpt.ai.md
v4 2026:02:25

CLI Commands (check + fix)

  • · check command: score display with colored output, per-item breakdown
  • · fix command: generate unified diff patches for missing sections
  • · --write flag: apply patches directly to README
  • · --file flag: specify custom README path
  • · patcher.ts: auto-generate section templates (Description, Installation, Usage, License, Contributing)
Detail

readme-doctor

Product Idea

A CLI tool that scores README quality (0-100), detects missing/weak sections, generates improvement suggestions, and produces unified diff patches that can be applied with --write. Supports CI integration with --min-score and --strict flags.

Additional Context

Zero-cost tool. No server, no API, no database. Pure local analysis. Should work on any README.md in any project. Target: open-source maintainers, individual developers, and team leads who want consistent README quality.

Features

  • README score calculation (0-100)
  • Missing/weak section detection
  • Improvement suggestion generation
  • Unified diff patch generation (--write to apply)
  • CI failure conditions (--min-score, --strict)

Tech Stack

Node.js, TypeScript, commander, picocolors

Progress

  • Project setup
  • Core features implementation
  • Testing & polish

Snapshot Log

v4 - CLI Commands (check + fix)

  • check command: score display with colored output, per-item breakdown
  • fix command: generate unified diff patches for missing sections
  • --write flag: apply patches directly to README
  • --file flag: specify custom README path
  • patcher.ts: auto-generate section templates (Description, Installation, Usage, License, Contributing)

v3 - Core Scoring Logic

  • parser.ts: README markdown parsing (sections, headings, code blocks, badges)
  • scorer.ts: 100-point scoring system with 6 section rules + 3 bonus rules
  • Section rules: Title, Description, Installation, Usage, License, Contributing
  • Bonus: code blocks, badges, sufficient length
  • Grade system: A(80+) B(60+) C(40+) D(20+) F(<20)

v2 - Project Scaffolding

  • package.json, tsconfig.json, .gitignore created
  • commander + picocolors dependencies installed
  • src/ directory structure: commands/, lib/
  • Initial build passes

v1 - Initial Setup

  • Project initialized with pmpt

This document tracks your project progress. Update it as you build. AI instructions are in pmpt.ai.md — paste that into your AI tool.

Files (2)

plan.mdpmpt.ai.md
v3 2026:02:25

Core Scoring Logic

  • · parser.ts: README markdown parsing (sections, headings, code blocks, badges)
  • · scorer.ts: 100-point scoring system with 6 section rules + 3 bonus rules
  • · Section rules: Title, Description, Installation, Usage, License, Contributing
  • · Bonus: code blocks, badges, sufficient length
  • · Grade system: A(80+) B(60+) C(40+) D(20+) F(<20)
Detail

readme-doctor

Product Idea

A CLI tool that scores README quality (0-100), detects missing/weak sections, generates improvement suggestions, and produces unified diff patches that can be applied with --write. Supports CI integration with --min-score and --strict flags.

Additional Context

Zero-cost tool. No server, no API, no database. Pure local analysis. Should work on any README.md in any project. Target: open-source maintainers, individual developers, and team leads who want consistent README quality.

Features

  • README score calculation (0-100)
  • Missing/weak section detection
  • Improvement suggestion generation
  • Unified diff patch generation (--write to apply)
  • CI failure conditions (--min-score, --strict)

Tech Stack

Node.js, TypeScript, commander, picocolors

Progress

  • Project setup
  • Core features implementation
  • Testing & polish

Snapshot Log

v3 - Core Scoring Logic

  • parser.ts: README markdown parsing (sections, headings, code blocks, badges)
  • scorer.ts: 100-point scoring system with 6 section rules + 3 bonus rules
  • Section rules: Title, Description, Installation, Usage, License, Contributing
  • Bonus: code blocks, badges, sufficient length
  • Grade system: A(80+) B(60+) C(40+) D(20+) F(<20)

v2 - Project Scaffolding

  • package.json, tsconfig.json, .gitignore created
  • commander + picocolors dependencies installed
  • src/ directory structure: commands/, lib/
  • Initial build passes

v1 - Initial Setup

  • Project initialized with pmpt

This document tracks your project progress. Update it as you build. AI instructions are in pmpt.ai.md — paste that into your AI tool.

Files (2)

plan.mdpmpt.ai.md
v2 2026:02:25

Project Scaffolding

  • · package.json, tsconfig.json, .gitignore created
  • · commander + picocolors dependencies installed
  • · src/ directory structure: commands/, lib/
  • · Initial build passes
Detail

readme-doctor

Product Idea

A CLI tool that scores README quality (0-100), detects missing/weak sections, generates improvement suggestions, and produces unified diff patches that can be applied with --write. Supports CI integration with --min-score and --strict flags.

Additional Context

Zero-cost tool. No server, no API, no database. Pure local analysis. Should work on any README.md in any project. Target: open-source maintainers, individual developers, and team leads who want consistent README quality.

Features

  • README score calculation (0-100)
  • Missing/weak section detection
  • Improvement suggestion generation
  • Unified diff patch generation (--write to apply)
  • CI failure conditions (--min-score, --strict)

Tech Stack

Node.js, TypeScript, commander, picocolors

Progress

  • Project setup
  • Core features implementation
  • Testing & polish

Snapshot Log

v2 - Project Scaffolding

  • package.json, tsconfig.json, .gitignore created
  • commander + picocolors dependencies installed
  • src/ directory structure: commands/, lib/
  • Initial build passes

v1 - Initial Setup

  • Project initialized with pmpt

This document tracks your project progress. Update it as you build. AI instructions are in pmpt.ai.md — paste that into your AI tool.

Files (2)

plan.mdpmpt.ai.md
v1 2026:02:25

Initial Setup

  • · Project initialized with pmpt
Detail

readme-doctor

Product Idea

A CLI tool that scores README quality (0-100), detects missing/weak sections, generates improvement suggestions, and produces unified diff patches that can be applied with --write. Supports CI integration with --min-score and --strict flags.

Additional Context

Zero-cost tool. No server, no API, no database. Pure local analysis. Should work on any README.md in any project. Target: open-source maintainers, individual developers, and team leads who want consistent README quality.

Features

  • README score calculation (0-100)
  • Missing/weak section detection
  • Improvement suggestion generation
  • Unified diff patch generation (--write to apply)
  • CI failure conditions (--min-score, --strict)

Tech Stack

Node.js, TypeScript, commander, picocolors

Progress

  • Project setup
  • Core features implementation
  • Testing & polish

Snapshot Log

v1 - Initial Setup

  • Project initialized with pmpt

This document tracks your project progress. Update it as you build. AI instructions are in pmpt.ai.md — paste that into your AI tool.

Files (2)

plan.mdpmpt.ai.md