BuddyTools: Smart Typing Assistant

AutoCorrect – Smart Typing Assistant ✨

A powerful VSCode extension that fixes typos automatically as you type. Highlights unknown words, allows dictionary customization with one click, and works completely offline with zero latency. ✨ Features 🔄 Intelligent Autocorrection Automatically corrects common typos as you type, just like a mobile keyboard:

becuase → because recieve → receive automticly → automatically

📚 Custom Dictionary Management

In-editor learning: Hover over any highlighted word and click "Add to dictionary" Persistent storage: Your custom words are saved locally and applied across all files Manual editing: Direct access to custom_words.json for bulk modifications

🎯 Smart Highlighting

Unknown words are subtly underlined without disrupting your workflow. Non-intrusive visual feedback helps you catch potential typos.

🔒 Privacy-First Design

100% offline: No API calls, no tracking, no telemetry Zero latency: Instant corrections without network delays Local storage: All data stays on your machine

📋 Table of Contents

Installation Getting Started Commands Configuration Development Examples Requirements Release Notes Contributing License

🚀 Installation

From VSCode Marketplace (Recommended)

Open VSCode Press Ctrl+P (Windows/Linux) or Cmd+P (macOS) Type ext install autocorrect-smart-typing Press Enter

Manual Installation

Download the latest .vsix file from Releases Open VSCode Go to Extensions (Ctrl+Shift+X) Click the ... menu → "Install from VSIX..." Select the downloaded file

🏁 Getting Started

Install the extension using one of the methods above Start typing – corrections happen automatically on space Customize your dictionary:

Hover over any underlined word Click "Add to dictionary" in the Quick Fix menu Or use Ctrl+Shift+P → "AutoCorrect: Open Custom Dictionary"

🎮 Commands

CommandDescriptionKeybindingAutoCorrect: Add Word to DictionaryAdds the selected word to your custom dictionary-AutoCorrect: Open Custom DictionaryOpens custom_words.json for manual editing-
Access commands via Command Palette (Ctrl+Shift+P or Cmd+Shift+P)

⚙️ Configuration

Configure AutoCorrect through VSCode Settings (Ctrl+, or Cmd+,):
SettingTypeDefaultDescriptionautocorrect.enabledbooleantrueEnable or disable AutoCorrect globallyautocorrect.languagesarray["*"]Specify languages where AutoCorrect is active (e.g., ["markdown", "plaintext"])autocorrect.debounceMsnumber100Delay in milliseconds before correction triggers

Example Configuration

json{
  "autocorrect.enabled": true,
  "autocorrect.languages": ["markdown", "plaintext", "latex"],
  "autocorrect.debounceMs": 150
}

💻 Development

Prerequisites

Node.js ≥ 14.x npm ≥ 6.x VSCode ≥ 1.75

Setup

Clone the repository

git clone https://github.com/ypranay3232/ypranay3232-VS-code-Auto-Correct-Grammer
cd autocorrect

Install dependencies

npm install

Compile TypeScript

npm run compile
Running Development Version

Open the project in VSCode
Press F5 to launch Extension Development Host
Test the extension in the new VSCode window

Building

Package the extension
npm run package

This creates a .vsix file you can distribute

Testing bash# Run tests npm test

📝 Examples

Before:

becuase this wll correct automticly when you press space

After:

because this will correct automatically when you press space

Unknown words like automticly are underlined. Hover to add them to your dictionary.

📂 Dictionary Storage

Your custom dictionary is stored at:

<extension-folder>/dictionaries/custom_words.json

You can edit this file manually or use the built-in Quick Fix interface.

📌 Requirements

VSCode: Version 1.75 or higher
Internet: Not required – works completely offline
Disk Space: < 5MB

📦 Release Notes

1.0.0 (Initial Release)

✨ Automatic typo correction on space
📚 Custom dictionary with in-editor learning
🎯 Unknown word highlighting
🔒 100% offline operation
⚙️ Configurable language support and debounce timing

🤝 Contributing

Contributions are welcome! Please follow these steps:

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

🐛 Bug Reports & Feature Requests

Found a bug or have an idea? Please open an issue with:

Clear description
Steps to reproduce (for bugs)
Expected vs actual behavior
VSCode version and OS

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

MIT License

Copyright (c) 2025 ypranay

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Pranay