Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/TerminalFi/LSP-copilot

GitHub Copilot support for Sublime Text LSP plugin provided through Copilot.vim.
https://github.com/TerminalFi/LSP-copilot

Last synced: 16 days ago
JSON representation

GitHub Copilot support for Sublime Text LSP plugin provided through Copilot.vim.

Awesome Lists containing this project

README 

        
# LSP-copilot



![Copilot](https://raw.githubusercontent.com/TheSecEng/LSP-copilot/master/docs/screenshot.png)



GitHub Copilot support for Sublime Text LSP plugin provided through [Copilot.vim][].



This plugin uses [Copilot][] distribution which uses OpenAI Codex to suggest codes

and entire functions in real-time right from your editor.



## Features



- [x] Inline completion popup.

- [x] Inline completion phantom.

- [x] Panel completion.

- [x] Chat.



## Prerequisites



* Public network connection.

* Active GitHub Copilot subscription.



## Installation



1. Install [LSP][] and [LSP-copilot][] via Package Control.

1. Restart Sublime Text.



## Setup



On the first time use, follow the steps below:



1. Open any file.

1. Execute `Copilot: Sign In` from the command palette.

1. Follow the prompts to authenticate LSP-copilot.

    1. The `User Code` will be auto copied to your clipboard.

    1. Paste the `User Code` into the pop-up GitHub authentication page.

    1. Return to Sublime Text and press `OK` on the dialog.

    1. If you see a "sign in OK" dialog, LSP-copilot should start working since then.



## Settings



Settings are provide in the `LSP-copilot.sublime-settings` file, accessible using `Preferences: LSP-copilot Settings` in the command palette.



| Setting                       | Type    | Default | Description                                                                                                                                           |

|-------------------------------|---------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------|

| auto_ask_completions          | boolean | true    | Auto ask the server for completions. Otherwise, you have to trigger it manually.                                                                      |

| debug                         | boolean | false   | Enables `debug` mode for LSP-copilot. Enabling all commands regardless of status requirements.                                                        |

| hook_to_auto_complete_command | boolean | false   | Ask the server for completions when the `auto_complete` command is called.                                                                            |

| authProvider                  | string  |         | The GitHub identity to use for Copilot

| github-enterprise             | object  |         | The configuration for Github Enterprise                                                                                                          |

| local_checks                  | boolean | false   | Enables local checks. This feature is not fully understood yet.                                                                                       |

| telemetry                     | boolean | false   | Enables Copilot telemetry requests for `Accept` and `Reject` completions.                                                                             |

| proxy                         | string  |         | The HTTP proxy to use for Copilot requests. It's in the form of `username:password@host:port` or just `host:port`.                                    |

| completion_style              | string  | popup   | Completion style. `popup` is the default, `phantom` is experimental ([there are well-known issues](https://github.com/TheSecEng/LSP-copilot/issues)). |



## Screenshots



### Inline Completion Popup



![Copilot](https://raw.githubusercontent.com/TheSecEng/LSP-copilot/master/docs/screenshot.png)



### Inline Completion Phantom



![Copilot](https://raw.githubusercontent.com/TheSecEng/LSP-copilot/master/docs/phantom.png)



### Panel Completion



![Copilot](https://raw.githubusercontent.com/TheSecEng/LSP-copilot/master/docs/panel.png)



### Chat



![Copilot](https://raw.githubusercontent.com/TheSecEng/LSP-copilot/master/docs/chat.png)



## FAQs



### I don't want to use `Tab` for committing Copilot's completion



It's likely that Copilot's completion appears along with Sublime Text's autocompletion

and both of them use `Tab` for committing the completion. This may cause a nondeterministic result.



Thus, you may want to let only one of them (or none) use the `Tab` key.

If you don't want LSP-copilot to use the `Tab` key for committing the completion.

You can set LSP-copilot's `commit_completion_on_tab` setting to `false` and add a custom keybinding like below.



```js

{

    "keys": ["YOUR_OWN_DEDICATE_KEYBINDING"],

    "command": "copilot_accept_completion",

    "context": [

        {

            "key": "copilot.is_on_completion"

        }

    ]

},

```



### I see `UNABLE_TO_GET_ISSUER_CERT_LOCALLY` error



If working behind a VPN and/or Proxy, you may be required to add your CA file into the NODE environment.

See below for LSP-copilots support for this.



In LSP-copilot's plugin settings, add the following `env` key:



 ```js

 {

   "env": {

       "NODE_EXTRA_CA_CERTS": "/path/to/certificate.crt",

   },

   // other custom settings...

 }

 ```



[Copilot]: https://github.com/features/copilot

[Copilot.vim]: https://github.com/github/copilot.vim

[LSP]: https://packagecontrol.io/packages/LSP

[LSP-copilot]: https://packagecontrol.io/packages/LSP-copilot