fix(feat): plugin files and ci workflows

Author: andev0x

.github/FUNDING.yml

@@ -1,6 +1,6 @@
 # These are supported funding model platforms
 
-github: anvndev # Replace with your GitHub Sponsors username
+github: andevgo # Replace with your GitHub Sponsors username
 open_collective: # Replace with your Open Collective username
 ko_fi: # Replace with your Ko-fi username
 tidelift: # Replace with your Tidelift platform name/username

autoload/sqlformat.vim

@@ -3,24 +3,49 @@
 " Description: Autoloaded functions for SQL formatting
 
 function! sqlformat#Format(startline, endline) abort
+  " Ensure Python3 is available
   if !has('python3')
     echohl ErrorMsg
     echomsg 'SQLFormat requires Neovim with +python3 support'
     echohl None
     return
   endif
 
+  " Get the selected lines
   let l:lines = getline(a:startline, a:endline)
   let l:input = join(l:lines, '\n')
 
+  " Call Python script to format SQL
   python3 << EOF
 import vim
 from sqlformat import format_sql
-input_sql = vim.eval('l:input')
-formatted = format_sql(input_sql)
-vim.command('let l:formatted = ' + repr(formatted))
+
+try:
+    input_sql = vim.eval('l:input')
+    indent = int(vim.eval('g:sqlformat_indent'))
+    keyword_case = vim.eval('g:sqlformat_keyword_case')
+    line_width = int(vim.eval('g:sqlformat_line_width'))
+    
+    formatted = format_sql(
+        input_sql,
+        indent=indent,
+        keyword_case=keyword_case,
+        line_width=line_width
+    )
+    vim.command('let l:formatted = ' + repr(formatted))
+except Exception as e:
+    vim.command('let l:error = ' + repr(str(e)))
 EOF
 
+  " Check for Python errors
+  if exists('l:error')
+    echohl ErrorMsg
+    echomsg 'SQLFormat error: ' . l:error
+    echohl None
+    return
+  endif
+
+  " Replace buffer content with formatted SQL
   let l:formatted_lines = split(l:formatted, '\n')
   call setline(a:startline, l:formatted_lines)
 endfunction

doc/sqlformat.txt

@@ -1,24 +1,85 @@
-*sqlformat.txt* SQL Formatting Plugin for Neovim
-
-Overview~
-SQLFormat is a Neovim plugin that formats SQL code using the sqlparse Python library.
-
-Installation~
-1. Install the plugin using your favorite plugin manager, e.g.:
-   Using vim-plug:
-   `Plug 'username/nvim-sqlformat'`
-2. Ensure Python3 and sqlparse are installed:
-   `pip install sqlparse`
-
-Usage~
-- Format the entire buffer: `:SQLFormat`
-- Format a range: `:'<,'>SQLFormat`
-- Default keybinding: `<leader>sf` (normal mode)
-
-Configuration~
-- `g:sqlformat_indent`: Set indentation width (default: 2)
-- `g:sqlformat_keyword_case`: Set keyword case ('upper', 'lower', or '' for none; default: 'upper')
-
-Example~
-let g:sqlformat_indent = 4
-let g:sqlformat_keyword_case = 'lower'
+*sqlformat.txt*  SQL formatting plugin for Neovim
+
+==============================================================================
+INTRODUCTION                                                      *sqlformat-intro*
+
+nvim-sqlformat is a Neovim plugin that provides SQL code formatting using the
+sqlparse library. It offers customizable formatting options and integrates
+seamlessly with Neovim.
+
+==============================================================================
+INSTALLATION                                              *sqlformat-installation*
+
+Using lazy.nvim:
+```lua
+{
+  'andevgo/nvim-sqlformat',
+  config = function()
+    require('sqlformat').setup({
+      indent = 2,
+      keyword_case = 'upper',
+      line_width = 80,
+      format_on_save = false,
+      custom_keymaps = {
+        format = '<leader>sf'
+      }
+    })
+  end
+}
+```
+
+==============================================================================
+USAGE                                                              *sqlformat-usage*
+
+Commands:
+    :SQLFormat              Format the entire buffer
+    :'<,'>SQLFormat         Format selected lines in visual mode
+
+Keybindings:
+    <leader>sf              Format the current buffer (default)
+
+==============================================================================
+CONFIGURATION                                            *sqlformat-configuration*
+
+The plugin can be configured through the setup function:
+
+```lua
+require('sqlformat').setup({
+  indent = 2,              -- Number of spaces for indentation
+  keyword_case = 'upper',  -- 'upper' or 'lower' for SQL keywords
+  line_width = 80,         -- Maximum line width
+  format_on_save = false,  -- Enable/disable format on save
+  custom_keymaps = {       -- Custom keybindings
+    format = '<leader>sf'
+  }
+})
+```
+
+==============================================================================
+REQUIREMENTS                                              *sqlformat-requirements*
+
+- Neovim with Python 3 support
+- sqlparse Python package
+
+Install sqlparse:
+    pip install sqlparse
+
+==============================================================================
+TROUBLESHOOTING                                        *sqlformat-troubleshooting*
+
+1. Plugin not working:
+   - Ensure Neovim has Python 3 support
+   - Check if sqlparse is installed
+   - Verify Python path in Neovim
+
+2. Format on save not working:
+   - Check if format_on_save is enabled
+   - Ensure file has .sql extension
+
+==============================================================================
+LICENSE                                                          *sqlformat-license*
+
+This plugin is licensed under the MIT License.
+
+==============================================================================
+vim:tw=78:ts=8:ft=help:norl:

