feat: add config api to print difference between current config and default

Author: MeanderingProgrammer

CHANGELOG.md

@@ -15,12 +15,19 @@
 - integrate with lazy.nvim filetypes [cb9a5e2](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/cb9a5e2412d21c7a89627e0d6da5459acbc0eb9c)
 - bullet left & right padding on all lines of items [#181](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/181)
   [3adb9d5](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/3adb9d539a016bc63fee83aa740e38fa4eeab094)
-
+- heading margin / padding based on level [#182](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/182)
+  & border virtual option [#183](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/183)
+  [aad1a12](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/aad1a1220dc9da5757e3af3befbc7fc3869dd334)
 
 ### Bug Fixes
 
 - window options on alternate buffer switch [#177](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/177)
   [f187721](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/f187721a5381f4443ef97ad1a7c0681a65511d28)
+- update when window scrolled [#185](https://github.com/MeanderingProgrammer/render-markdown.nvim/pull/185)
+
+### Collaborator Shoutouts
+
+- @Bekaboo
 
 ## 7.1.0 (2024-09-19)
 

README.md

@@ -106,6 +106,7 @@ use({
 | `:RenderMarkdown expand`   | `require('render-markdown').expand()`   | Increase anti-conceal margin above and below by 1 |
 | `:RenderMarkdown contract` | `require('render-markdown').contract()` | Decrease anti-conceal margin above and below by 1 |
 | `:RenderMarkdown debug`    | `require('render-markdown').debug()`    | Prints information about marks on current line    |
+| `:RenderMarkdown config`   | `require('render-markdown').config()`   | Prints difference between config and default      |
 
 # Setup
 

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*         For 0.10.0        Last change: 2024 September 24
+*render-markdown.txt*         For 0.10.0        Last change: 2024 September 25
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
@@ -150,6 +150,9 @@ PACKER.NVIM                              *render-markdown-install-packer.nvim*
 
   :RenderMarkdown debug      require('render-markdown').debug()      Prints information about marks
                                                                      on current line
+
+  :RenderMarkdown config     require('render-markdown').config()     Prints difference between
+                                                                     config and default
   -------------------------------------------------------------------------------------------------
 
 ==============================================================================

lua/render-markdown/api.lua

@@ -36,4 +36,13 @@ function M.debug()
     require('render-markdown.debug.marks').debug(row, marks)
 end
 
+function M.config()
+    local difference = state.difference(require('render-markdown').default_config)
+    if vim.tbl_count(difference) == 0 then
+        vim.print('Default Configuration')
+    else
+        vim.print(difference)
+    end
+end
+
 return M

lua/render-markdown/debug/diff.lua

@@ -0,0 +1,38 @@
+---@alias render.md.debug.Key string|integer
+
+---@class render.md.debug.Diff
+local M = {}
+
+---@param t1 table<render.md.debug.Key, any>
+---@param t2 table<render.md.debug.Key, any>
+---@return table<render.md.debug.Key, any>
+function M.get(t1, t2)
+    local result, keys = {}, {}
+    M.append_keys(keys, t1)
+    M.append_keys(keys, t2)
+    for _, key in ipairs(keys) do
+        local v1, v2 = t1[key], t2[key]
+        if type(v1) == 'table' and type(v2) == 'table' then
+            local nested = M.get(v1, v2)
+            if vim.tbl_count(nested) > 0 then
+                result[key] = nested
+            end
+        elseif v1 ~= v2 then
+            result[key] = v2
+        end
+    end
+    return result
+end
+
+---@private
+---@param keys render.md.debug.Key[]
+---@param t table<render.md.debug.Key, any>
+function M.append_keys(keys, t)
+    for key in pairs(t) do
+        if not vim.tbl_contains(keys, key) then
+            table.insert(keys, key)
+        end
+    end
+end
+
+return M

lua/render-markdown/health.lua

@@ -4,7 +4,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '7.1.11'
+M.version = '7.1.12'
 
 function M.check()
     M.start('version')

lua/render-markdown/init.lua

@@ -194,7 +194,6 @@ local M = {}
 ---@field public overrides? render.md.UserConfigOverrides
 ---@field public custom_handlers? table<string, render.md.Handler>
 
----@private
 ---@type render.md.Config
 M.default_config = {
     -- Whether Markdown should be rendered by default or not

lua/render-markdown/state.lua

@@ -60,6 +60,12 @@ function M.invalidate_cache()
     configs = {}
 end
 
+---@param default_config render.md.Config
+---@return table
+function M.difference(default_config)
+    return require('render-markdown.debug.diff').get(default_config, M.config)
+end
+
 ---@param amount integer
 function M.modify_anti_conceal(amount)
     ---@param anti_conceal render.md.AntiConceal