feat: create new valid-mock-module-path rule (#1845)

* feat(rule): add new rule to validate `jest.mock` path existence

Signed-off-by: hainenber <[email protected]>

* chore: update rules.test.ts due to newly added rule

Signed-off-by: hainenber <[email protected]>

* chore: rewrite implementation to return early when linting over unwanted LoCs

Signed-off-by: hainenber <[email protected]>

* fix(ci): verify broken npmjs link in MD file by checking its `registry.npmjs.org` URI instead

Signed-off-by: hainenber <[email protected]>

* build(dev-deps): update `markdown-link-check`

Signed-off-by: hainenber <[email protected]>

* feat: apply suggestions from @G-Rath code review

Co-authored-by: Gareth Jones <[email protected]>

* Revert "fix(ci): verify broken npmjs link in MD file by checking its `registry.npmjs.org` URI instead"

This reverts commit c7d1901.

* Revert "build(dev-deps): update `markdown-link-check`"

This reverts commit fee7e7a.

* feat: change rule name + add tests + configurable module file extensions + faster return branches

Signed-off-by: hainenber <[email protected]>

* Apply suggestions from @G-Rath's code review

Co-authored-by: Gareth Jones <[email protected]>

* Apply 2nd suggestion from @G-Rath

Co-authored-by: Gareth Jones <[email protected]>

* feat: recast err to `unknown` + refactor to return happy path asap

Signed-off-by: hainenber <[email protected]>

* chore: rerun `yarn regenerate-docs`

Signed-off-by: hainenber <[email protected]>

* Update src/rules/valid-mock-module-path.ts

Co-authored-by: Gareth Jones <[email protected]>

* feat(rule/valid-mock-module-path): add test to cover code branch that throws unexpected OS error

Signed-off-by: hainenber <[email protected]>

* chore: fix correct config to test `valid-mock-module-path` on eslint v9

Signed-off-by: hainenber <[email protected]>

---------

Signed-off-by: hainenber <[email protected]>
Co-authored-by: Gareth Jones <[email protected]>

Author: hainenber

README.md

@@ -386,6 +386,7 @@ Manually fixable by
 | [valid-describe-callback](docs/rules/valid-describe-callback.md)                     | Enforce valid `describe()` callback                                       | ✅  |     |     |     |
 | [valid-expect](docs/rules/valid-expect.md)                                           | Enforce valid `expect()` usage                                            | ✅  |     | 🔧  |     |
 | [valid-expect-in-promise](docs/rules/valid-expect-in-promise.md)                     | Require promises that have expectations in their chain to be valid        | ✅  |     |     |     |
+| [valid-mock-module-path](docs/rules/valid-mock-module-path.md)                       | Disallow mocking of non-existing module paths                             |     |     |     |     |
 | [valid-title](docs/rules/valid-title.md)                                             | Enforce valid titles                                                      | ✅  |     | 🔧  |     |
 
 ### Requires Type Checking

docs/rules/valid-mock-module-path.md

@@ -0,0 +1,70 @@
+# Disallow mocking of non-existing module paths (`valid-mock-module-path`)
+
+<!-- end auto-generated rule header -->
+
+This rule raises an error when using `jest.mock` and `jest.doMock` and the first
+argument for mocked object (module/local file) do not exist.
+
+## Rule details
+
+This rule checks existence of the supplied path for `jest.mock` or `jest.doMock`
+in the first argument.
+
+The following patterns are considered errors:
+
+```js
+// Module(s) that cannot be found
+jest.mock('@org/some-module-not-in-package-json');
+jest.mock('some-module-not-in-package-json');
+
+// Local module (directory) that cannot be found
+jest.mock('../../this/module/does/not/exist');
+
+// Local file that cannot be found
+jest.mock('../../this/path/does/not/exist.js');
+```
+
+The following patterns are **not** considered errors:
+
+```js
+// Module(s) that can be found
+jest.mock('@org/some-module-in-package-json');
+jest.mock('some-module-in-package-json');
+
+// Local module that cannot be found
+jest.mock('../../this/module/really/does/exist');
+
+// Local file that cannot be found
+jest.mock('../../this/path/really/does/exist.js');
+```
+
+## Options
+
+```json
+{
+  "jest/valid-mock-module-path": [
+    "error",
+    {
+      "moduleFileExtensions": [".js", ".ts", ".jsx", ".tsx", ".json"]
+    }
+  ]
+}
+```
+
+### `moduleFileExtensions`
+
+This array option controls which file extensions the plugin checks for
+existence. The default extensions are:
+
+- `".js"`
+- `".ts"`
+- `".jsx"`
+- `".tsx"`
+- `".json"`
+
+For any custom extension, a preceding dot **must** be present before the file
+extension for desired effect.
+
+## When Not To Use It
+
+Don't use this rule on non-jest test files.

src/__tests__/__snapshots__/rules.test.ts.snap

@@ -72,6 +72,7 @@ exports[`rules should export configs that refer to actual rules 1`] = `
       "jest/valid-describe-callback": "error",
       "jest/valid-expect": "error",
       "jest/valid-expect-in-promise": "error",
+      "jest/valid-mock-module-path": "error",
       "jest/valid-title": "error",
     },
   },
@@ -164,6 +165,7 @@ exports[`rules should export configs that refer to actual rules 1`] = `
       "jest/valid-describe-callback": "error",
       "jest/valid-expect": "error",
       "jest/valid-expect-in-promise": "error",
+      "jest/valid-mock-module-path": "error",
       "jest/valid-title": "error",
     },
   },

src/__tests__/rules.test.ts

@@ -2,7 +2,7 @@ import { existsSync } from 'fs';
 import { resolve } from 'path';
 import plugin from '../';
 
-const numberOfRules = 63;
+const numberOfRules = 64;
 const ruleNames = Object.keys(plugin.rules);
 const deprecatedRules = Object.entries(plugin.rules)
   .filter(([, rule]) => rule.meta.deprecated)

src/rules/__tests__/fixtures/module/bar.css

@@ -0,0 +1,6 @@
+.bar-container {
+    background-color: #f5f5f5;
+    padding: 16px;
+    border-radius: 8px;
+    box-shadow: 0 2px 8px rgba(0,0,0,0.1);
+}

src/rules/__tests__/fixtures/module/bar.json

@@ -0,0 +1 @@
+{}

src/rules/__tests__/fixtures/module/foo.js

@@ -0,0 +1 @@
+export const foo = 'foo_js';

src/rules/__tests__/fixtures/module/foo.ts

@@ -0,0 +1 @@
+export const foo = 'foo_ts';

src/rules/__tests__/fixtures/module/index.ts

@@ -0,0 +1 @@
+export * from './foo';