github-pages-deploy-action/node_modules/eslint-plugin-import/docs/rules/no-nodejs-modules.md
2020-03-06 22:45:40 -05:00

816 B

import/no-nodejs-modules: No Node.js builtin modules

Forbid the use of Node.js builtin modules. Can be useful for client-side web projects that do not have access to those modules.

Options

This rule supports the following options:

  • allow: Array of names of allowed modules. Defaults to an empty array.

Rule Details

Fail

import fs from 'fs';
import path from 'path';

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

Pass

import _ from 'lodash';
import foo from 'foo';
import foo from './foo';

var _ = require('lodash');
var foo = require('foo');
var foo = require('./foo');

/* eslint import/no-nodejs-modules: ["error", {"allow": ["path"]}] */
import path from 'path';

When Not To Use It

If you have a project that is run mainly or partially using Node.js.