Hi, thanks for this plugin, it works very well and abstracts a lot of config.

Only the eslint formatting didn't work me, but I don't have eslint globally installed so that might be it. I think it might be good to have a config for formatting with eslint_d as it's much faster than eslint. Might also be good to write a note about that as people might not be aware.

Currently achieving it like so:

local eslint_fmt = require 'diagnosticls-configs.formatters.eslint_fmt'
local fs = require 'diagnosticls-configs.fs'

-- Use eslint_d deamon instead of eslint
local eslint_fix = vim.tbl_extend('force', eslint_fmt, {
  sourceName = 'eslint_d',
  command = fs.get_executable('eslint_d', 'node'),
})

Hi,

I would like to figure out why are init() and setup() functions separate? I'm thinking that simplifying it and using only a setup() function would be more straightforward. Something like this:

require 'diagnosticls-configs'.setup({
  default_config = false,
  format = false,
  on_attach = on_attach,
  filetypes = {}, -- same what current setup() accepts
})

I was creating a project specific setup and ran into this issue where I need to call both init() and setup() to override the functionality. In my init.vim I have default_config = true, but for one of my projects, I need to have specific settings, which I had to override with an init({ default_config = false }) call. It wasn't fully clear to me at first that I need to do that.
I'm assuming this is done for a reason, but I can't figure out which one.

Generally, plugin works great, and thank you for building it. My diagnosticls setup started to grow over time and this cleaned it up tremendously.

I'd suggest doing the following in fs.lua.

  if vim.fn.filereadable(binpath) == 0 then
-   add_checkhealth_error(name)
+   return ''
  end

    if local_binpath == '' then
      return get_global_exec(name)
    end
+   add_checkhealth_error(name)

    return local_binpath

The reason for this is that you probably want to check the PATH if there is no ~/node_modules for example. I have many Node-based linters and formatters installed globally through my system package manager and they're in /usr/bin instead of ./node_modules/.bin and patching the files as described made everything work. This will likely fix system/user global NPM packages too.

Please give me thoughts on this idea.

Is there a way to set up per-project diagnostic configurations? I'm using AutoSource to allow me to load a custom configuration per-project, so for example one project uses tabs and the other spaces.

I have one project using the WordPress PHP standards for phpcs, and another that uses PSR2. Currently, I'm hand-editing the diagnostic config file whenever I switch projects which is not ideal.

Copy/pasted the luacheck config, I have luacheck installed, and it gives no diagnostics. There's no errors in ~/.cache/nvim/lsp.log

> luacheck --version
Luacheck: 0.23.0
Lua: PUC-Rio Lua 5.4
Argparse: 0.7.1
LuaFileSystem: 1.8.0
LuaLanes: Not found

Users should be able to extend the config and add their own mix, if default configs don't work, or if some linters/formatters depend on the CLI for settings instead of a project config file.

We don't want to be breaking anything on the user side.

The API for this can take many forms, the one I was heavily leaning on was the following:

-- default config
local eslint = require 'diagnosticls-configs.linters.eslint'

-- config extended and overwritten with the table provided
local eslint = require 'diagnosticls-configs.linters.eslint'.extend {
  args = {'some', 'args'}
}

Another one was to create and extend the config:

local extend = require 'diagnosticls-configs.util'.extend
local eslint = require 'diagnosticls-configs.linters.eslint'

eslint = extend(eslint, {
  args = {'some', 'args'}
})

Finally, we can just direct the user to use vim.tbl_extend to make use of the same interface:

local eslint = require 'diagnosticls-configs.linters.eslint'

eslint = vim.tbl_extend('force', eslint, {
  args = {'some', 'args'}
})

Error

Failed to load my/plugin/lspconfig
...r/start/diagnosticls-nvim/lua/diagnosticls-nvim/init.lua:77: bad argument #1 to 'pairs' (table expected, got function)

My config

require'diagnosticls-nvim'.setup{
  on_attach = attacher,
  ['ruby'] = { linter = require'diagnosticls-nvim.linters.rubocop' },
  ['vim'] = { linter = require'diagnosticls-nvim.linters.vint' }
}

Omit init() and setup() just like it was done in creativenull/efmls-configs-nvim#30.

The reason being that having two separate functions to have the user setup is not very friendly, the preference would be to keep setup code as minimal as possible, at the same time, provide more flexibility to the user if in case they might want to adjust some settings.

But since the API is different in diagnostic-languageserver compared to efm-langserver, I'm thinking of creating a wrapper to generate the LSP config and then have the user merge them on lspconfig.diagnosticls.setup().

New proposal example:

