fix(parser): add nvim_treesitter/main compatibility (#592)

* fix(parser): add nvim_treesitter/main compatibility
* docs: update GraphQL
* feat: add automatic bug reporting
* fix(parser): update ts_grammar to support GRPC method
* fix(grpc): allow inline flags with `:`
* fix(ui): silence response formatting errors
* feat(parser): allow variables in curl and grpc flags

* feat(formatter): add sorting options

Author: YaroSpace

.github/ISSUE_TEMPLATE/bug_report.md

@@ -2,11 +2,19 @@
 name: Bug report
 about: Create a report to help us improve
 title: "[BUG] "
-labels: ''
+labels: bug
 assignees: ''
 
 ---
 
+The easiest way to submit a bug report is to set the option `generate_bug_report` in the config.
+
+This will offer to generate a bug report and open a GitHub Issue with it, when an error is encountered. 
+
+Alternatively, you can generate the report manually with `require("kulala").generate_bug_report()` or follow the template below.
+
+#
+
 **Describe the bug**
 A clear and concise description of what the bug is.
 

docs/docs/getting-started/configuration-options.mdx

@@ -436,6 +436,12 @@ Example:
 }
 ```
 
+### generate_bug_report
+
+Generate a bug report on error.
+
+Default: `false`
+
 ## Scripts
 
 ### scripts.node_path_resolver
@@ -922,7 +928,12 @@ Function called when Kulala LSP attaches to the buffer
     enable = true,
     keymaps = false, -- disabled by default, as Kulala relies on default Neovim LSP keymaps
     formatter = {
-      json_sort = true, -- sort JSON keys in request body
+      sort = { -- enable/disable alphabetical sorting in request body
+        metadata = true,
+        variables = true,
+        commands = true,
+        json = true,
+      },
     },
     on_attach = function(client, bufnr)
       -- custom on_attach function

docs/docs/usage/basic-usage.md

@@ -97,7 +97,6 @@ require("nvim-lightbulb").setup({
 
 #### Directives
 
-- `# @graphql` allows you to run a GraphQL query.
 - `# @accept chunked` allows you to accept Transfer-Encoding: chunked responses and streamed responses.
 - `# @curl-global-...` and `# @curl-...` allows you to set global and per-request flags for curl requests.
 - `# @grpc-global-...` and `# @grpc-...` allows you to set global and per-request flags for gRPC requests.

docs/docs/usage/custom-curl-flags.md

@@ -22,6 +22,7 @@ Local flags take precedence over global flags.
 
 If you need to apply curl flags to OAuth requests, you have to use `# @curl-global-..` flags.
 
+In order for global flags to take effect, the request where they are defined must be run at least once.
 :::
 
 ### Some common curl flags you might want to use:

docs/docs/usage/graphql.md

@@ -1,6 +1,8 @@
 # GraphQL
 
-You can use the `GRAPHQL` method (preferred), `@graphql` directive or `X-REQUEST-TYPE: GraphQL` header to send GraphQL requests.
+Use `GRAPHQL` method to indicate a GRAPHQL request.
+
+`@graphql` directive or `X-REQUEST-TYPE: GraphQL` header may also work, but are deprecated and will not activate all the features of the GraphQL request.
 
 Create a file with the `.http` extension and write your GraphQL requests in it.
 
@@ -9,7 +11,6 @@ Create a file with the `.http` extension and write your GraphQL requests in it.
 ```http title="gql-with-variables.http"
 GRAPHQL https://swapi-graphql.netlify.app/.netlify/functions/index HTTP/1.1
 Accept: application/json
-X-REQUEST-TYPE: GraphQL
 
 query Person($id: ID) {
   person(personID: $id) {
@@ -23,10 +24,8 @@ query Person($id: ID) {
 ## Without variables
 
 ```http title="gql-without-variables.http"
-# @graphql
-POST https://swapi-graphql.netlify.app/.netlify/functions/index HTTP/1.1
+GRAPHQL https://swapi-graphql.netlify.app/.netlify/functions/index HTTP/1.1
 Accept: application/json
