[Feature/Bug Report] Discourage/disable "./" as one of the "moduleDirectories"

[davidroeca]

🐛 Bug Report

This is a bug report pertaining to the use of "./" as one of the moduleDirectories. In particular, I was using a scoped package that had the same subdirectory name as a non-scoped package (e.g. @my-scope/my-package relies on my-package as an external/peer dependency). This prevented @my-scope/my-package from having access to my-package.

To Reproduce

See this repo

Expected behavior

Ideally, this behavior is not allowed. We should instead encourage people to use moduleNameMapper.

Link to repl or repo (highly encouraged)

Again see https://github.com/davidroeca/jest-shadowing-issue

envinfo

  System:
    OS: Linux 5.4 Linux Mint 20 (Ulyana)
    CPU: (8) x64 Intel(R) Core(TM) i5-8350U CPU @ 1.70GHz
  Binaries:
    Node: 14.9.0 - ~/.asdf/installs/nodejs/14.9.0/bin/node
    Yarn: 1.22.4 - ~/.asdf/shims/yarn
    npm: 6.14.8 - ~/.asdf/installs/nodejs/14.9.0/bin/npm
  npmPackages:
    jest: ^26.4.2 => 26.4.2

[davidroeca]

Apologies, hit enter too soon. Edited the issue with the correct info.

[geritol]

I have also run into this issue (@emotion/react having react as a dependency).
@davidroeca I think the Needs Repro label can be removed as there seems to be a reproduction.

[geritol]

for the record:

// jest.config.js
module.exports = {
  // ...
-  moduleDirectories: ["node_modules", "."]
+  moduleDirectories: ["node_modules", "<rootDir>"],
};

solves the issue

[github-actions]

This issue is stale because it has been open for 1 year with no activity. Remove stale label or comment or this will be closed in 30 days.

[davidroeca]

I see no mentions/cautions here. I believe it is still at the very least worth discouraging somewhere in the docs.

[github-actions]

This issue is stale because it has been open for 1 year with no activity. Remove stale label or comment or this will be closed in 30 days.