docs: Explain the transitive dependency case for no-extraneous-* (#347)

Co-authored-by: Sebastian Good <2230835+scagood@users.noreply.github.com>
eslint-community · Sep 26, 2024 · 8c0a2cc · 8c0a2cc
1 parent 85b7945
commit 8c0a2cc
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/docs/rules/no-extraneous-import.md b/docs/rules/no-extraneous-import.md
@@ -4,7 +4,10 @@
 
 <!-- end auto-generated rule header -->
 
-If an `import` declaration's source is extraneous (it's not written in `package.json`), the program works in local, but will not work after dependencies are re-installed. It will cause troubles to your team/contributors.
+If an `import` declaration's source is extraneous (it's not listed in your `package.json`), the program may work locally but can break after dependencies are re-installed. This can cause issues for your team/contributors. If a declaration source is extraneous yet consistently works for you and your team, it might be a transitive dependency (a dependency of another dependency). Transitive dependencies should still be added as an explicit dependency in your `package.json` to avoid the risk of a dependency potentially changing or removing the transitive dependency.
+
+Additionally, the transitive dependency could be a dev dependency, meaning your code could work in development but not in production.
+
 This rule disallows `import` declarations of extraneous modules.
 
 ## 📖 Rule Details

diff --git a/docs/rules/no-extraneous-require.md b/docs/rules/no-extraneous-require.md
@@ -4,7 +4,10 @@
 
 <!-- end auto-generated rule header -->
 
-If a `require()`'s target is extraneous (it's not written in `package.json`), the program works in local, but will not work after dependencies are re-installed. It will cause troubles to your team/contributors.
+If a `require()`'s target is extraneous (it's not listed in your `package.json`), the program may work locally but can break after dependencies are re-installed. This can cause issues for your team/contributors. If a declaration source is extraneous yet consistently works for you and your team, it might be a transitive dependency (a dependency of another dependency). Transitive dependencies should still be added as an explicit dependency in your `package.json` to avoid the risk of a dependency potentially changing or removing the transitive dependency.
+
+Additionally, the transitive dependency could be a dev dependency, meaning your code could work in development but not in production.
+
 This rule disallows `require()` of extraneous modules.
 
 ## 📖 Rule Details