From 92897b00d0f9494cd75fdf20ddd71a0b12d355bb Mon Sep 17 00:00:00 2001 From: Yee Cheng Chin Date: Tue, 13 Jun 2023 16:39:32 +0800 Subject: [PATCH 1/2] Copilot: Add Vim to docs to make it clear it supports both Vim/Neovim (#24625) Co-authored-by: Jules <19994093+jules-p@users.noreply.github.com> --- ...ring-github-copilot-in-your-environment.md | 8 ++-- .../getting-started-with-github-copilot.md | 48 ++++++++++++------- .../about-github-copilot-for-individuals.md | 2 +- ...ting-github-copilot-in-your-environment.md | 6 +-- ... => config-enable-copilot-in-vimneovim.md} | 4 +- .../copilot/install-copilot-in-neovim.md | 1 - .../copilot/install-copilot-in-vimneovim.md | 1 + lib/all-tools.js | 2 +- 8 files changed, 44 insertions(+), 28 deletions(-) rename data/reusables/copilot/{config-enable-copilot-in-neovim.md => config-enable-copilot-in-vimneovim.md} (65%) delete mode 100644 data/reusables/copilot/install-copilot-in-neovim.md create mode 100644 data/reusables/copilot/install-copilot-in-vimneovim.md diff --git a/content/copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment.md b/content/copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment.md index 35ca765a5a..e242cbd444 100644 --- a/content/copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment.md +++ b/content/copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment.md @@ -323,16 +323,16 @@ You can configure {% data variables.product.prodname_copilot %} to connect throu {% endvscode %} -{% neovim %} +{% vimneovim %} -## Configuring {% data variables.product.prodname_copilot %} in Neovim +## Configuring {% data variables.product.prodname_copilot %} in Vim/Neovim -For guidance on configuring {% data variables.product.prodname_copilot %} in Neovim, invoke the {% data variables.product.prodname_copilot %} documentation in Neovim by running the following command: +For guidance on configuring {% data variables.product.prodname_copilot %} in Vim/Neovim, invoke the {% data variables.product.prodname_copilot %} documentation in Vim/Neovim by running the following command: :help copilot {% data reusables.copilot.dotcom-settings %} -{% endneovim %} +{% endvimneovim %} diff --git a/content/copilot/getting-started-with-github-copilot.md b/content/copilot/getting-started-with-github-copilot.md index f6888e806b..566dffcc99 100644 --- a/content/copilot/getting-started-with-github-copilot.md +++ b/content/copilot/getting-started-with-github-copilot.md @@ -350,54 +350,70 @@ You can also use {% data variables.product.prodname_copilot %} to generate sugge {% endvscode %} -{% neovim %} +{% vimneovim %} -## About {% data variables.product.prodname_copilot %} and Neovim +## About {% data variables.product.prodname_copilot %} and Vim/Neovim {% data reusables.copilot.procedural-intro %} -If you use Neovim, you can view and incorporate suggestions from {% data variables.product.prodname_copilot %} directly within the editor. +If you use Vim/Neovim, you can view and incorporate suggestions from {% data variables.product.prodname_copilot %} directly within the editor. ## Prerequisites {% data reusables.copilot.subscription-prerequisite %} -- To use {% data variables.product.prodname_copilot %} in Neovim you must have Neovim version 0.6 or above and Node.js version 17 or below installed. For more information, see the [Neovim documentation](https://neovim.io/doc/) and the [Node.js website](https://nodejs.org/en/). +- To use {% data variables.product.prodname_copilot %} in Vim/Neovim you must have Vim version 9.0.0185 / Neovim version 0.6 or above and Node.js version 17 or below installed. For more information, see the [Vim](https://vimhelp.org/) / [Neovim documentation](https://neovim.io/doc/) and the [Node.js website](https://nodejs.org/en/). + +## Installing the Vim/Neovim extension on macOS + +{% data reusables.copilot.install-copilot-in-vimneovim %} + - To install {% data variables.product.prodname_copilot %} with Vim's built-in plugin manager, enter the following command in Terminal: + + git clone https://github.com/github/copilot.vim \ + ~/.vim/pack/github/start/copilot.vim -## Installing the Neovim extension on macOS -{% data reusables.copilot.install-copilot-in-neovim %} - To install {% data variables.product.prodname_copilot %} with Neovim's built-in plugin manager, enter the following command in Terminal: git clone https://github.com/github/copilot.vim \ ~/.config/nvim/pack/github/start/copilot.vim -{% data reusables.copilot.config-enable-copilot-in-neovim %} +{% data reusables.copilot.config-enable-copilot-in-vimneovim %} -## Installing the Neovim extension on Windows +## Installing the Vim/Neovim extension on Windows + +{% data reusables.copilot.install-copilot-in-vimneovim %} + - To install {% data variables.product.prodname_copilot %} with Vim's built-in plugin manager, enter the following command in Git Bash: + + git clone https://github.com/github/copilot.vim.git \ + $HOME/vimfiles/pack/github/start/copilot.vim -{% data reusables.copilot.install-copilot-in-neovim %} - To install {% data variables.product.prodname_copilot %} with Neovim's built-in plugin manager, enter the following command in Git Bash: git clone https://github.com/github/copilot.vim.git \ $HOME/AppData/Local/nvim/pack/github/start/copilot.vim -{% data reusables.copilot.config-enable-copilot-in-neovim %} +{% data reusables.copilot.config-enable-copilot-in-vimneovim %} -## Installing the Neovim extension on Linux +## Installing the Vim/Neovim extension on Linux + +{% data reusables.copilot.install-copilot-in-vimneovim %} + - To install {% data variables.product.prodname_copilot %} with Vim's built-in plugin manager, enter the following command: + + git clone https://github.com/github/copilot.vim \ + ~/.vim/pack/github/start/copilot.vim -{% data reusables.copilot.install-copilot-in-neovim %} - To install {% data variables.product.prodname_copilot %} with Neovim's built-in plugin manager, enter the following command: git clone https://github.com/github/copilot.vim \ ~/.config/nvim/pack/github/start/copilot.vim -{% data reusables.copilot.config-enable-copilot-in-neovim %} +{% data reusables.copilot.config-enable-copilot-in-vimneovim %} -## Learning to use {% data variables.product.prodname_copilot %} in Neovim +## Learning to use {% data variables.product.prodname_copilot %} in Vim/Neovim -For guidance on using {% data variables.product.prodname_copilot %} in Neovim, you can view the plugin documentation. To see the documentation, open Neovim and run the following command: +For guidance on using {% data variables.product.prodname_copilot %} in Vim/Neovim, you can view the plugin documentation. To see the documentation, open Vim/Neovim and run the following command: ``` :help copilot @@ -408,5 +424,5 @@ For guidance on using {% data variables.product.prodname_copilot %} in Neovim, y - [{% data variables.product.prodname_copilot %}](https://copilot.github.com/) -{% endneovim %} +{% endvimneovim %} diff --git a/content/copilot/overview-of-github-copilot/about-github-copilot-for-individuals.md b/content/copilot/overview-of-github-copilot/about-github-copilot-for-individuals.md index 36cb8a8a99..7907964762 100644 --- a/content/copilot/overview-of-github-copilot/about-github-copilot-for-individuals.md +++ b/content/copilot/overview-of-github-copilot/about-github-copilot-for-individuals.md @@ -16,7 +16,7 @@ redirect_from: {% data variables.product.prodname_copilot %} is trained on all languages that appear in public repositories. For each language, the quality of suggestions you receive may depend on the volume and diversity of training data for that language. For example, JavaScript is well-represented in public repositories and is one of {% data variables.product.prodname_copilot %}'s best supported languages. Languages with less representation in public repositories may produce fewer or less robust suggestions. -{% data variables.product.prodname_copilot %} is available as an extension in Visual Studio Code, Visual Studio, Neovim and the JetBrains suite of IDEs. For more information, see "[AUTOTITLE](/copilot/getting-started-with-github-copilot)." +{% data variables.product.prodname_copilot %} is available as an extension in Visual Studio Code, Visual Studio, Vim, Neovim and the JetBrains suite of IDEs. For more information, see "[AUTOTITLE](/copilot/getting-started-with-github-copilot)." ### Understanding the differences between {% data variables.product.prodname_copilot_individuals_short %} and {% data variables.product.prodname_copilot_business_short %} diff --git a/content/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-your-environment.md b/content/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-your-environment.md index b23eb53b52..d4d36ebbac 100644 --- a/content/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-your-environment.md +++ b/content/copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-your-environment.md @@ -119,13 +119,13 @@ In rare cases, errors might not be propagated to the corresponding error handler {% endvscode %} -{% neovim %} +{% vimneovim %} ## Checking if {% data variables.product.prodname_copilot%} is operational -To check if GitHub Copilot is operational, run the following command in Neovim: +To check if GitHub Copilot is operational, run the following command in Vim/Neovim: :Copilot status -{% endneovim %} \ No newline at end of file +{% endvimneovim %} diff --git a/data/reusables/copilot/config-enable-copilot-in-neovim.md b/data/reusables/copilot/config-enable-copilot-in-vimneovim.md similarity index 65% rename from data/reusables/copilot/config-enable-copilot-in-neovim.md rename to data/reusables/copilot/config-enable-copilot-in-vimneovim.md index 5ffb61eaa5..eae2b244a1 100644 --- a/data/reusables/copilot/config-enable-copilot-in-neovim.md +++ b/data/reusables/copilot/config-enable-copilot-in-vimneovim.md @@ -1,10 +1,10 @@ -1. To configure {% data variables.product.prodname_copilot %}, open Neovim and enter the following command. +1. To configure {% data variables.product.prodname_copilot %}, open Vim/Neovim and enter the following command. ``` :Copilot setup ``` -1. Enable {% data variables.product.prodname_copilot %} in your Neovim configuration, or with the Neovim command. +1. Enable {% data variables.product.prodname_copilot %} in your Vim/Neovim configuration, or with the Vim/Neovim command. ``` :Copilot enable diff --git a/data/reusables/copilot/install-copilot-in-neovim.md b/data/reusables/copilot/install-copilot-in-neovim.md deleted file mode 100644 index 4b10c8048b..0000000000 --- a/data/reusables/copilot/install-copilot-in-neovim.md +++ /dev/null @@ -1 +0,0 @@ -1. {% data variables.product.prodname_dotcom %} recommends that you install the {% data variables.product.prodname_copilot %} plugin with Neovim's built-in plugin manager. Alternatively, you can use a plugin manager of your choice to install `github/copilot.vim`. diff --git a/data/reusables/copilot/install-copilot-in-vimneovim.md b/data/reusables/copilot/install-copilot-in-vimneovim.md new file mode 100644 index 0000000000..a71f76fd1e --- /dev/null +++ b/data/reusables/copilot/install-copilot-in-vimneovim.md @@ -0,0 +1 @@ +1. {% data variables.product.prodname_dotcom %} recommends that you install the {% data variables.product.prodname_copilot %} plugin with Vim/Neovim's built-in plugin manager. Alternatively, you can use a plugin manager of your choice to install `github/copilot.vim`. diff --git a/lib/all-tools.js b/lib/all-tools.js index 6d5de7d547..ce3cd55a81 100644 --- a/lib/all-tools.js +++ b/lib/all-tools.js @@ -9,7 +9,7 @@ export const allTools = { importer_cli: 'GitHub Enterprise Importer CLI', javascript: 'JavaScript', jetbrains: 'JetBrains IDEs (Beta)', - neovim: 'Neovim', + vimneovim: 'Vim/Neovim', powershell: 'PowerShell', visualstudio: 'Visual Studio', vscode: 'Visual Studio Code', From 5f39e96a44c95bdd5fe44fae8707d4ed69fd5dc1 Mon Sep 17 00:00:00 2001 From: Paul DeCarlo Date: Tue, 13 Jun 2023 03:39:43 -0500 Subject: [PATCH 2/2] Update to include mention of SQL query generation (#24421) Co-authored-by: Jules <19994093+jules-p@users.noreply.github.com> --- data/reusables/copilot/supported-languages.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/reusables/copilot/supported-languages.md b/data/reusables/copilot/supported-languages.md index 3568cc314a..fd91a1fb48 100644 --- a/data/reusables/copilot/supported-languages.md +++ b/data/reusables/copilot/supported-languages.md @@ -1 +1 @@ -{% data variables.product.prodname_copilot %} provides suggestions for numerous languages and a wide variety of frameworks, but works especially well for Python, JavaScript, TypeScript, Ruby, Go, C# and C++. +{% data variables.product.prodname_copilot %} provides suggestions for numerous languages and a wide variety of frameworks, but works especially well for Python, JavaScript, TypeScript, Ruby, Go, C# and C++. {% data variables.product.prodname_copilot %} can also assist in query generation for databases.