feat: add json schema for http-client.env.json (mistweaverco#243)

* feat: add json schema for http-client.env.json * fix: allow $schema key * breaking(env): change `_base` to `$shared` Change `_base` to `$shared` and `DEFAULT_HEADERS` to `$default_headers`. * feat(schema): allow number * refactor(env): rename base to shared * fix(env): don't list special keys * feat(docs): add $schema to json example * chore(rename): add `.schema` as suffix. * chore(docs): change `_base` to `$shared`
iamxiaojianzheng · Oct 24, 2024 · a0cd020 · a0cd020
1 parent f03ffdd
commit a0cd020
Show file tree

Hide file tree

Showing 9 changed files with 74 additions and 22 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,7 @@
 node_modules
 .env
 http-client.env.json
+!/schemas/http-client.env.json
 *.http
 *graphql-schema.json
 /http-examples

diff --git a/docs/docs/getting-started/configuration-options.md b/docs/docs/getting-started/configuration-options.md
@@ -537,8 +537,7 @@ Example:
 If enabled, Kulala searches for
 `.vscode/settings.json` or `*.code-workspace`
 files in the current directory and
-its parents to read the `rest-client.environmentVariables` definitions
-(`$shared` will be treated as `_base`).
+its parents to read the `rest-client.environmentVariables` definitions.
 
 If `http-client.env.json` is also present,
 it'll be merged (and overwrites variables from VSCode).

diff --git a/docs/docs/usage/dotenv-and-http-client.env.json-support.md b/docs/docs/usage/dotenv-and-http-client.env.json-support.md
@@ -37,6 +37,7 @@ define environment variables in it.
 
 ```json title="http-client.env.json"
 {
+  "$schema": "https://raw.githubusercontent.com/mistweaverco/kulala.nvim/main/schemas/http-client.env.schema.json",
   "dev": {
     "API_KEY": "your-api-key"
   },
@@ -90,15 +91,17 @@ Authorization: Bearer {{API_KEY}}
 
 You can define default HTTP headers in the `http-client.env.json` file.
 
-You need to put them in the special `_base` property and
-the `DEFAULT_HEADERS` will be merged with the headers from the HTTP requests.
+You need to put them in the special `$shared` property and
+the `$default_headers` will be merged with the headers from the HTTP requests.
 
 ```json title="http-client.env.json"
 {
-  "_base": {
-    "DEFAULT_HEADERS": {
+  "$schema": "https://raw.githubusercontent.com/mistweaverco/kulala.nvim/main/schemas/http-client.env.schema.json",
+  "$shared": {
+    "$default_headers": {
       "Content-Type": "application/json",
       "Accept": "application/json"
+    },
   },
   "dev": {
     "API_KEY": "your-api-key"

diff --git a/lua/kulala/db/init.lua b/lua/kulala/db/init.lua
@@ -9,7 +9,7 @@ local function default_data()
   return {
     selected_env = nil, -- string - name of selected env
     http_client_env = nil, -- table of envs from http-client.env.json
-    http_client_env_base = nil, -- table of base env values which should be applied to all requests
+    http_client_env_shared = nil, -- table of base env values which should be applied to all requests
     env = {}, -- table of envs from document sources
     scope_nr = nil, -- number - buffer number of the current scope
   }

diff --git a/lua/kulala/parser/env.lua b/lua/kulala/parser/env.lua
@@ -13,7 +13,7 @@ M.get_env = function()
     env[key] = value
   end
 
-  DB.update().http_client_env_base = {}
+  DB.update().http_client_env_shared = {}
   DB.update().http_client_env = {}
 
   if Config.get().vscode_rest_client_environmentvars then
@@ -29,8 +29,8 @@ M.get_env = function()
         if settings and settings["rest-client.environmentVariables"] then
           local f = settings["rest-client.environmentVariables"]
           if f["$shared"] then
-            DB.update().http_client_env_base =
-              vim.tbl_deep_extend("force", DB.find_unique("http_client_env_base"), f["$shared"])
+            DB.update().http_client_env_shared =
+              vim.tbl_deep_extend("force", DB.find_unique("http_client_env_shared"), f["$shared"])
           end
           f["$shared"] = nil
           DB.update().http_client_env = vim.tbl_deep_extend("force", DB.find_unique("http_client_env"), f)
@@ -44,8 +44,8 @@ M.get_env = function()
       if settings and settings["rest-client.environmentVariables"] then
         local f = settings["rest-client.environmentVariables"]
         if f["$shared"] then
-          DB.update().http_client_env_base =
-            vim.tbl_deep_extend("force", DB.find_unique("http_client_env_base"), f["$shared"])
+          DB.update().http_client_env_shared =
+            vim.tbl_deep_extend("force", DB.find_unique("http_client_env_shared"), f["$shared"])
         end
         f["$shared"] = nil
         DB.update().http_client_env = vim.tbl_deep_extend("force", DB.find_unique("http_client_env"), f)
@@ -68,16 +68,17 @@ M.get_env = function()
 
   if http_client_env_json then
     local f = vim.fn.json_decode(vim.fn.readfile(http_client_env_json))
-    if f._base then
-      DB.update().http_client_env_base = vim.tbl_deep_extend("force", DB.find_unique("http_client_env_base"), f._base)
+    if f["$shared"] then
+      DB.update().http_client_env_shared =
+        vim.tbl_deep_extend("force", DB.find_unique("http_client_env_shared"), f["$shared"])
     end
-    f._base = nil
+    f["$shared"] = nil
     DB.update().http_client_env = vim.tbl_deep_extend("force", DB.find_unique("http_client_env"), f)
   end
 
-  local http_client_env_base = DB.find_unique("http_client_env_base") or {}
-  for key, value in pairs(http_client_env_base) do
-    if key ~= "DEFAULT_HEADERS" then
+  local http_client_env_shared = DB.find_unique("http_client_env_shared") or {}
+  for key, value in pairs(http_client_env_shared) do
+    if key ~= "$default_headers" then
       env[key] = value
     end
   end

diff --git a/lua/kulala/parser/init.lua b/lua/kulala/parser/init.lua
@@ -534,9 +534,9 @@ function M.parse(start_request_linenr)
     end
   end
 
-  -- Merge headers from the _base environment if it exists
-  if DB.find_unique("http_client_env_base") then
-    local default_headers = DB.find_unique("http_client_env_base")["DEFAULT_HEADERS"]
+  -- Merge headers from the $shared environment if it exists
+  if DB.find_unique("http_client_env_shared") then
+    local default_headers = DB.find_unique("http_client_env_shared")["$default_headers"]
     if default_headers then
       for key, value in pairs(default_headers) do
         key = key:lower()

diff --git a/lua/kulala/ui/selector.lua b/lua/kulala/ui/selector.lua
@@ -11,6 +11,9 @@ function M.select_env()
 
   local envs = {}
   for key, _ in pairs(http_client_env) do
+    if key ~= "$schema" and key ~= "$shared" then
+      table.insert(envs, key)
+    end
     table.insert(envs, key)
   end
 

diff --git a/lua/telescope/_extensions/kulala.lua b/lua/telescope/_extensions/kulala.lua
@@ -52,7 +52,9 @@ local function kulala_env_select(_)
 
   local envs = {}
   for key, _ in pairs(http_client_env) do
-    table.insert(envs, key)
+    if key ~= "$schema" and key ~= "$shared" then
+      table.insert(envs, key)
+    end
   end
 
   pickers

diff --git a/schemas/http-client.env.schema.json b/schemas/http-client.env.schema.json
@@ -0,0 +1,43 @@
+{
+  "$id": "https://raw.githubusercontent.com/mistweaverco/kulala.nvim/main/schemas/http-client.env.schema.json",
+  "title": "HTTP Client Environment Variables",
+  "description": "The environment variables required for the HTTP client",
+  "type": "object",
+  "properties": {
+    "$schema": {
+      "type": "string"
+    },
+    "$shared": {
+      "type": "object",
+      "properties": {
+        "$default_headers": {
+          "type": "object",
+          "patternProperties": {
+            "^.*$": {
+              "type": "string"
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "patternProperties": {
+        "^([A-Za-z0-9_]+)$": {
+          "type": ["string", "number"]
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "patternProperties": {
+    "^.*$": {
+      "type": "object",
+      "patternProperties": {
+        "^([A-Za-z0-9_]+)$": {
+          "type": ["string", "number"]
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false
+}