markdown-task-checker/README.md

A CLI tool to check markdown task list completion

# 📝 markdown-task-checker

[![npm version](https://img.shields.io/npm/v/markdown-task-checker.svg)](https://www.npmjs.com/package/markdown-task-checker)
[![npm downloads](https://img.shields.io/npm/dw/markdown-task-checker.svg)](https://www.npmjs.com/package/markdown-task-checker)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

> ✅ Check completion of markdown task lists from the command line!  
> Perfect for validating PR checklists or tracking TODOs in your docs.

---

## 📦 Installation

```bash
npm install -g markdown-task-checker
```

> Or just use it with `npx` (no install needed):

```bash
npx markdown-task-checker ./README.md
```

---

## 🚀 Usage

### Basic

```bash
markdown-task-checker ./example.md
```

### Output Example

```text
✅ 3 / 5 tasks completed.
📝 Some tasks remain.
```

---

## ✨ Features

- Parses task lists like `- [ ]`, `- [x]` from markdown files
- Reports how many tasks are completed
- Simple CLI interface
- Great for CI automation or everyday note-checking

---

<!--

## 🛠 CLI Options (예정 기능)

```bash
markdown-task-checker [file.md]
```

- [ ] `--require-all`: Fail if not all tasks are completed
- [ ] `--percent`: Show percentage of completed tasks
- [ ] `--json`: Output as JSON

> 🤫 _These will be added soon! Stay tuned._

---

-->

## 🧪 Example Input (`example.md`)

```md
# My Checklist

- [x] Write the parser
- [ ] Write tests
- [x] Create CLI
- [ ] Polish README
```

---

## ✅ Sample Output

```bash
markdown-task-checker example.md
```

```text
✅ 2 / 4 tasks completed.
📝 Some tasks remain.
```

---

## 🔗 Related

- Inspired by [GitHub Flavored Markdown](https://github.github.com/gfm/)
- Ideal for GitHub PR templates

---

## 📄 License

[MIT](./LICENSE)

---

## 🙌 Author

Made with ❤️ by [Sang Yoon Lee / SYL](https://github.com/sangyoon-lee1231)