YAML file truncating when formating

[caquino]

Hi,

While using null-ls with prettierd some YAML files are truncating when formatting. I've attempted to send the YAML file directly to prettierd and could not replicate the issue.

I've tried to enable debug and log what is happening, but I can't see any errors on the log, only weird thing is that it looks like the file is being truncated while being read.

This also does not happen 100% of the times, sometimes requires a couple of saves for the issue to happen.

This is the YAML file that is being truncated https://gist.github.com/caquino/d116736b87257423d4d141efb562304b

And this is the log when the problem happens
null-ls.log

Is there anything else I can troubleshoot/debug?

I've tried the following so far:

• different nodejs versions
• disabling asdf
• replacing my shell from fish to zsh
• alacritty / terminal.app

Any help will be appreciated! Thanks!

[gegoune]

I have came across that as well, never managed to replicate it though, just happens sometimes.

[caquino]

I would say in my case, it is happening about 70% of the time. Not a consistent behavior but easy enough to replicate.

[jose-elias-alvarez]

I often had this issue on large Markdown files with prettierd and stopped using it for that reason. Can you see if you can replicate the issue using vanilla Prettier? If so I doubt there's much we can do about this on our end.

[caquino]

As far as I can tell, if I remove lazyvim.plugins.extras.formatting.prettier it will remove the priority from prettierd and because of that it will use prettier.

By doing that I can't replicate the problem anymore.

NullLsInfo

	null-ls
	https://github.com/jose-elias-alvarez/null-ls.nvim
	
	Supported source(s)
	* formatting: prettier | prettier_d_slim | prettier_eslint | prettierd | yamlfix | yamlfmt | yq
	* diagnostics: actionlint | cfn_lint | spectral | vacuum | yamllint
	
	* Note: current buffer has no sources attached

I'm also not sure if the problem is prettierd as submitting manually a file does not have the same results, my assumption is that it is the way that both null-ls and prettierd interact with each other.

That being said I can't judge if it is worth the effort to debug and fix this issue as I can't see any performance difference of using it. Feels like a low hanging fruit that I would only bother to fix if discussions like this start to increase just to reduce the amount of support required.

Anyways, I'm going into a tangent here. @jose-elias-alvarez thank you for your assistance, I really appreciate!

[caquino]

BTW removing lazyvim.plugins.extra.formatting.prettier not only remove prettierd but also don't attach null-ls to the buffer. I'm still trying to figure out how to only disable prettierd. I will update this post when I figure out the correct way of doing it as it may help others.

[cerebrl]

@caquino Did you get anywhere on this? I'm having the exact same issue (fairly standard LazyVim installation with the prettier extra plugin installed), but with large Markdown files.

[caquino]

@cerebrl sorry for not posting an update here before, let me explain what I learned and what I did.

When you add any import to lazy.lua, like for example the one for prettier lazyvim.plugins.extras.formatting.prettier it is just a pre-configured plugin and some base defaults.
The path I took was to not have lazyvim.plugins.extras.formatting.prettier and to manually add a plugin configuration on plugins/ folder.

I've created a file under plugins/null-ls.lua with the following content:

return {
  {
    "williamboman/mason.nvim",
    opts = function(_, opts)
      table.insert(opts.ensure_installed, "prettier")
    end,
  },
  {
    "jose-elias-alvarez/null-ls.nvim",
    opts = function(_, opts)
      local nls = require("null-ls")
      table.insert(opts.sources, nls.builtins.formatting.prettier)
    end,
  },
}

This is a content similar to the pre configured lazyvim.plugins.extras.formatting.prettier but without having prettierd added to it.

You can see the pre configured settings here, and you can also check other plugin configurations and use similar logic if you need to customize anything.

This will configure mason to install prettier and add it to the formating sources for null-ls.

You can use this approach also to add other formaters that are not added to the default plugin, like for example actionlint and others.

For example:

return {
  {
    "williamboman/mason.nvim",
    opts = function(_, opts)
      -- table.insert(opts.ensure_installed, "prettierd")
      table.insert(opts.ensure_installed, "actionlint")
      table.insert(opts.ensure_installed, "prettier")
    end,
  },
  {
    "jose-elias-alvarez/null-ls.nvim",
    opts = function(_, opts)
      local nls = require("null-ls")
      -- table.insert(opts.sources, nls.builtins.formatting.prettierd)
      table.insert(opts.sources, nls.builtins.formatting.prettier)
      table.insert(opts.sources, nls.builtins.diagnostics.actionlint)
    end,
  },
}

Note that the prettierd configuration is commented on this example, and I'm adding both prettier and actionlint as formatters.

I hope this helps you understand how to solve your issue and also what is the logic behind the configuration as this can be applied to any of the pre-configured plugins.

I understand that this does not fix the prettierd problem, but it at least allows the usage of prettier instead, which was good enough for me.

[cerebrl]

@caquino Wow, what a wonderful response! You are amazing! I too was investigating what LazyVim's "extras" does as well and came to a similar conclusion, so seeing this helps me know I'm on the right track.

Thank you again for spending the time to respond with such care. I hope you have a great week!