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

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

Author: github-actions[bot]

doc/kulala.NEWS.txt

@@ -16,6 +16,9 @@ Table of Contents                              *kulala.NEWS-table-of-contents*
 VERSION 5.3.0                          *kulala.NEWS-kulala-news-version-5.3.0*
 
 
+FEATURE: SCRIPTING REQUEST.ITERATION() - CURRENT COUNT OF REPLAYS LUA, JS  |kulala.lua-scripts.txt|  |kulala.request-reference.txt|
+
+
 ENHANCEMENT: CONFIG OPTION KULALA_KEYMAPS_PREFIX TO SET CUSTOM PREFIX FOR KULALA KEYMAPS
 
 

doc/kulala.demos.txt

@@ -242,13 +242,9 @@ The archive |kulala.demos.zip| also contains sample `httt-client-env.json` and
       const results = client.global.get("results");
       if (!results) { return; }
 
-      var idx = (request.variables.get("idx") ?? -1) + 1; // initialize index
-      request.variables.set("idx", idx); // update index
-    
-      const item = results[idx];
+      const item = results[request.iteration() - 1]; // get item by index
 
       if (!item) { 
-        request.variables.set("idx", -1); // reset index
         client.global.set("results", null);
         return request.skip(); // skip if no more items
       }
@@ -273,9 +269,7 @@ The archive |kulala.demos.zip| also contains sample `httt-client-env.json` and
       local response = client.responses["Request_one"].json
       if not response then return end
 
-      request.environment.idx = (request.environment.idx or 0) + 1 -- initialize index
-      local item = response.json.results[request.environment.idx]
-    
+      local item = response.json.results[request.iteration()]
       if not item then return request.skip() end   -- skip if no more items
 
       client.log(item)

doc/kulala.lua-scripts.txt

@@ -69,6 +69,8 @@ REQUEST
     local request = {
       skip = function() end, -- skip the request (useful in pre-request scripts)
       replay = function() end, -- replay the request (useful in post-request scripts)
+      variables = {}, -- request variables, alias for environment (for compatibility with JS scripting)
+      iteration = function() end, -- the current count of request replays
     }
 <
 
@@ -240,12 +242,10 @@ ITERATING OVER RESULTS AND MAKING REQUESTS FOR EACH ITEM
 
     < {%
       -- lua
-      local response = client.responses["Request_one"].json
+      local response = client.responses["Request_one"].json -- get body of the response decoded as json
       if not response then return end
 
-      request.environment.idx = (request.environment.idx or 0) + 1 -- initialize index
-      local item = response.results[request.environment.idx]
-    
+      local item = response.json.results[request.iteration()]
       if not item then return request.skip() end   -- skip if no more items
 
       client.log(item)

doc/kulala.request-reference.txt

@@ -17,6 +17,7 @@ Table of Contents                 *kulala.request-reference-table-of-contents*
   - request.url.tryGetSubstituted|kulala.request-reference-scripts-request-reference-request.url.trygetsubstituted|
   - request.skip|kulala.request-reference-scripts-request-reference-request.skip|
   - request.replay|kulala.request-reference-scripts-request-reference-request.replay|
+  - request.iteration|kulala.request-reference-scripts-request-reference-request.iteration|
 
 ==============================================================================
 1. Scripts request reference*kulala.request-reference-scripts-request-reference*
@@ -233,6 +234,15 @@ Replays the current request. Useful for conditional requests, see below.
 <
 
 
+REQUEST.ITERATION*kulala.request-reference-scripts-request-reference-request.iteration*
+
+Returns the current count of request replays.
+
+>javascript
+    request.replay();
+<
+
+
 CONDITIONAL REQUESTS
 
 >http
@@ -283,13 +293,9 @@ ITERATING OVER RESULTS AND MAKING REQUESTS FOR EACH ITEM
       const results = client.global.get("results");
       if (!results) { return; }
 
-      var idx = (request.variables.get("idx") ?? -1) + 1; // initialize index
-      request.variables.set("idx", idx); // update index
-    
-      const item = results[idx];
+      const item = results[request.iteration() - 1]; // get item by index
 
       if (!item) { 
-        request.variables.set("idx", -1); // reset index
         client.global.set("results", null);
         return request.skip(); // skip if no more items
       }