Cannot get credo-language-server working

[jared-mackey]

Hi,

I just installed this great stuff (🔥) yesterday and got the elixir tools working but am struggling to get credo working. Here's my config.

use {
    "elixir-tools/elixir-tools.nvim",
    requires = { "nvim-lua/plenary.nvim" },
    config = function()
      require("elixir").setup({
        elixirls = {enable=false},
        credo = {enable=true}
      })
    end
  }

require("mason-lspconfig").setup_handlers {
  ["elixirls"] = function()
    nvim_lsp.elixirls.setup {
      capabilities = capabilities,
      on_attach = function(client, bufnr)
        require('elixir.elixirls').on_attach(client, bufnr)
      end,
      cmd = {
        vim.loop.os_homedir() .. "/dev/private/elixir-ls/rel/language_server.sh"
      },
      settings = {
        elixirLS = {
          dialyzerEnabled = true,
        }
      }
    }
  end,
}

Happy to share any logs you think would be helpful! Just lmk what to look for and what commands to get them.

Here's how I determined it's not working.

• I do not see credo in :LspInfo when in an elixir file
• I do not get diagnostics on things credo definitely complains about.

Also, just a side note, figuring out how to run the elixir tools without it auto installing the lsp was an adventure. Could we add a bit about this in the readme? 😄

[mhanberg]

Couple questions

• Elixir version? credo-language-server uses Mix.install so it requires 1.12+
• OTP version?
• in what directory are you starting neovim? Is it in the root of your project?
• Do you have Credo installed in the project's mix.exs and mix.lock?
• Credo version? i'm still working through the minimum Credo version that can be supported

Also, just a side note, figuring out how to run the elixir tools without it auto installing the lsp was an adventure. Could we add a bit about this in the readme?

I believe it is documented, unless you are referring to the usage of require('elixir.elixirls').on_attach(client, bufnr).

[jared-mackey]

Great questions, sorry I didn't include that before.

• Elixir 1.14.3
• OTP 25.3
• Yes, the root of my umbrella project.
• Yes, I have it and it is part of the umbrella mix file (not the subapps)
• Credo: 1.6.6

Yes, that usage was hard to find. It wasn't working before adding that.

[mhanberg]

Yes, the root of my umbrella project.

I think this is the cause. I will prioritize this fix.

[mhanberg]

I tried again using 0.9.0 and it still worked for me.

[mhanberg]

can you clone this repo and see if it works there? https://github.com/mhanberg/riri

[jared-mackey]

OK, I think we are getting somewhere now. I tested with a brand new umbrella like you did and it is indeed working. So I think it's something with my project. I copied over my .credo.exs and it stopped working. I realized that I had a plugin, CredoContrib required. Once I added that to the project's deps I expected it to work again but it did not. Removing that plugin from my config made it work again!

Here's the whole config and I also have {:credo_contrib, "~> 0.2.0"} in my deps for the umbrella root.

