Bug: nested plugins cannot be found when nested in a shared config (6.0.0) #11884

nevir · 2019-06-23T17:38:31Z

TL;DR: if a shared config package has plugins that npm or yarn decides to install as descendents of it, those plugins cannot be found by the config factory.

This is a reproduction PR to highlight the issue—I haven't determined a fix yet, and would love pointers if you all have ideas!

What is the purpose of this pull request? (put an "X" next to item)

[x] Bug report (template)

Tell us about your environment

ESLint Version: 6.0.0
Node Version: 10.15.1
npm Version: 6.9.0

Please show your full configuration:

See the fixtures for real files

Package Layout & Configuration

Package Tree:

<root>
  eslint-config-awesome
    awesome-parser
    eslint-plugin-awesome

<root>/.eslintrc.yml:

extends:
  - awesome

eslint-config-awesome/index.js:

module.exports = {
  parser: 'awesome-parser',
  plugins: ['awesome'],
  rules: {
    'awesome/is-awesome': [2]
  }
};

What did you do? Please include the actual source code causing the issue.

eslint any-file.js

What did you expect to happen?

Eslint would make it to linting the desired file

What actually happened? Please include the actual, raw output from ESLint.

Error: Failed to load plugin 'awesome' declared in '.eslintrc.yml » eslint-config-awesome': Cannot find module 'eslint-plugin-awesome'

…odejs/node#11422)

nevir · 2019-06-23T17:45:39Z

Honoring importerPath in ConfigArrayFactory#_loadPlugin fixes this specific issue, but triggers other failures.

Interestingly, honoring importerPath is already the behavior for extended configs, and parsers. Smells like it might actually be the right path to take, but I don't know this well enough yet…

nevir · 2019-06-23T17:50:06Z

tests/lib/cli-engine/cascading-config-array-factory.js

+                        "awesome/is-awesome": [2]
+                    }
+                };
+                const actual = getConfig(factory, file);


This throws with:

Error: Failed to load plugin 'awesome' declared in '.eslintrc.yml » eslint-config-awesome': Cannot find module 'eslint-plugin-awesome' Require stack: - /private/var/folders/j6/0rhhpj0x0db7yqhhby7x27_r0000gn/T/eslint/fixtures/config-hierarchy/nested-plugins-parser/__placeholder__.js at Function.Module._resolveFilename (internal/modules/cjs/loader.js:581:15) at Function.resolve (internal/modules/cjs/helpers.js:32:19) at Object.resolve (lib/shared/relative-module-resolver.js:44:50) at ConfigArrayFactory._loadPlugin (lib/cli-engine/config-array-factory.js:840:39) at names.reduce (lib/cli-engine/config-array-factory.js:729:33) at Array.reduce (<anonymous>) at ConfigArrayFactory._loadPlugins (lib/cli-engine/config-array-factory.js:725:22) at ConfigArrayFactory._normalizeObjectConfigDataBody (lib/cli-engine/config-array-factory.js:551:32) at _normalizeObjectConfigDataBody.next (<anonymous>) at ConfigArrayFactory._normalizeObjectConfigData (lib/cli-engine/config-array-factory.js:490:20) at _normalizeObjectConfigData.next (<anonymous>) at ConfigArrayFactory._normalizeObjectConfigDataBody (lib/cli-engine/config-array-factory.js:544:25) at _normalizeObjectConfigDataBody.next (<anonymous>) at ConfigArrayFactory._normalizeObjectConfigData (lib/cli-engine/config-array-factory.js:490:20) at _normalizeObjectConfigData.next (<anonymous>) at createConfigArray (lib/cli-engine/config-array-factory.js:306:25) at ConfigArrayFactory.loadInDirectory (lib/cli-engine/config-array-factory.js:399:16) at CascadingConfigArrayFactory._loadConfigInAncestors (lib/cli-engine/cascading-config-array-factory.js:293:46) at CascadingConfigArrayFactory.getConfigArrayForFile (lib/cli-engine/cascading-config-array-factory.js:238:18) at getConfig (tests/lib/cli-engine/cascading-config-array-factory.js:144:22) at Context.it (tests/lib/cli-engine/cascading-config-array-factory.js:590:32)

Debug output leading up to the failure:

