QuickTypoFix

A versatile VSCode extension designed to instantly correct typos across all text files, streamlining your coding workflow with seamless LLM-powered typo correction.

You can use OpenAI chat completion API and also OpenAI compatible chat completion API like groq.

Features

• Quickly fix typos in your line.
• Highlights the fixed typos for a short period of time.

Requirements

• Visual Studio Code >= 1.87.0

• OpenAI API Key

  • Note that you can use the API key for an OpenAI compatible chat completion API like groq.

Installation

You can install this extension in two ways:

Download .vsix file

1. Download the .vsix file from https://github.com/hmasdev/QuickTypoFix/releases

2. Install the extension with install from VSIX... in VS Code.

   

Build from Source

1. Clone the repository:

   git clone https://github.com/hmasdev/QuickTypoFix

2. Change to the directory:

   cd QuickTypoFix

3. Install the dependencies:

   npm install

4. Build the extension:

   vsce package

5. Install the extension with install from VSIX... in VS Code in the same way as the above.

Usage

Preparation(Configuration)

Open the setting page with Ctrl+, and search quicktypofix. Then you can customize this extension as follows:

• REQUIRED
  • quicktypofix.apiKey: The API key for typo corrections. Default is an empty string;
• Optional
  • quicktypofix.apiEndpoint: The OpenAI-compatible chat completion API endpoint for typo corrections. Default is https://api.openai.com/v1/chat/completions;
  • quicktypofix.modelName: The LLM model name for typo corrections. Default is gpt-3.5-turbo;
  • quicktypofix.systemPrompt: The system prompt for typo corrections. Default is 'Excellent Typo Fixer. Output the only fixed sentence without any header or any footer.';
  • quicktypofix.highlightTimeout: The timeout for the highlight in milliseconds. Default is 3000;
  • quicktypofix.addedHighlightColor: The highlight color for added characters like rgba(0, 255, 0, 0.5) or #00FF00. Default is rgba(0, 255, 0, 0.5);
  • quicktypofix.removedHighlightColor: The highlight color for removed characters like rgba(255, 0, 0, 0.5) or #FF0000. Default is rgba(255, 0, 0, 0.5);

Use this Extension

During writing codes or texts in VS Code, you can use the QuickTypoFix command to fix typos in the following two ways.

1. Ctrl+Shift+P to open the command palette, then type Fix typo in this line and select the command.

or

2. Crtl+K Ctrl+N to execute the command directly.

   • NOTE: You can remeber the shortcut by Ctrl+K followed by Ctrl+N as "これ直して（Kore Naoshite）".

After fixed, the typo will be highlighted for a short period of time. Check them.

Development

Requirements

• Node.js >= v20.11.1
• npm
  • Dependencies (See the package.json for the details)
    • vsce >= 2.24.0
    • diff >= 5.2.0
    • [node-fetch](https://www.npmjs.com/package/ node-fetch) >= 2.6.7

How to Develop

1. Fork the repository: https://github.com/hmasdev/QuickTypoFix/fork

2. Clone the forked repository:

   git clone https://github.com/{YOUR_ACCOUT_HERE}/QuickTypoFix

3. Change to the directory:

   cd QuickTypoFix

4. Git checkout to the branch for development:

   git checkout -b {YOUR_BRANCH_NAME_HERE}

5. Install the dependencies:

   npm install

6. Edit the source code. Some notes as follows:

   • Implement tests as follows:
     • Unit Test: attach 'Unit Test' to the title in describe
     • Integration Test: attach 'Integration Test' to the title in describe
       • Note that "Integration Test" means the tests which require an external services like the OpenAI API.

7. Test the extension:

   • Unit Test

     npm run test

   • Integration Test

     npm run test-integration

     Note that you need to add your OpenAI API key to the .env file before running integration tests. The .env file should be like this:

     OPENAI_API_KEY={YOUR_OPENAI_API_KEY}

8. Git commit and push the changes:

   git add .
   git commit -m "Add xxxx feature"
   git push origin add_xxxx_feature

9. Create a pull request from the following link: https://github.com/hmasdev/QuickTypoFix/compare/master...{YOUR_ACCOUT_HERE}:QuickTypoFix:{YOUR_BRANCH_NAME_HERE}

Release

Release the extension is automated by GitHub Actions. The following steps are for the maintainers:

npm version {HERE_IS_THE_VERSION}
git push origin {HERE_IS_THE_VERSION}

where the tag format must be %d.%d.%d like 0.0.1.

After that, the maintainers should check the release page: https://github.com/hmasdev/QuickTypoFix/releases

TODO

• Specify the versions of requirements
• [] Implement the customizable dictionaries
• Add the tests for ./temporalHighlight.js

License

• MIT

Author

• hmasdev