# This file contains the configuration for Credo and you are probably reading
# this after creating it with `mix credo.gen.config`.
#
# If you find anything wrong or unclear in this file, please report an
# issue on GitHub: https://github.com/rrrene/credo/issues
#
%{
  #
  # You can have as many configs as you like in the `configs:` field.
  configs: [
    %{
      #
      # Run any config using `mix credo -C <name>`. If no config name is given
      # "default" is used.
      #
      name: "default",
      #
      # These are the files included in the analysis:
      files: %{
        #
        # You can give explicit globs or simply directories.
        # In the latter case `**/*.{ex,exs}` will be used.
        #
        included: [
          "lib/",
          "src/",
          "test/",
          "web/",
          "apps/*/lib/",
          "apps/*/src/",
          "apps/*/test/",
          "apps/*/web/"
        ],
        excluded: [~r"/_build/", ~r"/deps/", ~r"/node_modules/"]
      },
      #
      # Load and configure plugins here:
      #
      plugins: [
        {CredoContrib, []}
      ],
      #
      # If you create your own checks, you must specify the source files for
      # them here, so they can be loaded by Credo before running the analysis.
      #
      requires: [],
      #
      # If you want to enforce a style guide and need a more traditional linting
      # experience, you can change `strict` to `true` below:
      #
      strict: true,
      #
      # To modify the timeout for parsing files, change this value:
      #
      parse_timeout: 5000,
      #
      # If you want to use uncolored output by default, you can change `color`
      # to `false` below:
      #
      color: true,
      #
      # You can customize the parameters of any check by adding a second element
      # to the tuple.
      #
      # To disable a check put `false` as second element:
      #
      #     {Credo.Check.Design.DuplicatedCode, false}
      #
      checks: %{
        enabled: [
          #
          ## Consistency Checks
          #
          {Credo.Check.Consistency.ExceptionNames, []},
          {Credo.Check.Consistency.LineEndings, []},
          {Credo.Check.Consistency.ParameterPatternMatching, []},
          {Credo.Check.Consistency.SpaceAroundOperators, []},
          {Credo.Check.Consistency.SpaceInParentheses, []},
          {Credo.Check.Consistency.TabsOrSpaces, []},
          {Credo.Check.Consistency.UnusedVariableNames, []},

          #
          ## Design Checks
          #
          # You can customize the priority of any check
          # Priority values are: `low, normal, high, higher`
          #
          {Credo.Check.Design.AliasUsage,
           [priority: :low, if_nested_deeper_than: 2, if_called_more_often_than: 0]},
          # You can also customize the exit_status of each check.
          # If you don't want TODO comments to cause `mix credo` to fail, just
          # set this value to 0 (zero).
          #
          {Credo.Check.Design.TagTODO, [exit_status: 0, priority: :low]},
          {Credo.Check.Design.TagFIXME, [exit_status: 0, priority: :low]},
          {Credo.Check.Design.SkipTestWithoutComment, []},

          #
          ## Readability Checks
          #
          {Credo.Check.Readability.AliasOrder, []},
          {Credo.Check.Readability.BlockPipe, []},
          {Credo.Check.Readability.FunctionNames, []},
          {Credo.Check.Readability.ImplTrue, []},
          {Credo.Check.Readability.LargeNumbers, []},
          {Credo.Check.Readability.MaxLineLength, [priority: :low, max_length: 120]},
          {Credo.Check.Readability.ModuleAttributeNames, []},
          {Credo.Check.Readability.ModuleDoc, []},
          {Credo.Check.Readability.ModuleNames, []},
          {Credo.Check.Readability.MultiAlias, []},
          {Credo.Check.Readability.NestedFunctionCalls, []},
          {Credo.Check.Readability.ParenthesesInCondition, []},
          {Credo.Check.Readability.ParenthesesOnZeroArityDefs, [parens: true]},
          {Credo.Check.Readability.PipeIntoAnonymousFunctions, []},
          {Credo.Check.Readability.PredicateFunctionNames, []},
          {Credo.Check.Readability.PreferImplicitTry, []},
          {Credo.Check.Readability.RedundantBlankLines, []},
          {Credo.Check.Readability.Semicolons, []},
          {Credo.Check.Readability.SeparateAliasRequire, []},
          {Credo.Check.Readability.SingleFunctionToBlockPipe, []},
          {Credo.Check.Readability.SinglePipe, []},
          {Credo.Check.Readability.SpaceAfterCommas, []},
          {Credo.Check.Readability.StrictModuleLayout, []},
          {Credo.Check.Readability.StringSigils, []},
          {Credo.Check.Readability.TrailingBlankLine, []},
          {Credo.Check.Readability.TrailingWhiteSpace, []},
          {Credo.Check.Readability.UnnecessaryAliasExpansion, []},
          {Credo.Check.Readability.VariableNames, []},
          {Credo.Check.Readability.WithCustomTaggedTuple, []},
          {Credo.Check.Readability.WithSingleClause, []},

          #
          ## Refactoring Opportunities
          #
          {Credo.Check.Refactor.Apply, []},
          {Credo.Check.Refactor.CondStatements, []},
          {Credo.Check.Refactor.CyclomaticComplexity, []},
          {Credo.Check.Refactor.DoubleBooleanNegation, []},
          {Credo.Check.Refactor.FilterFilter, []},
          {Credo.Check.Refactor.FunctionArity, []},
          {Credo.Check.Refactor.IoPuts, []},
          {Credo.Check.Refactor.LongQuoteBlocks, []},
          {Credo.Check.Refactor.MapJoin, []},
          {Credo.Check.Refactor.MatchInCondition, []},
          {Credo.Check.Refactor.NegatedConditionsInUnless, []},
          {Credo.Check.Refactor.NegatedConditionsWithElse, []},
          {Credo.Check.Refactor.Nesting, []},
          {Credo.Check.Refactor.RedundantWithClauseResult, []},
          {Credo.Check.Refactor.RejectReject, []},
          {Credo.Check.Refactor.UnlessWithElse, []},
          {Credo.Check.Refactor.WithClauses, []},

          #
          ## Warnings
          #
          {Credo.Check.Warning.ApplicationConfigInModuleAttribute, []},
          {Credo.Check.Warning.BoolOperationOnSameValues, []},
          {Credo.Check.Warning.ExpensiveEmptyEnumCheck, []},
          {Credo.Check.Warning.IExPry, []},
          {Credo.Check.Warning.IoInspect, []},
          {Credo.Check.Warning.OperationOnSameValues, []},
          {Credo.Check.Warning.OperationWithConstantResult, []},
          {Credo.Check.Warning.RaiseInsideRescue, []},
          {Credo.Check.Warning.SpecWithStruct, []},
          {Credo.Check.Warning.WrongTestFileExtension, []},
          {Credo.Check.Warning.UnusedEnumOperation, []},
          {Credo.Check.Warning.UnusedFileOperation, []},
          {Credo.Check.Warning.UnusedKeywordOperation, []},
          {Credo.Check.Warning.UnusedListOperation, []},
          {Credo.Check.Warning.UnusedPathOperation, []},
          {Credo.Check.Warning.UnusedRegexOperation, []},
          {Credo.Check.Warning.UnusedStringOperation, []},
          {Credo.Check.Warning.UnusedTupleOperation, []},
          {Credo.Check.Warning.UnsafeExec, []},
          {Credo.Check.Warning.UnsafeToAtom, []},
          {Credo.Check.Warning.MixEnv, []},
          {Credo.Check.Warning.LeakyEnvironment, []},
        ],
        disabled: [
          #
          # Checks scheduled for next check update (opt-in for now, just replace `false` with `[]`)

          #
          # Controversial and experimental checks (opt-in, just move the check to `:enabled`
          #   and be sure to use `mix credo --strict` to see low priority checks)
          #
          {Credo.Check.Consistency.MultiAliasImportRequireUse, []},
          {Credo.Check.Design.DuplicatedCode, []},
          {Credo.Check.Readability.AliasAs, []},
          {Credo.Check.Readability.Specs, []},
          {Credo.Check.Refactor.ABCSize, []},
          {Credo.Check.Refactor.AppendSingleItem, []},
          {Credo.Check.Refactor.FilterReject, []},
          {Credo.Check.Refactor.MapInto, []},
          {Credo.Check.Refactor.MapMap, []},
          {Credo.Check.Refactor.ModuleDependencies, []},
          {Credo.Check.Refactor.NegatedIsNil, []},
          {Credo.Check.Refactor.PipeChainStart, []},
          {Credo.Check.Refactor.RejectFilter, []},
          {Credo.Check.Refactor.VariableRebinding, []},
          {Credo.Check.Warning.LazyLogging, []},
          {Credo.Check.Warning.MapGetUnsafePass, []},

          #
          # Custom checks can be created using `mix credo.gen.check`.
          #
        ]
      }
    }
  ]
}

