perf(feat): improved smart formatting

Author: andev0x

README.md

@@ -1,6 +1,6 @@
 # sql-formatter.nvim
 
-A lightweight, high-performance SQL formatter plugin for Neovim that leverages `sqlparse` for optimal formatting results with a Lua fallback for basic formatting.
+A lightweight, high-performance SQL formatter plugin for Neovim that leverages `sql-formatter` (Node.js) or `sqlparse` (Python) for optimal formatting results, with a Lua fallback for basic formatting.
 
 ## Images
 <p float="left">
@@ -10,24 +10,32 @@ A lightweight, high-performance SQL formatter plugin for Neovim that leverages `
 
 ## Features
 
-- 🚀 **High Performance**: Uses external `sqlparse` formatter for speed
+- 🚀 **High Performance**: Uses external `sql-formatter` (Node.js) or `sqlparse` (Python) for speed
 - 🔧 **Configurable**: Extensive customization options
 - 📝 **Format on Save**: Automatic formatting when saving files
 - ⌨️ **Key Bindings**: Convenient shortcuts for formatting
 - 🎯 **Multi-dialect**: Support for PostgreSQL, MySQL, SQLite, and more
-- 🔄 **Fallback**: Pure Lua formatter when external tools unavailable
+- 🔄 **Fallback**: Improved Lua formatter when external tools unavailable
 - 📋 **Range Formatting**: Format selected text only
 
 ## Requirements
 
 - Neovim >= 0.8.0
-- Optional: `sqlparse` for optimal performance (`pip install sqlparse`)
+- Optional: `sql-formatter` (Node.js) **or** `sqlparse` (Python) for optimal performance
 
 ## Installation
 
 ### Prerequisites
 
-For optimal performance, install `sqlparse`:
+For optimal performance, install either `sql-formatter` (recommended) or `sqlparse`:
+
+#### Option 1: sql-formatter (Node.js, recommended)
+
+```bash
+npm install -g sql-formatter
+```
+
+#### Option 2: sqlparse (Python)
 
 ```bash
 pip install sqlparse
