Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Bug: `FlatESLint` `getRulesMetaForResults` fails on anonymous files when option `cwd` is set

See original GitHub issue


Node version: v18.10.0 npm version: v8.19.2 Local ESLint version: v8.25.0 (Currently used) Global ESLint version: Not found Operating System: darwin 21.6.0

What parser are you using?

Default (Espree)

What did you do?

Using FlatESLint, the method getRulesMetaForResults thows an error for certain values of the option cwd when passed a result of an anonymous file. This happens whenever cwd is set to a subdirectory of the current directory.

The following repro shows the problem.

import { join } from 'path';

const { default: { FlatESLint } } = await import('eslint/use-at-your-own-risk');

const cwd = join(process.cwd(), 'test'); // subdir 'test' doesn't need to exist for this repro.
const eslint = new FlatESLint({
    overrideConfig: { rules: { 'no-undef': 'warn' } },
    overrideConfigFile: true,
const results = await eslint.lintText('foo()');
eslint.getRulesMetaForResults(results); // throws TypeError

What did you expect to happen?

Calling getRulesMetaForResults with the result of an anonymous file should not throw an error, regardless of the engine’s cwd.

What actually happened?

The above repro fails with an error like this:

    const plugin = config.plugins && config.plugins[pluginName];

TypeError: Cannot read properties of undefined (reading 'plugins')
    at getRuleFromConfig (.../node_modules/eslint/lib/config/flat-config-helpers.js:54:27)
    at FlatESLint.getRulesMetaForResults (.../node_modules/eslint/lib/eslint/flat-eslint.js:703:30)
    at file://.../example.mjs:12:8


  • I am willing to submit a pull request for this issue.

Additional comments

What strikes me in the implementation are the different values used to call configs.getConfig in the case of an anonymous file: lintText calls configs.getConfig with a full path like ${cwd}/__placeholder__.js

whereas getRulesMetaForResults ends up calling configs.getConfig("__placeholder__.js")

Then it finds no config and it fails.

Another issue related to this is the unhelpful message of the TypeError. When getRulesMetaForResults finds no matching config, it could simply tell the user that the results were not created from the current instance of ESLint (not the case here, but still). The error message is already there, but it is currently only used in a more limited edge case:

Issue Analytics

  • State:closed
  • Created a year ago
  • Comments:5 (5 by maintainers)

github_iconTop GitHub Comments

mdjermanoviccommented, Oct 13, 2022

getConfig() can be costly, but at that point config for the filePath should have already been calculated (because the file was linted) and cached. so it will just return the cached config object. After finding a message that has ruleId, we could check if config is not an object and throw a better error message, as it is unexpected that ignored files have messages from rules.

mdjermanoviccommented, Oct 14, 2022

Shall I extend #16409 or create a new PR?

As #16409 is already being reviewed, it might be better to create a new PR that fixes the two problems from this issue (handling the "<text>" file path, and improving the error message when file doesn’t have a config).

Read more comments on GitHub >

github_iconTop Results From Across the Web

ESLint's new config system, Part 3: Developer preview
Using flat config with the ESLint class · Caching is not yet implemented in FlatESLint , so cache: true throws an error. ·...
Read more >
eslint | Yarn - Package Manager
A bug fix in a rule that results in ESLint reporting fewer linting errors. A bug fix to the CLI or core (including...
Read more >
My create-react-app is failing to compile due to ESLint error
I have had the exact same errors when I created app using the create-react-app and setup the eslint for the application.
Read more >
Bug : `FlatESLint` `getRulesMetaForResults` fails on anonymous files when option `cwd` is set. Previous Next. Make software development more efficient, ...
Read more >
enhancement: sort menu - Nocodb ...
on hold - need reorder of the options ... Bug: `FlatESLint` `getRulesMetaForResults` fails on anonymous files when option `cwd` is set, 5, 2022-10-11 ......
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Post

No results found

github_iconTop Related Hashnode Post

No results found