eslint:config-array-factory Loading YAML config file: /private/var/folders/j6/0rhhpj0x0db7yqhhby7x27_r0000gn/T/eslint/fixtures/config-hierarchy/nested-plugins-parser/.eslintrc.yml +0ms eslint:config-array-factory Config file found: /private/var/folders/j6/0rhhpj0x0db7yqhhby7x27_r0000gn/T/eslint/fixtures/config-hierarchy/nested-plugins-parser/.eslintrc.yml +5ms eslint:config-array-factory Loading {extends:"awesome"} relative to /private/var/folders/j6/0rhhpj0x0db7yqhhby7x27_r0000gn/T/eslint/fixtures/config-hierarchy/nested-plugins-parser/.eslintrc.yml +15ms eslint:config-array-factory Loaded: eslint-config-awesome@1.0.0 (/private/var/folders/j6/0rhhpj0x0db7yqhhby7x27_r0000gn/T/eslint/fixtures/config-hierarchy/nested-plugins-parser/node_modules/eslint-config-awesome/index.js) +1ms eslint:config-array-factory Loading JS config file: /private/var/folders/j6/0rhhpj0x0db7yqhhby7x27_r0000gn/T/eslint/fixtures/config-hierarchy/nested-plugins-parser/node_modules/eslint-config-awesome/index.js +0ms eslint:config-array-factory Loading parser "awesome-parser" from /private/var/folders/j6/0rhhpj0x0db7yqhhby7x27_r0000gn/T/eslint/fixtures/config-hierarchy/nested-plugins-parser/node_modules/eslint-config-awesome/index.js +1ms eslint:config-array-factory Loaded: awesome-parser@1.0.0 (/private/var/folders/j6/0rhhpj0x0db7yqhhby7x27_r0000gn/T/eslint/fixtures/config-hierarchy/nested-plugins-parser/node_modules/eslint-config-awesome/node_modules/awesome-parser/index.js) +2ms eslint:config-array-factory Loading plugin "awesome" from /private/var/folders/j6/0rhhpj0x0db7yqhhby7x27_r0000gn/T/eslint/fixtures/config-hierarchy/nested-plugins-parser/node_modules/eslint-config-awesome/index.js +1ms eslint:config-array-factory Failed to load plugin 'awesome' declared in '.eslintrc.yml » eslint-config-awesome'. +1ms

Note that the ConfigArrayFactory is trying to resolve plugin 'awesome' relative to the root package, not eslint-config-awesome (but the require stack thinks otherwise)

relativeTo points to:
eslint/fixtures/config-hierarchy/nested-plugins-parser/__placeholder__.js

This reverts commit b33378e.

mysticatea · 2019-06-23T18:22:47Z

Hi. Thank you for your contribution.

But this is by design. All plugins must be in $CWD/node_modules (or the ancestors) because rule ID must be identified to a rule. You can see some long discussion:

nevir · 2019-06-24T15:39:11Z

Ah, doh :( Thanks for the background 👍 That's a tricky set of constraints to navigate…

Fix: resolve the final path for fixtureDir (it's a symlink on OS X: n…

3d1fb8e

…odejs/node#11422)

eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label Jun 23, 2019

nevir changed the title ~~Nevir/nested configs with plugins parsers~~ 6.0.0 Bug: nested plugins cannot be found when nested in a shared config Jun 23, 2019

nevir changed the title ~~6.0.0 Bug: nested plugins cannot be found when nested in a shared config~~ Bug [6.0.0]: nested plugins cannot be found when nested in a shared config Jun 23, 2019

nevir changed the title ~~Bug [6.0.0]: nested plugins cannot be found when nested in a shared config~~ Bug: nested plugins cannot be found when nested in a shared config (6.0.0) Jun 23, 2019

nevir commented Jun 23, 2019

View reviewed changes

nevir added 3 commits June 23, 2019 10:56

Add failing example

285595d

Attempt to fix

d33766f

Revert "Attempt to fix" to focus the PR on the bug rather than fix

0b7875e

This reverts commit b33378e.

mysticatea closed this Jun 23, 2019

nevir deleted the nevir/nested-configs-with-plugins-parsers branch June 24, 2019 15:39

eslint-deprecated bot locked and limited conversation to collaborators Dec 21, 2019

eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Dec 21, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bug: nested plugins cannot be found when nested in a shared config (6.0.0) #11884

Bug: nested plugins cannot be found when nested in a shared config (6.0.0) #11884

nevir commented Jun 23, 2019 •

edited

nevir commented Jun 23, 2019 •

edited

nevir Jun 23, 2019

nevir Jun 23, 2019 •

edited

nevir Jun 23, 2019 •

edited

mysticatea commented Jun 23, 2019 •

edited

nevir commented Jun 24, 2019

Bug: nested plugins cannot be found when nested in a shared config (6.0.0) #11884

Bug: nested plugins cannot be found when nested in a shared config (6.0.0) #11884

Conversation

nevir commented Jun 23, 2019 • edited

nevir commented Jun 23, 2019 • edited

nevir Jun 23, 2019

Choose a reason for hiding this comment

nevir Jun 23, 2019 • edited

Choose a reason for hiding this comment

nevir Jun 23, 2019 • edited

Choose a reason for hiding this comment

mysticatea commented Jun 23, 2019 • edited

nevir commented Jun 24, 2019

nevir commented Jun 23, 2019 •

edited

nevir commented Jun 23, 2019 •

edited

nevir Jun 23, 2019 •

edited

nevir Jun 23, 2019 •

edited

mysticatea commented Jun 23, 2019 •

edited