fix: GitHub token process improvements and incorrect documentation

Author: AntoineGS

README.md

@@ -15,6 +15,7 @@ As lua is far more efficient and makes things easier to integrate with modern pl
 
 - Curl
 - NeoVim 0.10.0 or higher
+- NodeJS v20 or higher if using the default nodejs LSP version
 
 ## Install
 
@@ -29,21 +30,27 @@ use { "zbirenbaum/copilot.lua" }
 
 You can authenticate using one of the following methods:
 
-#### Permanent sign-in (Recommended)
+<details>
+<summary>Permanent sign-in (Recommended)</summary>
 
 Once copilot is running, run `:Copilot auth` to start the authentication process.
 
-#### Token
+</details>
 
-Get a token from the github cli using:
+<details>
+<summary>Token (not officially supported)</summary>
 
-```sh
-gh auth token
-```
+Tokens given by `gh auth token` do not support Copilot, you therefore need to first generate a token through the LSP by:
+
+- Authenticating using the `Permanent sign-in` method
+- Grab the token by running `:Copilot auth info`
+- You can then safely delete the `github-copilot` folder created in your NeoVim base data directory.
 
 Set either the environment variable `GITHUB_COPILOT_TOKEN` or `GH_COPILOT_TOKEN` to that token.
 Note that if you have the variable set, even empty, the LSP will attempt to use it to log in.
 
+</details>
+
 #### Authentication with Alternate GitHub Instances
 
 If your access to Copilot is not provided by the public GitHub instance, you can set your
@@ -385,7 +392,7 @@ example:
 require("copilot").setup {
   server = {
     type = "nodejs",
-    custom_server_filepath = "/home/user/copilot-lsp/language-server.js",,
+    custom_server_filepath = "/home/user/copilot-lsp/language-server.js",
   },
 }
 ```

lua/copilot/auth/init.lua

@@ -132,7 +132,7 @@ function M.signout()
   end)
 end
 
-local function find_config_path()
+function M.find_config_path()
   local config = vim.fn.expand("$XDG_CONFIG_HOME")
   if config and vim.fn.isdirectory(config) > 0 then
     return config
@@ -151,16 +151,33 @@ local function find_config_path()
   end
 end
 
-local function oauth_user(token)
-  return vim.fn.system('curl -s --header "Authorization: Bearer ' .. token .. '" https://api.github.com/user')
+M.get_creds = function()
+  local filename = M.find_config_path() .. "/github-copilot/apps.json"
+
+  if vim.fn.filereadable(filename) == 0 then
+    logger.error("Copilot auth file could not be read from:" .. filename)
+    return
+  end
+
+  local filedata = vim.api.nvim_eval("readfile('" .. filename .. "')")
+
+  if not filedata or #filedata == 0 then
+    logger.error("Copilot's apps.json file not found or empty, make sure to sign in first")
+    return
+  end
+
+  local appsdata = vim.json.decode(filedata[1])
+  return appsdata
 end
 
-M.get_cred = function()
-  local userdata =
-    vim.json.decode(vim.api.nvim_eval("readfile('" .. find_config_path() .. "/github-copilot/hosts.json')")[1])
-  local token = userdata["github.com"].oauth_token
-  local user = oauth_user(token)
-  return { user = user, token = token }
+function M.info()
+  local info = M.get_creds()
+  if not info then
+    logger.error("no GitHub Copilot token found, make sure to sign in first")
+    return
+  end
+
+  logger.notify("GitHub Copilot token information: ", info)
 end
 
 return M

plugin/copilot.lua

@@ -1,6 +1,6 @@
 local completion_store = {
   [""] = { "auth", "attach", "detach", "disable", "enable", "panel", "status", "suggestion", "toggle", "version" },
-  auth = { "signin", "signout" },
+  auth = { "signin", "signout", "info" },
   panel = { "accept", "jump_next", "jump_prev", "open", "refresh" },
   suggestion = { "accept", "accept_line", "accept_word", "dismiss", "next", "prev", "toggle_auto_trigger" },
   workspace = { "add" },