lua/sqlformat.lua

@@ -1,7 +1,33 @@
 -- Author: anvndev
 -- File: lua/sqlformat.lua
-return {
-	setup = function()
-		-- Plugin is loaded via plugin/sqlformat.vim, so no additional Lua setup is needed
-	end,
+local M = {}
+
+local defaults = {
+	indent = 2,
+	keyword_case = 'upper',
+	line_width = 80,
+	format_on_save = false,
+	custom_keymaps = {
+		format = '<leader>sf'
+	}
 }
+
+M.setup = function(opts)
+	opts = vim.tbl_deep_extend('force', defaults, opts or {})
+	
+	-- Set global variables for VimScript
+	vim.g.sqlformat_indent = opts.indent
+	vim.g.sqlformat_keyword_case = opts.keyword_case
+	vim.g.sqlformat_line_width = opts.line_width
+	vim.g.sqlformat_format_on_save = opts.format_on_save
+	
+	-- Set up custom keymaps
+	if opts.custom_keymaps then
+		vim.keymap.set('n', opts.custom_keymaps.format, ':SQLFormat<CR>', { 
+			silent = true,
+			desc = 'Format SQL code'
+		})
+	end
+end
+
+return M

plugin/sqlformat.vim

@@ -7,5 +7,24 @@ if exists('g:loaded_sqlformat')
 endif
 let g:loaded_sqlformat = 1
 
+" Default settings if not set by Lua
+let g:sqlformat_indent = get(g:, 'sqlformat_indent', 2)
+let g:sqlformat_keyword_case = get(g:, 'sqlformat_keyword_case', 'upper')
+let g:sqlformat_line_width = get(g:, 'sqlformat_line_width', 80)
+let g:sqlformat_format_on_save = get(g:, 'sqlformat_format_on_save', 0)
+
+" Define command
 command! -range=% SQLFormat call sqlformat#Format(<line1>, <line2>)
-nnoremap <silent> <leader>sf :SQLFormat<CR>
+
+" Set up format on save if enabled
+if g:sqlformat_format_on_save
+  augroup SQLFormat
+    autocmd!
+    autocmd BufWritePre *.sql :SQLFormat
+  augroup END
+endif
+
+" Set up default keybinding if not set by Lua
+if !exists('g:sqlformat_custom_keymaps')
+  nnoremap <silent> <leader>sf :SQLFormat<CR>
+endif

python/sqlformat.py

@@ -12,21 +12,45 @@
 # File: python/sqlformat.py
 
 import sqlparse
+import vim
 
 
-def format_sql(sql):
+def format_sql(sql, indent, keyword_case, line_width=80):
     """
-    Format SQL code with fixed style: 2-space indent, uppercase keywords.
+    Format SQL code using sqlparse.
     
     Args:
         sql (str): SQL code to format
+        indent (int): Number of spaces for indentation
+        keyword_case (str): 'upper', 'lower', or None for keyword case
+        line_width (int): Maximum line width for wrapping
     Returns:
         str: Formatted SQL
     """
-    return sqlparse.format(
-        sql,
-        reindent=True,
-        indent_width=2,
-        keyword_case='upper',
-        wrap_after=80
-    )
+    try:
+        vim.command('echo "Formatting SQL..."')
+        
+        # Validate inputs
+        if not isinstance(indent, int) or indent < 0:
+            raise ValueError("Indent must be a positive integer")
+        if keyword_case not in ['upper', 'lower', None]:
+            raise ValueError("Keyword case must be 'upper', 'lower', or None")
+        if not isinstance(line_width, int) or line_width < 0:
+            raise ValueError("Line width must be a positive integer")
+
+        # Format the SQL
+        formatted = sqlparse.format(
+            sql,
+            reindent=True,
+            indent_width=indent,
+            keyword_case=keyword_case,
+            wrap_after=line_width
+        )
+        
+        vim.command('echo "SQL formatting complete"')
+        return formatted
+        
+    except Exception as e:
+        error_msg = f"SQL formatting failed: {str(e)}"
+        vim.command(f'echoerr "{error_msg}"')
+        return sql  # Return original SQL on error