@@ -110,17 +118,15 @@ require("sql-formatter").setup({
     toggle_format_on_save = "<leader>st",
   },
 
-  -- External formatter (sqlparse)
+  -- External formatter (choose one)
   external_formatter = {
     enabled = true,
-    command = "sqlformat",
-    args = {
-      "--reindent",
-      "--keywords", "upper",
-      "--identifiers", "lower",
-      "--strip-comments",
-      "-"
-    }
+    -- Use sql-formatter (Node.js):
+    command = "sql-formatter",
+    args = {},
+    -- Or use sqlparse (Python):
+    -- command = "sqlformat",
+    -- args = { "--reindent", "--keywords", "upper", "--identifiers", "lower", "--strip-comments", "-" }
   },
 
   -- Notifications
@@ -172,8 +178,8 @@ ORDER BY u.created_at DESC;
 
 This plugin prioritizes performance by:
 
-1. **External Formatter**: Uses `sqlparse` (Python) for heavy lifting
-2. **Lua Fallback**: Lightweight Lua formatter when external tools unavailable
+1. **External Formatter**: Uses `sql-formatter` (Node.js, recommended) or `sqlparse` (Python) for heavy lifting
+2. **Lua Fallback**: Improved Lua formatter when external tools unavailable
 3. **Lazy Loading**: Only loads for SQL file types
 4. **Minimal Dependencies**: Pure Lua implementation with optional external tools
 

lua/sql-formatter/formatter.lua

@@ -12,7 +12,7 @@ function M.setup(config)
   M.config = config
 end
 
--- Check if external formatter (sqlparse) is available
+-- Check if external formatter (sqlparse or sql-formatter) is available
 function M.check_external_formatter()
   if not M.config.external_formatter.enabled then
     return false
@@ -23,23 +23,36 @@ function M.check_external_formatter()
   handle:close()
   M.external_available = result ~= ""
   if not M.external_available then
+    local install_msg = ""
+    if cmd == "sql-formatter" then
+      install_msg = "Install with: npm install -g sql-formatter"
+    elseif cmd == "sqlparse" then
+      install_msg = "Install with: pip install sqlparse"
+    end
     vim.notify(
-      "External SQL formatter '" .. cmd .. "' not found. Install with: pip install sqlparse",
+      "External SQL formatter '" .. cmd .. "' not found. " .. install_msg,
       vim.log.levels.WARN,
       { title = "SQL Formatter" }
     )
   end
   return M.external_available
 end
 
--- Format SQL using external formatter (sqlparse)
+-- Format SQL using external formatter (sqlparse or sql-formatter)
 function M.format_with_external(text)
   if not M.external_available then
     return nil, "External formatter not available"
   end
   local cmd = M.config.external_formatter.command
   local args = table.concat(M.config.external_formatter.args, " ")
-  local full_cmd = string.format("echo %s | %s %s", vim.fn.shellescape(text), cmd, args)
+  local full_cmd
+  if cmd == "sql-formatter" then
+    -- sql-formatter expects input from stdin
+    full_cmd = string.format("echo %s | %s %s", vim.fn.shellescape(text), cmd, args)
+  else
+    -- default: sqlparse or other
+    full_cmd = string.format("echo %s | %s %s", vim.fn.shellescape(text), cmd, args)
+  end
   local handle = io.popen(full_cmd)
   if not handle then
     return nil, "Failed to execute formatter command"
@@ -52,31 +65,47 @@ function M.format_with_external(text)
   return result:gsub("%s+$", ""), nil -- Remove trailing whitespace
 end
 
--- Fallback Lua-based formatter (basic)
+-- Improved Lua-based formatter (smarter, more beautiful)
 function M.format_with_lua(text)
   local lines = vim.split(text, "\n")
   local formatted_lines = {}
   local indent_level = 0
-  local indent = M.config.indent
-  for _, line in ipairs(lines) do
+  local indent = M.config.indent or "  "
+  local clause_keywords = {
+    "SELECT", "FROM", "WHERE", "GROUP BY", "ORDER BY", "HAVING", "LIMIT", "OFFSET", "JOIN", "LEFT JOIN", "RIGHT JOIN", "INNER JOIN", "OUTER JOIN", "ON", "UNION", "VALUES", "SET", "INSERT", "UPDATE", "DELETE"
+  }
+  local function is_clause(line)
+    for _, kw in ipairs(clause_keywords) do
+      if line:upper():match("^" .. kw) then
+        return true
+      end
+    end
+    return false
+  end
+  local function add_linebreaks(sql)
+    -- Add line breaks before major clauses
+    for _, kw in ipairs(clause_keywords) do
+      sql = sql:gsub("%s+" .. kw, "\n" .. kw)
+    end
+    return sql
+  end
+  -- Preprocess: add line breaks for major clauses
+  local preprocessed = add_linebreaks(text)
+  local split_lines = vim.split(preprocessed, "\n")
+  for i, line in ipairs(split_lines) do
     local trimmed = line:match("^%s*(.-)%s*$")
     if trimmed ~= "" and not utils.is_comment_line(trimmed) then
-      -- Handle keywords that decrease indent
-      if trimmed:upper():match("^(END|ELSE|ELSIF|WHEN)%s") then
-        indent_level = math.max(0, indent_level - 1)
+      -- Indent columns in SELECT
+      if i > 1 and split_lines[i-1]:upper():match("^SELECT") and not is_clause(trimmed) then
+        indent_level = 1
+      elseif is_clause(trimmed) then
+        indent_level = 0
       end
-      -- Apply current indentation
       local formatted_line = string.rep(indent, indent_level) .. trimmed
-      -- Format keywords to uppercase if configured
       if M.config.uppercase then
         formatted_line = M.format_keywords(formatted_line)
       end
       table.insert(formatted_lines, formatted_line)
-      -- Handle keywords that increase indent
-      if trimmed:upper():match("^(SELECT|FROM|WHERE|JOIN|INNER|LEFT|RIGHT|FULL|CASE|BEGIN|IF|LOOP|WHILE)%s") or
-         trimmed:upper():match("(THEN|ELSE|DO)%s*$") then
-        indent_level = indent_level + 1
-      end
     else
       table.insert(formatted_lines, trimmed)
     end

lua/sql-formatter/init.lua

@@ -30,17 +30,17 @@ local default_config = {
     level = "info",
     timeout = 2000,
   },
-  -- External formatter command (using sqlparse)
+  -- External formatter command (using sql-formatter or sqlparse)
+  -- To use sql-formatter (Node.js):
+  --   command = "sql-formatter",
+  --   args = { "--config", "/path/to/.sql-formatter.json" } -- optional
+  -- To use sqlparse (Python):
+  --   command = "sqlformat",
+  --   args = { "--reindent", "--keywords", "upper", "--identifiers", "lower", "--strip-comments", "-" }
   external_formatter = {
     enabled = true,
-    command = "sqlformat",
-    args = {
-      "--reindent",
-      "--keywords", "upper",
-      "--identifiers", "lower",
-      "--strip-comments",
-      "-"
-    }
+    command = "sql-formatter", -- or "sqlformat"
+    args = {}, -- see above for examples
   }
 }