Feature: Dictionary Quick Rules for automatic text cleanup without AI

[tmm22]

Overview

I've implemented a Dictionary Quick Rules feature that provides instant, predictable text cleanup without requiring AI enhancement. This eliminates the need for external AI calls for basic dictation cleanup tasks.

What Are Quick Rules?

Quick Rules are preset correction patterns that automatically clean up transcribed text:

• Casual to formal conversion (gonna → going to, wanna → want to)
• Remove filler words (um, uh, like, you know)
• Fix duplicates (the the → the)
• Fix spacing issues (multiple spaces, trim whitespace)
• Fix punctuation (ensure space after punctuation)

Why This Feature?

Complements Existing Features

VoiceInk already has excellent AI enhancement capabilities, but Quick Rules fills a different need:

Feature	Quick Rules	AI Enhancement
Speed	Instant (<1ms)	2-5 seconds
Offline	Yes	Depends on provider
Privacy	100% local	Sends to AI provider
Predictable	Same input = same output	Can vary
Use Case	Basic cleanup	Context-aware rewriting

Processing Pipeline

Raw Transcription
       ↓
[1] Quick Rules (Optional)      ← NEW FEATURE
       ↓
[2] Word Replacements (Optional)
       ↓
[3] AI Enhancement (Optional)
       ↓
Final Output

User Benefits

1. Speed: Clean up text instantly without waiting for AI
2. Privacy: No data leaves the device for basic cleanup
3. Battery-friendly: No API calls or LLM processing
4. Predictable: Users know exactly what transformations will occur
5. Flexible: Can be used alone or combined with AI enhancement

Implementation Details

Features

• 17 preset rules organized into 5 categories:

  • Casual to Formal (8 rules)
  • Filler Words (4 rules, disabled by default)
  • Duplicates (1 rule)
  • Spacing (3 rules)
  • Punctuation (1 rule)

• Live preview with real-time text transformation

• Custom rule creation (text or regex patterns)

• Category organization with individual rule toggles

• Integration with existing Word Replacement pipeline

• Comprehensive UI with examples and testing tools

Code Quality

• Follows VoiceInk coding standards (AGENTS.md)
• Uses @MainActor for UI classes
• Proper error handling
• Accessibility labels
• Help tooltips
• UserDefaults persistence
• ~800 lines of well-documented Swift code

Working Implementation

I've fully implemented this feature in my fork and it's working perfectly:

• Repository: https://github.com/tmm22/VoiceInk/tree/custom-main-v2
• Implementation Details: QUICK_RULES_IMPLEMENTATION.md
• User Guide: QUICK_RULES_USER_GUIDE.md

New Files (4):

1. VoiceInk/Services/QuickRulesService.swift (260 lines) - Core logic
2. VoiceInk/Views/Dictionary/QuickRulesView.swift (500 lines) - Complete UI
3. QUICK_RULES_IMPLEMENTATION.md - Technical documentation
4. QUICK_RULES_USER_GUIDE.md - User documentation

Modified Files (2):

1. VoiceInk/Services/WordReplacementService.swift - Integration
2. VoiceInk/Views/Dictionary/DictionarySettingsView.swift - UI placement

Screenshots

Quick Rules Interface

The feature is accessed via Settings → Dictionary → Quick Rules (new first tab)

Live Preview

Users can test rules in real-time before recording:

Input:  "I'm gonna wanna kinda go there"
Output: "I'm going to want to kind of go there"

Category Organization

Rules are organized into collapsible categories with enable/disable toggles for each rule.

Use Cases

Use Case 1: Quick Dictation (No AI)

Raw: "um I'm gonna check the the project you know"
     ↓ Quick Rules
Final: "I'm going to check the project"

Benefit: Instant cleanup for quick notes without AI delay

Use Case 2: Professional Writing (Quick Rules + AI)

Raw: "gonna send an email about the the meeting"
     ↓ Quick Rules
Step 1: "going to send an email about the meeting"
     ↓ AI Enhancement
Final: "I will send an email regarding the meeting."

Benefit: Quick Rules clean up obvious issues, AI focuses on higher-level improvements

Use Case 3: Battery-Conscious Users

Quick Rules provide basic cleanup without draining battery with AI calls - perfect for all-day transcription sessions.

Contribution Offer

I'm happy to contribute this feature via pull request if there's interest. The code is:

• ✅ Fully tested and working
• ✅ Follows VoiceInk coding standards
• ✅ Well-documented (user guide + technical docs)
• ✅ Non-breaking (completely optional feature)
• ✅ Privacy-focused (100% local processing)
• ✅ Ready for integration

The feature integrates cleanly with existing code and doesn't affect any current functionality. Users can enable/disable it entirely or customize which rules to use.

Community Feedback

This feature was suggested based on analysis of common transcription workflows. Many users want:

• Basic cleanup without AI overhead
• Faster processing for simple tasks
• Privacy-focused text processing
• Predictable transformations

Quick Rules addresses all these needs while complementing VoiceInk's existing AI enhancement capabilities.

Technical Notes

• Performance: <1ms processing time per transcription
• Memory: Negligible (<1KB for all rules)
• Storage: Rules stored in UserDefaults
• Compatibility: Works with all transcription models and AI providers
• Testing: Manually tested on macOS 14.0+ (Sonoma)

---

Would you be interested in this feature for upstream VoiceInk? I'm ready to open a PR with the full implementation, or I can continue maintaining it in my fork if preferred.

Looking forward to your thoughts!