no-restricted-modules.md

Disallow Node.js modules (no-restricted-modules)

Disallowing usage of specific Node.js modules can be useful if you want to control the available methods, a developer can use, to implement a feature.

This way you can block usage of the fs module if you want to disallow file system access. Blocking the os module can be useful if you don't want to allow any operating system specific code.

Rule Details

This rule allows you to specify modules that you don't want to use in your application.

Options

The rule takes one or more strings as options: the names of restricted modules.

It can also take an object with lists of "paths" and gitignore-style "patterns" strings.

For example, to restrict the use of all Node.js core modules (via https://github.com/nodejs/node/tree/master/lib):

{
    "no-restricted-modules": ["error",
        "assert","buffer","child_process","cluster","crypto","dgram","dns","domain","events","freelist","fs","http","https","module","net","os","path","punycode","querystring","readline","repl","smalloc","stream","string_decoder","sys","timers","tls","tracing","tty","url","util","vm","zlib"
    ]
}

You may also specify a custom message for any paths you want to restrict as follows:

"no-restricted-modules": ["error", [{
  "name": "foo-module",
  "message": "Please use bar-module instead."
}]]

or like this:

"no-restricted-modules": ["error", {
  "paths": [{
    "name": "foo-module",
    "message": "Please use bar-module instead."
  }]
}]

The custom message will be appended to the default error message. Please note that you may not specify custom error messages for restricted patterns as a particular module may match more than one pattern.

Examples of incorrect code for this rule with sample "fs", "cluster" restricted modules:

/*eslint no-restricted-modules: ["error", "fs", "cluster"]*/

var fs = require('fs');
var cluster = require('cluster');

/*eslint no-restricted-modules: ["error", { "paths": ["cluster"] }]*/

var cluster = require('cluster');

/*eslint no-restricted-modules: ["error", { "patterns": ["lodash/*"] }]*/

var cluster = require('lodash/pick');

Examples of correct code for this rule with sample "fs", "cluster" restricted modules:

/*eslint no-restricted-modules: ["error", "fs", "cluster"]*/

var crypto = require('crypto');

/*eslint no-restricted-modules: ["error", {
    "paths": ["fs", "cluster"],
    "patterns": ["lodash/*", "!lodash/pick"]
}]*/

var crypto = require('crypto');
var eslint = require('lodash/pick');