Eslint workingDirectory.mode = auto breaks path resolution in a monorepo

[MaxShymko]

Description

• nvim: v0.11.5
• nvim-lspconfig: master

workingDirectory.mode was updated from location to auto in #3955. After this change, I started seeing an issue with ESLint config path resolution in monorepo packages. Setting workingDirectory.mode = location fixes the issue.

I created an example: https://github.com/MaxShymko/eslint-issue
LSP works fine in file1.ts
but breaks in file2.ts with error

eslint: Parsing error: Cannot read file '/Users/maxshymko/src/eslint-issue/src/packages/package1/tsconfig.json'.

My workaround for now is:

vim.lsp.config('eslint', {
  settings = {
    workingDirectory = { mode = 'location' },
  },
})

Should we roll back mode to location, or will it break something else?
@fuegoio, would love to hear your thoughts!

[fuegoio]

Hello!

It seems that your monorepo is a bit strangely shaped. ESLint expects a tsconfig.json file in the package1 folder, which I think is not absurd. There is no tsconfig inheritance of parent project so if you want this package to be compatible with TS you need to add one I think.

The problem with location is that it refers to the current workspace but there is no such thing in Nvim. It will use the file folder but that's not really compatible with monorepos which can share ESLint configuration.

If that does not work for you, you can still override this in your Nvim config, but I do think the auto mode is a good default for everyone.

[BenoitZugmeyer]

👋 Just to give a bit of feedback, I stumbled into this issue while trying to understand why import/no-unresolved was failing in nvim and not when running the CLI. Environment:

• using eslint-import-resolver-typescript
• monorepo similar to @MaxShymko example https://github.com/MaxShymko/eslint-issue (no tsconfig in packages)

The problem with location is that it refers to the current workspace but there is no such thing in Nvim. It will use the file folder but that's not really compatible with monorepos which can share ESLint configuration.

From my experience, this is not the case. Using mode = 'location' fixes the issue, because it's using the root_dir as a working directory, which is detected by looking for the lockfile instead of package.json.

Thank you @MaxShymko for the workaround!

[fuegoio]

Thank you for the feedback @BenoitZugmeyer!

From my experience, this is not the case. Using mode = 'location' fixes the issue, because it's using the root_dir as a working directory, which is detected by looking for the lockfile instead of package.json.

The issue is to have multiple ESLint configurations in several projects that share the same lock file. In this case, the ESLint rules will not be correctly infered for each project.

I recommend nevertheless to have a TSConfig file in each of your subpackage, as I think it's the only way for multiple tools in the ecosystem to infer your Typescript configuration for a package.

[BenoitZugmeyer]

Thank you for your recommendation but I won't change my project setup, it works fine for all other contributors. Since mode = 'location' works fine for me, I'm good!

Thank you for nvim-lspconfig, it's a great project.