local eslint = require('diagnosticls-configs.linters.eslint')
local prettier = require('diagnosticls-configs.formatters.prettier')

local diagnosticls_config = require('diagnosticls-configs').create({
  javascript = {
    linters = { eslint },
    formatters = { prettier },
  },
  typescript = {
    linters = { eslint },
    formatters = { prettier },
  },
})

require('lspconfig').diagnosticls.setup(vim.tbl_extend('force', diagnosticls_config, {
  on_attach = on_attach,
  capabilities = capabilities,
})

For defaults:

local diagnosticls_config = require('diagnosticls-configs').defaults()

To add additional languages or to overrides defaults, just pass the same table structure as in create():

local diagnosticls_config = require('diagnosticls-configs').defaults({
  javascript = {
    linters = { eslint },
    formatters = { prettier },
  },
})

Hi,

Is it possible to override the args settings for phpcs?

from
args = {'--standard=PSR2', '--report=emacs', '-s', '-'},

to
args = {'--standard=PSR12'}

From looking at my language server logs, I see that the eslint security configuration is getting passed as securities = { "warning", "error" }, when it should be passed as securities = { "1" = "warning", "2" = "error" }. I'm not sure where things are going wrong, but it seems like something (neovim, nvim-lspconfig, this plugin?) can't distinguish between a map and an array here.

How to reproduce

1. Create a *.sh file in a folder without .git
2. Open the file with neovim

What happens?

The plugin doesn't get attached:

I expected the plugin to be attached with shellcheck as the linter.
When I attach it inside a git repo it works:

My config

local dlsconfig = require 'diagnosticls-configs'
local shellcheck = require 'diagnosticls-configs.linters.shellcheck'
local swiftlint = require 'diagnosticls-configs.linters.swiftlint'

swiftlint = vim.tbl_extend('force', swiftlint, {
  rootPatterns = {'Package.swift', '.git'}
})

dlsconfig.setup {
  ['sh'] = {
    linter = shellcheck
  },
  ['swift'] = {
    linter = swiftlint
  },
}

The same thing happens with swiftlint. Notice how in my config I specify {'Package.swift', '.git'} as the root pattern.
In my folder's root I have a Package.swift file, but the plugin doesn't attach:

I noticed that this is the only place where root_dir is referenced.

To make SwiftLint work, I changed it to:

root_dir = require'lspconfig'.util.root_pattern('Package.swift', '.git'), 

To make shellcheck work, I changed it to:

root_dir = function(fname)
  return util.root_pattern '.git'(fname) or util.path.dirname(fname)
end,
``

diagnosticls-nvim sounds too vague and makes no sense as to what the plugin does, until a user reads the README. Suggested plugin names below.

Namely prefixed with one of:

• dls
• diagnosticls
• diagnostic-languageserver

Then suffixed with one of (the - can be replaced with .):

• config-nvim
• settings-nvim
• options-nvim

For example, with the combination above, we can construct the name like: diagnosticls-config-nvim or diagnosticls-config.nvim

I guess something short would be nice, will be looking toward more nvim plugins for naming conventions.

Here's this repo's config for black:

local fs = require('diagnosticls-configs.fs')

return {
  sourceName = 'black',
  command = fs.executable('black'),
  args = { '%filepath' },
  doesWriteToFile = true,
  rootPatterns = {
    '.git',
    'pyproject.toml',
    'setup.py',
  },

This command writes to disk (doesWriteToFile = true). Isn't it more natural for a language server formatter to use stdio? This is also the default behavior for formatters in diagnosticls. Does this repo have a differetn philosophy about default behavior for formatters? To change black to use stdio by default, one could use this:

local fs = require('diagnosticls-configs.fs')

return {
  sourceName = 'black',
  command = fs.executable('black'),
  args = { '-' },
  rootPatterns = {
    '.git',
    'pyproject.toml',
    'setup.py',
  },

As title.

Hey @creativenull,

I'm trying to add swiftlint to diagnosticls-nvim, however, it doesn't seem to be working as expected.

In my init.lua I had the following

require'diagnosticls-nvim'.init{}
require'diagnosticls-nvim'.setup{
  ['swift'] = {
    linter = {
      sourceName = 'swiftlint',
      command = "swiftlint",
      debounce = 100,
      args = {
        'lint',
        '--use-stdin',
        "--quiet",
        "--reporter",
        "json",
      },
      rootPatterns = {
        '.git',
      }
    }
  }
}

I tried to draw inspeeration from existing plugins in other editors like vscode: https://github.com/vknabel/vscode-swiftlint/blob/master/src/lint.ts

It would be awesome if you can point out why it didn't work for me or what I missed.

Thanks