Setting up a formatter that outputs errors

[jordanisaacs]

I am setting up a formatter that outputs an error in addition to the formatted output. However, the formats are not being applied.

Here is my config. I have suppress_stderr and ignore_stderr set to true (I have tried all 4 combinations true/false of those options):

null_helpers.make_builtin({
  method = null_methods.internal.FORMATTING,
  filetypes = { "sql" },
  generator_opts = {
    to_stdin = true,
    ignore_stderr = true,
    suppress_errors = true,
    command = "${pkgs.sqlfluff}/bin/sqlfluff",
    args = {
      "fix",
      "-",
    },
  },
  factory = null_helpers.formatter_factory,
}),

This is the output from the debug logs. So it clearly is running but nothing gets applied when I call vim.lsp.buf.formatting() or vim.lsp.buf.formatting_sync()

[DEBUG Mon 04 Oct 2021 12:19:24 AM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: received LSP request for method textDocument/formatting
[DEBUG Mon 04 Oct 2021 12:19:24 AM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: running generators for method NULL_LS_FORMATTING
[DEBUG Mon 04 Oct 2021 12:19:24 AM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: spawning command /nix/store/bfvd4g5lpdd46qrx69xxrzy8axhmviqf-sqlfluff-0.6.6/bin/sqlfluff with args:
[DEBUG Mon 04 Oct 2021 12:19:24 AM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: { "fix", "-" }
[DEBUG Mon 04 Oct 2021 12:19:24 AM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: error output: Unfixable violations detected.

[DEBUG Mon 04 Oct 2021 12:19:24 AM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: output: -- Add migration script here

/* Table to hold data primitives as enum.
* e.g. string, int, time, uuid, etc.
* Each data_type is a data_primitive
*/
Create Table daysquare.data_primitive(
    id uuid Primary Key,
    primitive text Not Null,

    Unique(primitive)
);

[DEBUG Mon 04 Oct 2021 12:19:24 AM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: received edits from generators:
[DEBUG Mon 04 Oct 2021 12:19:24 AM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: {}
[DEBUG Mon 04 Oct 2021 12:19:24 AM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: successfully applied edits:
[DEBUG Mon 04 Oct 2021 12:19:24 AM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: {}
[DEBUG Mon 04 Oct 2021 12:19:52 AM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: received LSP request for method shutdown
[DEBUG Mon 04 Oct 2021 12:19:52 AM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: received LSP notification for method exit

[jose-elias-alvarez]

Can you post an example of a file to recreate the issue? I'm using the following simplified setup and it seems to be working:

local null_ls = require("null-ls")

local sqlfluff = {
    method = null_ls.methods.FORMATTING,
    filetypes = { "sql" },
    generator = null_ls.formatter({
        to_stdin = true,
        ignore_stderr = true,
        command = "sqlfluff",
        args = {
            "fix",
            "-",
        },
    }),
}

[jordanisaacs]

I tried your simplified way but still having the same issue. formatting_sync() results in a timeout/does nothing while formatting() also does nothing. The output to debug is still the same. I set an extra high default_timeout but it didn't change anything.

local null_ls = require("null-ls")

ls_sources = {
  {
    method = null_ls.methods.FORMATTING,
    filetypes = { "sql" },
    generator = null_ls.formatter({
      to_stdin = true,
      ignore_stderr = true,
      command = "${pkgs.sqlfluff}/bin/sqlfluff",
      args = {
        "fix",
        "-",
      },
    }),
  },
}

-- Enable null-ls
null_ls.config({
  diagnostics_format = "[#{m}] #{s} (#{c})",
  debounce = 250,
  default_timeout = 5000,
  sources = ls_sources,
  debug = true,
})

Original sql file. The capitalized C in the first create table should cause the formatting changes:

-- Add migration script here

/* Table to hold data primitives as enum.
* e.g. string, int, time, uuid, etc.
* Each data_type is a data_primitive
*/
Create table daysquare.data_primitive(
    id uuid primary key,
    primitive text not null,

    unique(primitive)
);

/* Table to represent a data type as enum.
* e.g. spotify artist id, google api token, const, etc.
* All queries, paths, and headers are a data_type
* Optional regex check
*/
create table daysquare.data_type(
    id uuid primary key,
    data_primitive_id uuid not null references daysquare.data_primitive(id),
    name text not null,
    regex_check text,

    unique(data_primitive_id)
);

Debug log when calling formatting_sync():

[DEBUG Tue 05 Oct 2021 05:37:35 PM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: received LSP request for method textDocument/formatting
[DEBUG Tue 05 Oct 2021 05:37:35 PM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: running generators for method NULL_LS_FORMATTING
[DEBUG Tue 05 Oct 2021 05:37:35 PM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: spawning command /nix/store/bfvd4g5lpdd46qrx69xxrzy8axhmviqf-sqlfluff-0.6.6/bin/sqlfluff with args:
[DEBUG Tue 05 Oct 2021 05:37:35 PM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: { "fix", "-" }
[DEBUG Tue 05 Oct 2021 05:37:36 PM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: received LSP notification for method $/cancelRequest
[DEBUG Tue 05 Oct 2021 05:37:36 PM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: error output: Unfixable violations detected.

[DEBUG Tue 05 Oct 2021 05:37:36 PM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: output: -- Add migration script here

/* Table to hold data primitives as enum.
* e.g. string, int, time, uuid, etc.
* Each data_type is a data_primitive
*/
Create Table daysquare.data_primitive(
    id uuid Primary Key,
    primitive text Not Null,

    Unique(primitive)
);

/* Table to represent a data type as enum.
* e.g. spotify artist id, google api token, const, etc.
* All queries, paths, and headers are a data_type
* Optional regex check
*/
Create Table daysquare.data_type(
    id uuid Primary Key,
    data_primitive_id uuid Not Null References daysquare.data_primitive(id),
    name text Not Null,
    regex_check text,

    Unique(data_primitive_id)
);

[DEBUG Tue 05 Oct 2021 05:37:36 PM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: received edits from generators:
[DEBUG Tue 05 Oct 2021 05:37:36 PM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: {}
[DEBUG Tue 05 Oct 2021 05:37:36 PM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: successfully applied edits:
[DEBUG Tue 05 Oct 2021 05:37:36 PM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: {}

Debug log when calling formatting():

[DEBUG Tue 05 Oct 2021 05:35:53 PM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: received LSP request for method textDocument/formatting
[DEBUG Tue 05 Oct 2021 05:35:53 PM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: running generators for method NULL_LS_FORMATTING
[DEBUG Tue 05 Oct 2021 05:35:53 PM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: spawning command /nix/store/bfvd4g5lpdd46qrx69xxrzy8axhmviqf-sqlfluff-0.6.6/bin/sqlfluff with args:
[DEBUG Tue 05 Oct 2021 05:35:53 PM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: { "fix", "-" }
[DEBUG Tue 05 Oct 2021 05:35:54 PM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: error output: Unfixable violations detected.

[DEBUG Tue 05 Oct 2021 05:35:54 PM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: output: -- Add migration script here

/* Table to hold data primitives as enum.
* e.g. string, int, time, uuid, etc.
* Each data_type is a data_primitive
*/
Create Table daysquare.data_primitive(
    id uuid Primary Key,
    primitive text Not Null,

    Unique(primitive)
);

/* Table to represent a data type as enum.
* e.g. spotify artist id, google api token, const, etc.
* All queries, paths, and headers are a data_type
* Optional regex check
*/
Create Table daysquare.data_type(
    id uuid Primary Key,
    data_primitive_id uuid Not Null References daysquare.data_primitive(id),
    name text Not Null,
    regex_check text,

    Unique(data_primitive_id)
);

[DEBUG Tue 05 Oct 2021 05:35:54 PM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: received edits from generators:
[DEBUG Tue 05 Oct 2021 05:35:54 PM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: {}
[DEBUG Tue 05 Oct 2021 05:35:54 PM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: successfully applied edits:
[DEBUG Tue 05 Oct 2021 05:35:54 PM EDT] ...ir/pack/myVimPackage/start/null-ls/lua/null-ls/utils.lua:51: {}

[jose-elias-alvarez]

Are you sure this is an issue with null-ls and not sqlfluff itself? I tried pasting the content into a file and running cat test.sql | sqlfluff fix - from the command line and got the same results. I can see that other fixable errors like unnecessary whitespace are correctly fixed, so unless I'm misunderstanding something, I'm not sure that this is a null-ls issue.