[mhanberg]

on interesting, i have never used a credo plugin before.

I'll make a ticket to address this.

thanks for helping me investigate!!

[mhanberg]

elixir-tools/credo-language-server#26

[mhanberg]

credo-language-server does not support Credo plugins yet, tracking in elixir-tools/credo-language-server#26

[mhanberg]

@jared-mackey elixir-tools/credo-language-server#32 should allow credo plugins and and custom credo checks to work.

I'll be releasing an rc release soon and i would appreciate if you could test it.

[jared-mackey]

@mhanberg Given I also can't seem to get them to run as a plugin do you still want me to somehow test this out? Happy to do so if you'd like. I plan on removing it as a plugin and just adding the checks manually now.

[mhanberg]

Yes, once I get an RC out, please check that it works when adding the Checks to the config.

[mhanberg]

I am getting this for that particular set of credo checks

┌─ 09:51:19 PM
│phoenix on  main +13 -5 [!?] via  v1.14.3 (OTP 25) via  v18.16.0 took 1m38s
└─  mix credo --all --strict "lib/phoenix/router.ex"
** (config) Ignoring an undefined check: CredoContrib.Check.Unstable
Checking 1 source file ...
Error while running Elixir.CredoContrib.Check.FunctionNameUnderscorePrefix on lib/phoenix/router.ex

