martinec / autocomplete-plus

View and insert possible completions in the editor while typing

autocomplete+ package

View the changelog

View and insert possible completions in the editor while typing

Note: In the example above, Show Suggestions On Keystroke is enabled.

Installation

• APM: apm install autocomplete-plus
• Preferences: Open Atom and go to Preferences > Packages, search for autocomplete-plus, and install it

Providers

autocomplete+ has a powerful autocomplete provider API, allowing provider authors to add language-specific behavior to this package.

You should definitely install additional providers (the default provider bundled with this package is somewhat crude): https://github.com/atom-community/autocomplete-plus/wiki/Autocomplete-Providers

Usage

Just type some stuff, and autocomplete+ will automatically show you some suggestions. Press UP and DOWN to select another suggestion, press TAB to confirm your selection. You can change the default keymap in Preferences:

• Keymap For Confirming A Suggestion
• Keymap For Navigating The Suggestion List

Additionally, the keymap can be customized in your keymap.cson:

'atom-text-editor:not(mini).autocomplete-active':
  'tab': 'unset!'
  'enter': 'autocomplete-plus:confirm'
  'up': 'unset!'
  'down': 'unset!'
  'ctrl-p': 'autocomplete-plus:select-previous'
  'ctrl-n': 'autocomplete-plus:select-next'

Features

• Shows suggestions while typing
• Includes a default provider (FuzzyProvider):
  • Wordlist generation happens when you open a file, while editing the file, and on save
  • Suggestions are calculated using fuzzaldrin
• Exposes a provider API which can be used to extend the functionality of the package and provide targeted / contextually correct suggestions
• Disable autocomplete for file(s) via blacklisting
• Disable autocomplete for editor scope(s) via blacklisting

Provider API

Great autocomplete depends on having great autocomplete providers. If there is not already a great provider for the language / grammar that you are working in, please consider creating a provider.

Read the Provider API documentation to learn how to create a new autocomplete provider.