can't find include lib "proper/include/proper.hrl"

[astutecat]

Hi,

I'm not 100% what's going on here but I am having trouble including proper in a simple test case. The extension is failing with 'can't find include lib "proper/include/proper.hrl"', when the CLI is perfectly happy to compile and run the test case in question.

My erlang_ls.config:

otp_path: "/Users/astutecat/.asdf/installs/erlang/23.1.1"
include_dirs:
  - "include/"
  - "_build/*/lib"
  - "_build/*/lib/*/include"
deps_dirs:
  - "_build/*/lib/*"
diagnostics:
  enabled:
    - compiler
    - dialyzer
  disabled:
    # Disable xref because it struggles with parse transform, like lager functions.
    - xref
lenses:
  enabled:
    - ct-run-test
    - show-behaviour-usages

my rebar.config:

{erl_opts, [debug_info]}.
{deps, []}.

%% the plugin itself
{project_plugins, [rebar3_proper]}.
%% The PropEr dependency is required to compile the test cases
%% and will be used to run the tests as well.
{profiles,
    [{test, [
        {deps, [
            %% hex
            {proper, "1.3.0"}
        ]}
    ]}
]}.

The file where the error is happening is in test/dog_sketch_test.erl and has this content:

-module(prop_dog_sketch).

-include_lib("proper/include/proper.hrl").

prop_test() ->
    ?FORALL(Type, (mytype()), begin boolean(Type) end).

boolean(_) -> true.

mytype() -> term().

The thing is, the include files definitely are in _build/test/lib/proper/include but it seems erlang_ls in VSCode is having trouble finding them.

Any ideas on what is wrong here? At first I thought it was to do with my configuration somewhere but I can't see where it would be having trouble.

[erpcfe]

The same thing happens to me and what I do is put the full path:

-include_lib("../_build/default/lib/proper/include/proper.hrl").

[robertoaloi]

@erpcfe That should not be required (and it could easily break when using different rebar3 profiles).

@astutecat The config I use for rebar3 projects:

deps_dirs:
  - "_build/*/lib/*"
include_dirs:
  - "_build/*/lib/*/include"
  - "include"

The only difference I can see is the trailing slash after include, but that shouldn't make a difference. Worth checking, though. The extra include_dir you have should also not be a problem, just un-necessary.

Could you show the tree of your _build directory? Did you try to enable debug mode for Erlang LS (https://erlang-ls.github.io/troubleshooting/#logging) and checked if there are any errors during indexing? You could also try removing the cache (https://erlang-ls.github.io/internals/) and try on a fresh DB.

[hackerjones]

I have the same issue. The workaround listed above does not work.

[robertoaloi]

@hackerjones What does your full erlang_ls.config look like? Can you please provide a minimal example of a repo where navigation to proper fails? Moving this to a Support Discussion.

[hackerjones]

I have created a very minimal example here https://github.com/hackerjones/els_proper

[robertoaloi]

Thanks, this helps! I can now reproduce the issue.

[robertoaloi]

Adjust your erlang_ls.config as follows:

deps_dirs:
  - "_build/*/lib/*"
include_dirs:
  - "_build/*/lib"
  - "_build/*/lib/*/include"
  - "include"

The important line here was:

  - "_build/*/lib"

Hopefully, once the BSP support is stable enough, the need for manual configuration will disappear altogether!

[hackerjones]

My real project's config file looks like this and it does not work. It is an umbrella project so maybe that has something to do with it.

[hackerjones]

If I set my projects config to exactly as you have show it also works in the umbrella. Perhaps its another item in the config that is causing this to misbehave. I am going line by line to see if I can pin it down.

[hackerjones]

It appears my old eyes have failed me. My config file had:

- "_build/*/lib/*"

instead of:

- "_build/*/lib"

Time to increase the font size again. Sorry for the noise.