tsc-todo

A CLI tool to convert TypeScript compiler output into a Markdown todo list.

Installation

Global Installation (Recommended)

npm install -g tsc-todo

Use without installation

# Using npx
tsc --noEmit | npx tsc-todo

# Using bunx
tsc --noEmit | bunx tsc-todo

Usage

Command Line Interface

# Output to console
tsc --noEmit | tsc-todo

# Save to file (creates tsc-todo-YYYY-MM-DD.md)
tsc --noEmit | tsc-todo --file

# Include stderr in the output
tsc --noEmit 2>&1 | tsc-todo

# Show help
tsc-todo --help

Programmatic Usage (Optional)

If needed, you can also use the main function programmatically:

import { tscOutputToMarkdown } from 'tsc-todo';

const tscOutput = `
src/example.ts(10,5): error TS2322: Type 'string' is not assignable to type 'number'.
src/example.ts(15,10): error TS2339: Property 'foo' does not exist on type 'Bar'.
`;

const markdown = tscOutputToMarkdown(tscOutput);
console.log(markdown);

Development

This project uses Bun as the runtime and package manager.

Prerequisites

• Bun >= 1.0.0

Setup

# Install dependencies
bun install

# Run tests
bun test

# Run tests in watch mode
bun test --watch

# Build the library
bun run build

# Run in development mode
bun run dev

# Lint code
bun run lint

# Format code
bun run format

Building

The build process creates both ESM and CommonJS outputs:

bun run build

This will:

1. Clean the dist directory
2. Bundle the code with Bun
3. Generate TypeScript declaration files

Publishing

# Build and publish to npm
npm publish

Scripts

• build - Build the library for production
• dev - Run in development mode with file watching
• test - Run all tests
• test:watch - Run tests in watch mode
• lint - Lint TypeScript files
• lint:fix - Fix linting issues automatically
• format - Format code with Prettier

License

MIT