Skip to content

This adds dictionary entries to the completions inside comments. For lazy typers!

License

Notifications You must be signed in to change notification settings

evandroforks/DictionaryAutoComplete

 
 

Repository files navigation

Dictionary Auto-Complete

Pic

This plug-in adds auto-completion entries from the dictionary file. Useful for very lazy typers like me or if you're searching for a particular word.

The default scopes where this plug-in is active are comments, strings and text. But you can customize them.

Just type Ctrl + Space to show auto-completion, or allow auto-complete to always show suggestions by changing your 'Settings - User' for example like this:

"auto_complete_selector": "text, comment, string"

DictionaryAutoComplete takes the suggestions from the dictionary used for spell-checking by default. But if you want you can set another one in the settings (for example a frequency dictionary).

Installation

By Package Control

  1. Download & Install Sublime Text 3 (https://www.sublimetext.com/3)
  2. Go to the menu Tools -> Install Package Control, then, wait few seconds until the installation finishes up
  3. Now, Go to the menu Preferences -> Package Control
  4. Type Add Channel on the opened quick panel and press Enter
  5. Then, input the following address and press Enter
    https://raw.githubusercontent.com/evandrocoan/StudioChannel/master/channel.json
    
  6. Go to the menu Tools -> Command Palette... (Ctrl+Shift+P)
  7. Type Preferences: Package Control Settings – User on the opened quick panel and press Enter
  8. Then, find the following setting on your Package Control.sublime-settings file:
    "channels":
    [
        "https://packagecontrol.io/channel_v3.json",
        "https://raw.githubusercontent.com/evandrocoan/StudioChannel/master/channel.json",
    ],
  9. And, change it to the following, i.e., put the https://raw.githubusercontent... line as first:
    "channels":
    [
        "https://raw.githubusercontent.com/evandrocoan/StudioChannel/master/channel.json",
        "https://packagecontrol.io/channel_v3.json",
    ],
    • The https://raw.githubusercontent... line must to be added before the https://packagecontrol.io... one, otherwise, you will not install this forked version of the package, but the original available on the Package Control default channel https://packagecontrol.io...
  10. Now, go to the menu Preferences -> Package Control
  11. Type Install Package on the opened quick panel and press Enter
  12. Then, search for DictionaryAutoComplete and press Enter

See also:

  1. ITE - Integrated Toolset Environment
  2. Package control docs for details.

Configuration

You can customize the following parameters in (a copy in User package folder of) DictionaryAutoComplete.sublime-settings :

  • encoding : The dictionary encoding (like "UTF-8" or "ISO-8859-1").
  • insert original : If the default auto-completion list should be used or not.
  • maximum results : The maximal number of results that this plug-in should return (for slower computer smaller number is better).
  • scopes : Define the scopes where this plug-in is active.
  • minimal length : The minimal length of a word to be completed (for slower computer you should play with this parameter to find what is optimal).
  • forbidden prefixes : This allows to not auto-complete after some characters, which can be useful for compatibility with other plug-ins.
  • languages : A language specific settings. Here you can overwrite all the previous settings for a particular language. Here is also the place to set an alternative dictionary if you want.
  • dictionary : A path to alternative dictionary to use in place of the default dictionary used for spell-checking. This allows you for example to use a frequency dictionary that will show in first place the most used words.
  • smash characters: Allows you to identify characters with accents in some languages. For example for French you can set
    "smash characters": ["eéèêë", "aàâä", "cç", "iîï", "oôö", "uùûü", "yÿ"]
    
    and then when you type "lecon" it will suggest you "leçon".
  • numeric shortcuts: Change the way auto complete behaves. All the choices are numbered and pressing a number select the corresponding completion. If you use this setting you should probably set maximum results to less than 10.
  • dictionary symbol: Is the symbol displayed on the right that is by default 🕮. You can choose for example one of the Unicode book symbols: 📒, 📓, 📔, 📕, 📖, 📗, 📚, 📜, 🕮.
  • reset on every key: [experimental] By default ST do not refresh the auto-completion list on every key press.To overcome this we can force completion list refresh by first hiding then showing it. This is done when this setting is set to true (by default it is false).

Commands

Two commands are added in the Command Palette (Ctrl+Shift+P):

  • Dictionary Auto Complete: Toggle : Activate/deactivate this plug-in.
  • Auto Complete: Toggle : Activate/deactivate the sublime auto-completion.

License

Dictionary Auto-Complete for Sublime Text 2/3 Copyright (C) 2013 Florian Zinggeler Copyright (C) 2018 Kroum Tzanev

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.