21:51:26.681 [error] Task #PID<0.206.0> started from #PID<0.198.0> terminating
** (ArgumentError) errors were found at the given arguments:

  * 1st argument: not an atom

    :erlang.atom_to_binary({:unquote, [line: 665, column: 12], [{:name, [line: 665, column: 20], nil}]})
    lib/check/function_name_underscore_prefix.ex:19: CredoContrib.Check.FunctionNameUnderscorePrefix.traverse/3
    (elixir 1.14.3) lib/macro.ex:614: Macro.do_traverse/4
    (stdlib 4.3) lists.erl:1462: :lists.mapfoldl_1/3
    (elixir 1.14.3) lib/macro.ex:620: Macro.do_traverse/4
    (stdlib 4.3) lists.erl:1462: :lists.mapfoldl_1/3
    (elixir 1.14.3) lib/macro.ex:600: Macro.do_traverse/4
    (elixir 1.14.3) lib/macro.ex:615: Macro.do_traverse/4
Function: #Function<4.9167908/0 in CredoContrib.Check.FunctionNameUnderscorePrefix.do_run_on_all_source_files/3>
    Args: []
** (EXIT from #PID<0.95.0>) an exception was raised:
    ** (ArgumentError) errors were found at the given arguments:

  * 1st argument: not an atom

        :erlang.atom_to_binary({:unquote, [line: 665, column: 12], [{:name, [line: 665, column: 20], nil}]})
        lib/check/function_name_underscore_prefix.ex:19: CredoContrib.Check.FunctionNameUnderscorePrefix.traverse/3
        (elixir 1.14.3) lib/macro.ex:614: Macro.do_traverse/4
        (stdlib 4.3) lists.erl:1462: :lists.mapfoldl_1/3
        (elixir 1.14.3) lib/macro.ex:620: Macro.do_traverse/4
        (stdlib 4.3) lists.erl:1462: :lists.mapfoldl_1/3
        (elixir 1.14.3) lib/macro.ex:600: Macro.do_traverse/4
        (elixir 1.14.3) lib/macro.ex:615: Macro.do_traverse/4

[mhanberg]

@jared-mackey I am just trying to get that CredoContribu plugin to work at all and am having trouble (I just installed credo and credo_contrib in the phoenix code repo) and even running mix credo --strict --all does not show any of the rules being triggered.

You can confirm that that plugin works?

[jared-mackey]

@mhanberg Well, it used to work. Not sure when it stopped working but it looks like you're right. I added some stuff that should definitely fail and I am not getting any output from running credo. Removing it from plugins section and just adding some of the checks into my enabled checks immediately pick them up. I'll open an issue there.

[mhanberg]

@jared-mackey you should be able to try the rc release by updating the neovim plugin and then setting the version option in the setup block.

credo-language-server now will run your app in it's own node and compile it (it won't start it or anything, basically just an erlang node with your code in it), so it might take a little longer to put for the first time (if you check the logs or use my output-panel.nvim plugin, you should see the compiler logs.

local elixir = require("elixir")

elixir.setup {
  credo = { version = "0.1.0-rc.1" },
  },
}

[mhanberg]

Actually, you'll get this error

[Log] ** (File.Error) could not read file "/Users/mitchell/src/work/freeroll/config/credolsp.exs": no such file or directory
    (elixir 1.14.3) lib/file.ex:358: File.read!/1
    (elixir 1.14.3) lib/config.ex:273: Config.__import__!/1
    /Users/mitchell/src/work/freeroll/config/config.exs:227: (file)
    (stdlib 4.3) erl_eval.erl:748: :erl_eval.do_apply/7
    (stdlib 4.3) erl_eval.erl:136: :erl_eval.exprs/6

will try and figure out a fix

[mhanberg]

alright, 0.1.0-rc.2 has been released

[mhanberg]

@jared-mackey let me know if this works for you, i have release 0.1.0-rc.3