docs: Auto-generate vimdocs + vimtags (#597)

Co-authored-by: YaroSpace <5670940+YaroSpace@users.noreply.github.com>

Author: github-actions[bot]

doc/kulala.basic-usage.txt

@@ -116,7 +116,6 @@ METADATA
 
 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.

doc/kulala.configuration-options.txt

@@ -634,6 +634,13 @@ Example:
 <
 
 
+GENERATE_BUG_REPORT
+
+Generate a bug report on error.
+
+Default: `false`
+
+
 SCRIPTS           *kulala.configuration-options-configuration-options-scripts*
 
 
@@ -1152,7 +1159,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

doc/kulala.custom-curl-flags.txt

@@ -31,6 +31,9 @@ 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:
 

doc/kulala.graphql.txt

@@ -11,8 +11,10 @@ Table of Contents                           *kulala.graphql-table-of-contents*
 ==============================================================================
 1. GraphQL                                            *kulala.graphql-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.
 
@@ -24,7 +26,6 @@ title="gql-with-variables.http"
 >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) {
@@ -41,10 +42,8 @@ WITHOUT VARIABLES                   *kulala.graphql-graphql-without-variables*
 title="gql-without-variables.http"
 
 >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 {

doc/kulala.grpc.txt

@@ -85,7 +85,8 @@ example:
 <
 
 Flags set in variables override flags set in metatadata, which in turn override
-global flags.
+global flags. In order for global flags to take effect, the request where they
+are defined must be run at least once.
 
 Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
 

doc/kulala.public-methods.txt

@@ -147,14 +147,11 @@ 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 file will be downloaded to the directory where the current file is located.
 
-The filename will be `[http-file-name-without-extension].graphql-schema.json`.
+The filename will be `[request name].graphql-schema.json`.
 
-This file can be used in conjunction with the kulala-cmp-graphql
-https://github.com/mistweaverco/kulala-cmp-graphql.nvim plugin to provide
-autocompletion and type checking.
+This is required for the autocompletion and type checking to work.
 
 
 GET_SELECTED_ENV
@@ -176,6 +173,12 @@ https://learn.microsoft.com/en-us/aspnet/core/test/http-files?view=aspnetcore-8.
 If you omit the `env_key`, it’ll try to load up a telescope prompt to select
 an environment or fallback to using `vim.ui.select`.
 
+
+GENERATE_BUG_REPORT
+
+`require('kulala').generate_bug_report()` Generates a bug report and opens a
+GitHub issue with it.
+
 Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
 
 vim:tw=78:ts=8:noet:ft=help:norl:

doc/kulala.recipes.txt

@@ -51,6 +51,51 @@ UPLOADING A FILE
     ------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}}
+<
+
 Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
 
 vim:tw=78:ts=8:noet:ft=help:norl: