Skip to content

Auto Correct extension for chrome. LanguageTool based extension

Notifications You must be signed in to change notification settings

QuivrHQ/auto-correct

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

67 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AutoCorrect Logo

AutoCorrect

Real-time grammar & spelling correction for Chrome

Chrome Extension Manifest V3 TypeScript

AutoCorrect Demo

Download


✨ Features

🔍 Real-time Detection — Automatically detects spelling and grammar errors as you type

🎯 Smart Underlines — Visual indicators with color coding:

  • 🔴 Red for spelling errors
  • 🟠 Orange for grammar mistakes
  • 🔵 Blue for style suggestions

One-Click Fix — Click any underlined word to see suggestions and apply corrections instantly

🚀 Fix All — Apply all corrections at once with a single button

📊 Score Dashboard — Real-time quality score with detailed breakdown by error type

🌍 Multi-language — Supports French, English, and auto-detection

🔌 Universal Compatibility — Works everywhere:

  • Standard inputs & textareas
  • Rich text editors (CKEditor, TinyMCE)
  • Contenteditable elements
  • Zendesk, Gmail, Notion, and more

🎯 How It Works

┌─────────────────────────────────────────────────────────┐
│                                                         │
│   You type: "Je vais au marche aujourdui"              │
│                      ~~~~~~~  ~~~~~~~~~                 │
│                         │         │                     │
│                         ▼         ▼                     │
│                     [marché]  [aujourd'hui]             │
│                                                         │
│   Click the underline → See suggestions → Apply fix    │
│                                                         │
└─────────────────────────────────────────────────────────┘
  1. Detection — The extension monitors text fields on any webpage
  2. Analysis — Text is sent to LanguageTool API for grammar/spelling check
  3. Display — Errors are highlighted with colored wavy underlines
  4. Correction — Click to see suggestions, one more click to apply

🖥️ Popup Interface

┌─────────────────────────────────┐
│  🔵 AutoCorrect        [FR ▼]  │
├─────────────────────────────────┤
│  Score  ████████░░░  78/100    │
│                                 │
│  🔴 2 spelling  🟠 1 grammar   │
│                                 │
│  Recommendation:                │
│  aujourdui → aujourd'hui        │
│                                 │
│  [    ✓ Fix All (3)    ]       │
├─────────────────────────────────┤
│  • Error cards with details... │
└─────────────────────────────────┘

🛠️ Development

Prerequisites

  • Node.js 18+
  • npm or yarn

Commands

# Development mode with hot reload
npm run dev

# Production build
npm run build

# Run E2E tests (Playwright)
npm test

# Run tests with UI
npm run test:ui

Project Structure

auto-correct/
├── src/
│   ├── content/              # Content scripts (injected into pages)
│   │   ├── text-field-manager.ts   # Field detection & correction
│   │   ├── underline-renderer.ts   # Visual underlines & tooltips
│   │   └── language-tool-client.ts # API client
│   ├── popup/                # Extension popup UI
│   │   └── Popup.tsx         # React component
│   ├── background/           # Service worker
│   └── shared/               # Shared types & utilities
├── tests/
│   └── e2e/                  # Playwright tests
├── dist/                     # Built extension
└── docker/                   # LanguageTool server config

🌐 API

The extension uses LanguageTool for grammar checking.

Default server: https://languagetool-autocorrect.fly.dev

You can self-host your own LanguageTool server using the provided Docker configuration:

cd docker
fly launch  # Deploy to Fly.io

Or use the official LanguageTool API at https://api.languagetool.org


🧪 Tested Platforms

Platform Status Notes
Standard inputs Full support
Textareas Full support
Contenteditable Full support
CKEditor 5 Zendesk, etc.
Gmail Compose window
Google Docs ⚠️ Canvas-based, limited
Notion Works with contenteditable

📄 License

MIT © Stan Girard


Built with ❤️ using TypeScript, React, and Tailwind CSS

About

Auto Correct extension for chrome. LanguageTool based extension

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •