Can't get Modify Linebreaks to work on Neovim

[tarsobcaldas]

I'm trying to use latexindent with the option Modify Linebreaks and it doesn't work at all. The formatter works, just doesn't apply the option. I'm also not sure if it's reading my custom local configuration. Tested this on Windows and Ubuntu, and the same thing happens.

My texlab config:

require("lspconfig").texlab.setup {
  on_attach = on_attach,
  capabilities = capabilities,
  init_options = { documentFormatting = true },
  -- filetypes = { "tex", "bib", "cls", "sty", "def", "clo" },
  settings = {
    texlab = {
      build = {
        args = { "-interaction=nonstopmode", "-synctex=1", "-shell-escape", "%f" },
        executable = "latexmk",
        forwardSearchAfter = true,
        onSave = true,
      },
      chktex = {
        onOpenAndSave = true,
        onEdit = true
      },
      auxDirectory = { "aux" },
      formatterLineLength = { 72 },
      latexFormatter = { "latexindent" },
      latexindent = {
        ['local'] = "~/.indentconfig",
        modifyLineBreaks = true
      },
      forwardSearch = {
        executable = executable,
        args = args,
      },
    },
  },
}

I think it would also be great if the option for replacing strings from latexindent were avaliable.

[pfoerster]

Thanks for the report.

['local'] = "~/.indentconfig"

I think you need to replace the ~ with your actual home directory. texlab does not use your shell to call latexindent so I don't think latexindent receives the correct path for the custom config.

I think it would also be great if the option for replacing strings from latexindent were avaliable.

Yeah, I think it would be best if we treat the formatter as a black box similar to the build command and let the user configure the executable and arguments with placeholders.

[clason]

...and Neovim does not expand the ~ here, either -- you need to explicitly pass vim.fn.expand('~/.indentconfig') instead.

[tarsobcaldas]

I tried substituting for "/home/user/.indentconfig" and it still didn't work. But thanks to clason's comment, I could get it to work with null-ls.

[pcapiod]

Hey,

Same behavior here with Lunarvim default config :

local util = require 'lspconfig.util'

local texlab_build_status = vim.tbl_add_reverse_lookup {
  Success = 0,
  Error = 1,
  Failure = 2,
  Cancelled = 3,
}

local texlab_forward_status = vim.tbl_add_reverse_lookup {
  Success = 0,
  Error = 1,
  Failure = 2,
  Unconfigured = 3,
}

local function buf_build(bufnr)
  bufnr = util.validate_bufnr(bufnr)
  local texlab_client = util.get_active_client_by_name(bufnr, 'texlab')
  local params = {
    textDocument = { uri = vim.uri_from_bufnr(bufnr) },
  }
  if texlab_client then
    texlab_client.request('textDocument/build', params, function(err, result)
      if err then
        error(tostring(err))
      end
      print('Build ' .. texlab_build_status[result.status])
    end, bufnr)
  else
    print 'method textDocument/build is not supported by any servers active on the current buffer'
  end
end

local function buf_search(bufnr)
  bufnr = util.validate_bufnr(bufnr)
  local texlab_client = util.get_active_client_by_name(bufnr, 'texlab')
  local params = {
    textDocument = { uri = vim.uri_from_bufnr(bufnr) },
    position = { line = vim.fn.line '.' - 1, character = vim.fn.col '.' },
  }
  if texlab_client then
    texlab_client.request('textDocument/forwardSearch', params, function(err, result)
      if err then
        error(tostring(err))
      end
      print('Search ' .. texlab_forward_status[result.status])
    end, bufnr)
  else
    print 'method textDocument/forwardSearch is not supported by any servers active on the current buffer'
  end
end

-- bufnr isn't actually required here, but we need a valid buffer in order to
-- be able to find the client for buf_request.
-- TODO find a client by looking through buffers for a valid client?
-- local function build_cancel_all(bufnr)
--   bufnr = util.validate_bufnr(bufnr)
--   local params = { token = "texlab-build-*" }
--   lsp.buf_request(bufnr, 'window/progress/cancel', params, function(err, method, result, client_id)
--     if err then error(tostring(err)) end
--     print("Cancel result", vim.inspect(result))
--   end)
-- end

return {
  default_config = {
    cmd = { 'texlab' },
    filetypes = { 'tex', 'plaintex', 'bib' },
    root_dir = function(fname)
      return util.root_pattern '.latexmkrc'(fname) or util.find_git_ancestor(fname)
    end,
    single_file_support = true,
    settings = {
      texlab = {
        rootDirectory = nil,
        build = {
          executable = 'latexmk',
          args = { '-pdf', '-interaction=nonstopmode', '-synctex=1', '%f' },
          onSave = false,
          forwardSearchAfter = false,
        },
        auxDirectory = '.',
        forwardSearch = {
          executable = nil,
          args = {},
        },
        chktex = {
          onOpenAndSave = false,
          onEdit = false,
        },
        diagnosticsDelay = 300,
        latexFormatter = 'latexindent',
        latexindent = {
          ['local'] = nil, -- local is a reserved keyword
          modifyLineBreaks = false,
        },
        bibtexFormatter = 'texlab',
        formatterLineLength = 80,
      },
    },
  },
  commands = {
    TexlabBuild = {
      function()
        buf_build(0)
      end,
      description = 'Build the current buffer',
    },
    TexlabForward = {
      function()
        buf_search(0)
      end,
      description = 'Forward search from current position',
    },
  },
  docs = {
    description = [[
https://github.com/latex-lsp/texlab

A completion engine built from scratch for (La)TeX.

See https://github.com/latex-lsp/texlab/blob/master/docs/options.md for configuration options.
]],
  },
}

By modifying modifyLineBreaks to true, it does not work. The manual linebreaks command on neovim gq does not work either (I am used to perform linebreaks with this command). Stopping or uninstalling TexLab, the manual linebreaks gq works again.

[pfoerster]

@pcapiod @tarsobcaldas Can you try #797, please? It fixes some stuff regarding the arguments passed to latexindent. Also, it logs the command arguments and the working directory for latexindent.