Skip to content

no-extraneous-require.md

Latest commit

 

History

History
52 lines (34 loc) · 2.16 KB

no-extraneous-require.md

File metadata and controls

52 lines (34 loc) · 2.16 KB

Disallow require() expressions which import extraneous modules (n/no-extraneous-require)

💼 This rule is enabled in the following configs: 🟢 recommended-module, ✅ recommended-script.

If a require()'s target is extraneous (it's not written in package.json), the program works in local, but may not work after dependencies are re-installed. It will cause troubles to your team/contributors. If a target is extraneous yet consistently works for you and your team, it may be a transitive dependency (a dependency of a dependency). Transitive dependencies should still be saved as an explicit dependency in package.json to avoid the risk of a dependency changing and removing the dependency of a dependency this require() is relying on.

This rule disallows require() of extraneous modules.

📖 Rule Details

This rule warns require() of extraneous modules.

Options

{
    "rules": {
        "n/no-extraneous-require": ["error", {
            "allowModules": [],
            "resolvePaths": [],
            "tryExtensions": []
        }]
    }
}

allowModules

This can be configured in the rule options or as a shared setting settings.allowModules. Please see the shared settings documentation for more information.

resolvePaths

This can be configured in the rule options or as a shared setting settings.resolvePaths. Please see the shared settings documentation for more information.

convertPath

This can be configured in the rule options or as a shared setting settings.convertPath. Please see the shared settings documentation for more information.

tryExtensions

This can be configured in the rule options or as a shared setting settings.tryExtensions. Please see the shared settings documentation for more information.

🔎 Implementation
⚡