Skip to content

Latest commit

 

History

History
61 lines (39 loc) · 1.42 KB

no-commonjs.md

File metadata and controls

61 lines (39 loc) · 1.42 KB
Raw

import/no-commonjs

Reports require([string]) function calls. Will not report if >1 argument, or single argument is not a literal string.

Reports module.exports or exports.*, also.

Intended for temporary use when migrating to pure ES6 modules.

Rule Details

This will be reported:

var mod = require('./mod')
  , common = require('./common')
  , fs = require('fs')
  , whateverModule = require('./not-found')

module.exports = { a: "b" }
exports.c = "d"

If allow-primitive-modules is provided as an option, the following is valid:

/*eslint no-commonjs: [2, "allow-primitive-modules"]*/

module.exports = "foo"
module.exports = function rule(context) { return { /* ... */ } }

but this is still reported:

/*eslint no-commonjs: [2, "allow-primitive-modules"]*/

module.exports = { x: "y" }
exports.z = function boop() { /* ... */ }

This is useful for things like ESLint rule modules, which must export a function as the module.

When Not To Use It

If you don't mind mixing module systems (sometimes this is useful), you probably don't want this rule.

It is also fairly noisy if you have a larger codebase that is being transitioned from CommonJS to ES6 modules.

Contributors

Special thanks to @xjamundx for donating the module.exports and exports.* bits.

Further Reading