eslint ignores symbolic links to files when traversing directories

[rtpg]

In the following code we have an .isFile check on a Dirent object

eslint/lib/cli-engine/file-enumerator.js

Line 429 in 091e52a

if (entry.isFile()) {

However the node documentation says the isFile check is for if the file is a regular file, and returns false on symbolic links.

This makes it hard to run eslint against sandboxed bazel files, for example (since the sandboxing happens through symlinks)

Not 100% sure what's best here but "not a directory" feels like a nicer check here than "is a regular file". Might be a bit impossible to resolve.

[mdjermanovic]

Hi @rtpg, thanks for the issue!

I think this is similar to #13551, but for files. Looks like a bug to me.

Until we verify and possibly fix this, a workaround (though an inconvenient one if you have multiple symlinked files) is to explicitly list those files as command-line arguments. For example:

 eslint src src/file1.js 

That way, the src/file1.js path will be checked here. statSafeSync(absolutePath).isFile() follows links and returns true if it is a file.

[eslint-deprecated]

Unfortunately, it looks like there wasn't enough interest from the team
or community to implement this change. While we wish we'd be able to
accommodate everyone's requests, we do need to prioritize. We've found
that issues failing to reach accepted status after 21 days tend to
never be accepted, and as such, we close those issues.
This doesn't mean the idea isn't interesting or useful, just that it's
not something the team can commit to.

Thanks for contributing to ESLint and we appreciate your understanding.

[mdjermanovic]

Reopening as this is most likely a bug.

[blindspeed90]

I'm not a Linux expert but glob expansion didn't recurse and work for extensions (like "/myrootsrc/**/*.js"). Instead I used "find" for "js" files only, in case anyone else wants a workaround (and yes it can create a long cmdline, and I don't have spaces in paths):

ROOT_DIR=/myrootsrc

TODO: Hack 7.x ignoring symbolic links by finding the files ourselves and passing them in

ROOT_DIR=$(find $ROOT_DIR -name "*.js")
auditjs $AUDIT_OPTS $ROOT_DIR

[mrl5]

I'm interested if there are any plans to fix this

[mdjermanovic]

Hi @mrl5! This will be fixed by #14126.

[bidoubiwa]

Hey! This introduced a breaking change for me.

Oops! Something went wrong! :(

ESLint: 7.21.0

Error: ELOOP: too many symbolic links encountered,