-
-
Notifications
You must be signed in to change notification settings - Fork 145
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #358 from pulsar-edit/bundle-specific-refs
Bundle `autocomplete-plus`
- Loading branch information
Showing
42 changed files
with
11,594 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
spec/fixtures |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
node_modules | ||
.DS_Store | ||
npm-debug.log |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
pairs: | ||
ns: Nathan Sobo; nathan | ||
cj: Corey Johnson; cj | ||
dg: David Graham; dgraham | ||
ks: Kevin Sawicki; kevin | ||
jc: Jerry Cheung; jerry | ||
bl: Brian Lopez; brian | ||
jp: Justin Palmer; justin | ||
gt: Garen Torikian; garen | ||
mc: Matt Colyer; mcolyer | ||
bo: Ben Ogle; benogle | ||
jr: Jason Rudolph; jasonrudolph | ||
jl: Jessica Lord; jlord | ||
email: | ||
domain: github.com | ||
#global: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
# Autocomplete+ package | ||
|
||
Displays possible autocomplete suggestions on keystroke (or manually by typing `ctrl-space`) and inserts a suggestion in the editor if confirmed. | ||
|
||
 | ||
|
||
[Changelog](https://github.com/atom/autocomplete-plus/releases) | ||
|
||
## Installation | ||
|
||
`autocomplete+` is bundled with Pulsar. You don't have to do anything to 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/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` or `ENTER` to confirm your selection. You can change the default keymap in `Preferences`: | ||
|
||
* Keymap For Confirming A Suggestion | ||
|
||
Additionally, the confirm keymap can be customized in your keymap.cson: | ||
|
||
```coffeescript | ||
'atom-text-editor.autocomplete-active': | ||
'tab': 'unset!' | ||
'ctrl-shift-a': 'autocomplete-plus:confirm' | ||
``` | ||
|
||
If setting custom keybindings, use the `none` setting for the confirmation keymap. All this option does is not set any other keybindings. This allows the `TAB` and `ENTER` keys to be used like normal, without side effects. | ||
|
||
### Remapping Movement Commands | ||
|
||
By default, autocomplete-plus commandeers the editor's core movement commands when the suggestion list is open. You may want to change these movement commands to use your own keybindings. | ||
|
||
First you need to set the `autocomplete-plus.useCoreMovementCommands` setting to `false`, which you can do from the `autocomplete-plus` settings in the settings view. | ||
|
||
 | ||
|
||
Or by adding this to your config file: | ||
|
||
```coffee | ||
"*": | ||
"autocomplete-plus": | ||
"useCoreMovementCommands": false | ||
``` | ||
|
||
Then add these to your keymap file: | ||
|
||
```coffeescript | ||
'body atom-text-editor.autocomplete-active': | ||
'ctrl-p': 'autocomplete-plus:move-up' | ||
'ctrl-n': 'autocomplete-plus:move-down' | ||
'pageup': 'autocomplete-plus:page-up' | ||
'pagedown': 'autocomplete-plus:page-down' | ||
'home': 'autocomplete-plus:move-to-top' | ||
'end': 'autocomplete-plus:move-to-bottom' | ||
``` | ||
|
||
## Features | ||
|
||
* Shows suggestions while typing | ||
* Includes a default provider (`SymbolProvider`): | ||
* 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, e.g. `*.md` to blacklist Markdown files | ||
* Disable autocomplete for editor scope(s) via blacklisting | ||
* Expands a snippet if an autocomplete+ provider includes one in a suggestion | ||
* Allows external editors to register for autocompletions | ||
|
||
## 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](https://github.com/atom/autocomplete-plus/wiki/Provider-API) to learn how to create a new autocomplete provider. | ||
|
||
## `SymbolProvider` Configuration | ||
|
||
If the default `SymbolProvider` is missing useful information for the language / grammar you're working with, please take a look at the [`SymbolProvider` Config API](https://github.com/atom/autocomplete-plus/wiki/SymbolProvider-Config-API). | ||
|
||
## The `watchEditor` API | ||
|
||
The `watchEditor` method on the `AutocompleteManager` object is exposed as a [provided service](http://flight-manual.atom.io/behind-atom/sections/interacting-with-other-packages-via-services/), named `autocomplete.watchEditor`. The method allows external editors to register for autocompletions from providers with a given set of labels. Disposing the returned object will undo this request. External packages can access this service with the following code. | ||
|
||
In `package.json`: | ||
``` | ||
{ | ||
"consumedServices": { | ||
"autocomplete.watchEditor": { | ||
"versions": { | ||
"1.0.0": "consumeAutocompleteWatchEditor" | ||
} | ||
} | ||
} | ||
} | ||
``` | ||
In the main module file: | ||
``` | ||
consumeAutocompleteWatchEditor(watchEditor) { | ||
this.autocompleteDisposable = watchEditor( | ||
this.editor, ['symbol-provider'] | ||
) | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
{ | ||
"max_line_length": { | ||
"level": "ignore" | ||
}, | ||
"no_empty_param_list": { | ||
"level": "error" | ||
}, | ||
"arrow_spacing": { | ||
"level": "error" | ||
}, | ||
"no_interpolation_in_single_quotes": { | ||
"level": "error" | ||
}, | ||
"no_debugger": { | ||
"level": "error" | ||
}, | ||
"prefer_english_operator": { | ||
"level": "error" | ||
}, | ||
"colon_assignment_spacing": { | ||
"spacing": { | ||
"left": 0, | ||
"right": 1 | ||
}, | ||
"level": "error" | ||
}, | ||
"braces_spacing": { | ||
"spaces": 0, | ||
"level": "error" | ||
}, | ||
"spacing_after_comma": { | ||
"level": "error" | ||
}, | ||
"no_stand_alone_at": { | ||
"level": "error" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
'atom-text-editor': | ||
'ctrl-space': 'autocomplete-plus:activate' | ||
|
||
'atom-text-editor.autocomplete-active': | ||
'escape': 'autocomplete-plus:cancel' | ||
'f1': 'autocomplete-plus:navigate-to-description-more-link' |
Oops, something went wrong.