-X-REQUEST-TYPE: GraphQL
 
 query Query {
   allFilms {

docs/docs/usage/grpc.md

@@ -70,5 +70,6 @@ Content-Type: application/json
 :::warning
 
 Flags set in variables override flags set in metatadata, which in turn override global flags.
+In order for global flags to take effect, the request where they are defined must be run at least once.
 
 :::

docs/docs/usage/public-methods.md

@@ -129,14 +129,12 @@ You can download the schema of a GraphQL server with:
 You need to have your cursor on a line with a GraphQL request.
 
 The file will be downloaded to
-the the directory where the current file is located.
+the directory where the current file is located.
 
 The filename will be
-`[http-file-name-without-extension].graphql-schema.json`.
+`[request name].graphql-schema.json`.
 
-This file can be used in conjunction with
-the [kulala-cmp-graphql][kulala-cmp-graphql] plugin to
-provide autocompletion and type checking.
+This is required for the autocompletion and type checking to work.
 
 ### get_selected_env
 
@@ -167,5 +165,9 @@ it'll try to load up a telescope prompt to
 select an environment or fallback to using `vim.ui.select`.
 
 [scratchpad_default_contents]: ../getting-started/configuration-options#uiscratchpad_default_contents
-[kulala-cmp-graphql]: https://github.com/mistweaverco/kulala-cmp-graphql.nvim
 [env-files]: https://learn.microsoft.com/en-us/aspnet/core/test/http-files?view=aspnetcore-8.0#environment-files
+
+### generate_bug_report
+
+`require('kulala').generate_bug_report()`
+Generates a bug report and opens a GitHub issue with it.

docs/docs/usage/recipes.md

@@ -40,3 +40,47 @@ Content-Type: {{content_type}}
 
 ------WebKitFormBoundary{{$timestamp}}--
 ```
+
+### Authenticating with browser-based auth
+
+```http
+
+### Acquire_XSRF_TOKEN
+
+GET localhost:8000/login
+
+> {%
+  -- lua
+  client.global.token = response.cookies["XSRF-TOKEN"].value
+  client.global.decoded_token = vim.uri_decode(client.global.token)
+  client.global.session = response.cookies["laravel_session"].value
+%}
+
+### Authentication
+
+POST localhost:8000/login
+Content-Type: application/json
+X-Xsrf-Token: {{decoded_token}}
+Cookie: XSRF-TOKEN={{token}}
+Cookie: laravel_session={{session}}
+Referer: http://localhost:8000/login
+
+{
+  "email": "mail@mail.com",
+  "password": "passpass"
+}
+
+> {%
+  -- lua
+  -- save the new set authenticated session
+  client.global.session = response.cookies["laravel_session"].value
+%}
+
+### Dashboard
+
+run #Acquire_XSRF_TOKEN
+run #Authentication
+
+GET http://localhost:8000/dashboard
+Cookie: laravel_session={{session}}
+```

lua/kulala/cmd/formatter.lua

@@ -4,7 +4,7 @@ local Json = require("kulala.utils.json")
 local Xml = require("kulala.utils.xml")
 
 local format_opts = Config.options.lsp.formatter
-format_opts = type(format_opts) == "table" and format_opts or { json_sort = true }
+format_opts = type(format_opts) == "table" and format_opts or { sort = { json = true } }
 
 local M = {}
 
@@ -191,7 +191,7 @@ format_rules = {
     local variable_declaration = ("@%s = %s"):format(name or "", value or "")
 
     table.insert(current_section().variables, variable_declaration)
-    table.sort(current_section().variables)
+    _ = format_opts.sort.variables and table.sort(current_section().variables)
 
     return variable_declaration
   end,
@@ -215,7 +215,7 @@ format_rules = {
     local metadata = str:format(name, value)
 
     table.insert(current_section().metadata, metadata)
-    table.sort(current_section().metadata)
+    _ = format_opts.sort.metadata and table.sort(current_section().metadata)
 
     return metadata
   end,
@@ -228,7 +228,7 @@ format_rules = {
     formatted = vars and formatted .. " (" .. vars .. ")" or formatted
 
     table.insert(current_section().commands, formatted)
-    table.sort(current_section().commands)
+    _ = format_opts.sort.commands and table.sort(current_section().commands)
 
     return formatted
   end,
@@ -238,7 +238,8 @@ format_rules = {
 
     local method = get_fields(node, "method") or "GET"
     local target_url = get_fields(node, "url") or ""
-    local http_version = get_fields(node, "version") or "HTTP/1.1"
+    local http_version = get_fields(node, "version")
+      or (method ~= "GRPC" and method ~= "WEBSOCKET" and method ~= "WS" and "HTTP/1.1" or "")
 
     local request = current_section().request
     request.url = ("%s %s %s"):format(method, target_url, http_version)
@@ -289,15 +290,15 @@ format_rules = {
 
   ["json_body"] = function(node)
     local json = get_text(node)
-    local formatted = Json.format(json, { sort = format_opts.json_sort }) or json
+    local formatted = Json.format(json, { sort = format_opts.sort.json }) or json
 
     current_section().request.body = formatted:gsub("\n*$", "")
     return formatted
   end,
 
   ["graphql_body"] = function(node)
     local body = get_text(node)
-    local formatted = Graphql.format(body, { sort = format_opts.json_sort }) or body
+    local formatted = Graphql.format(body, { sort = format_opts.sort.json }) or body
 
     current_section().request.body = formatted:gsub("\n*$", "")
     return formatted

lua/kulala/cmd/init.lua

@@ -65,7 +65,7 @@ function queue.run_next(self)
 
     if not (status and cb_status) then
       self:reset()
-      Logger.error(("Errors running a scheduled task: %s %s"):format(errors or "", cb_errors))
+      Logger.error(("Errors running a scheduled task: %s %s"):format(errors or "", cb_errors), 1, true)
     end
 
     self.done = self.done + 1
@@ -261,7 +261,7 @@ local function process_errors(request, request_status, processing_errors)
   )
 
   Logger.error(message, 2)
-  _ = processing_errors and Logger.error(processing_errors, 2)
+  _ = processing_errors and Logger.error(processing_errors, 2, true)
 
   request_status.errors = processing_errors and request_status.errors .. "\n" .. processing_errors
     or request_status.errors