Skip to content

Improve README header and add dev smoke test #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bdtran2002 merged 1 commit into from
Apr 21, 2026
Merged

Improve README header and add dev smoke test #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 25 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,25 @@
<p align="center">
<img src="./assets/icon.png" alt="SudoFill icon" width="96" height="96" />
<img src="./assets/icon.png" alt="SudoFill icon" width="160" height="160" />
</p>

[![CI](https://github.com/bdtran2002/SudoFill/actions/workflows/ci.yml/badge.svg)](https://github.com/bdtran2002/SudoFill/actions/workflows/ci.yml)
[![Actionlint](https://github.com/bdtran2002/SudoFill/actions/workflows/actionlint.yml/badge.svg)](https://github.com/bdtran2002/SudoFill/actions/workflows/actionlint.yml)
[![Release-please](https://github.com/bdtran2002/SudoFill/actions/workflows/release-please.yml/badge.svg)](https://github.com/bdtran2002/SudoFill/actions/workflows/release-please.yml)
[![Release](https://github.com/bdtran2002/SudoFill/actions/workflows/release.yml/badge.svg)](https://github.com/bdtran2002/SudoFill/actions/workflows/release.yml)
[![Latest release](https://img.shields.io/github/v/release/bdtran2002/SudoFill)](https://github.com/bdtran2002/SudoFill/releases/latest)
[![License](https://img.shields.io/badge/license-GPLv3-blue.svg)](LICENSE)
<h1 align="center">⚡ SudoFill</h1>

# ⚡ SudoFill
<p align="center">Browser extension for fast disposable sign-up flows.</p>

SudoFill is a browser extension for fast disposable sign-up flows.
<p align="center">
<img alt="TypeScript" src="https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white" />
<img alt="HTML" src="https://img.shields.io/badge/HTML-E34F26?logo=html5&logoColor=white" />
<img alt="CSS" src="https://img.shields.io/badge/CSS-1572B6?logo=css3&logoColor=white" />
</p>

<p align="center">
<a href="https://github.com/bdtran2002/SudoFill/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/bdtran2002/SudoFill/actions/workflows/ci.yml/badge.svg" /></a>
<a href="https://github.com/bdtran2002/SudoFill/actions/workflows/actionlint.yml"><img alt="Actionlint" src="https://github.com/bdtran2002/SudoFill/actions/workflows/actionlint.yml/badge.svg" /></a>
<a href="https://github.com/bdtran2002/SudoFill/actions/workflows/release-please.yml"><img alt="Release-please" src="https://github.com/bdtran2002/SudoFill/actions/workflows/release-please.yml/badge.svg" /></a>
<a href="https://github.com/bdtran2002/SudoFill/actions/workflows/release.yml"><img alt="Release" src="https://github.com/bdtran2002/SudoFill/actions/workflows/release.yml/badge.svg" /></a>
<a href="https://github.com/bdtran2002/SudoFill/releases/latest"><img alt="Latest release" src="https://img.shields.io/github/v/release/bdtran2002/SudoFill" /></a>
<a href="LICENSE"><img alt="License" src="https://img.shields.io/badge/license-GPLv3-blue.svg" /></a>
</p>

It creates a temporary Mail.tm inbox, autofills common registration fields on supported HTTPS pages, keeps verification emails inside the extension UI, and lets you open detected verification links without bouncing between tabs.

Expand Down Expand Up @@ -121,6 +129,14 @@ Chrome:
bun run dev:chrome
```

### Quick local dev test

```bash
bun run dev:test
```

Runs a fast local sanity check without Docker: typecheck, unit tests, and a Firefox build.

Comment on lines +132 to +139
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Apr 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Keep script docs consistent with the command index.

Line [135] introduces bun run dev:test, but the later Useful scripts list doesn’t include it, which can cause discoverability drift.

📌 Suggested README update 
 - `bun run typecheck`
 - `bun run test`
+- `bun run dev:test`
 - `bun run test:watch`
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 132 - 139, The README mentions the local dev test
command bun run dev:test but the "Useful scripts" index omits it; update the
README's "Useful scripts" list to include an entry for dev:test (with a short
description like "fast local sanity check: typecheck, unit tests, Firefox
build") so the command is discoverable, ensuring the script name dev:test
matches the example shown earlier.

### Build production bundles

Firefox:
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"dev": "wxt -b firefox",
"dev:firefox": "wxt -b firefox",
"dev:chrome": "wxt",
"dev:test": "bun run typecheck && bun run test && bun run build",
"build": "wxt build -b firefox",
"build:firefox": "wxt build -b firefox",
"build:chrome": "wxt build",
Expand Down