Skip to content
Permalink
Browse files

tools: DRY isRequireCall() in lint rules

This commit makes isRequireCall() a reusable utility
function for core's custom ESLint rules.

PR-URL: #27680
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Yongsheng Zhang <zyszys98@gmail.com>
  • Loading branch information...
cjihrig committed May 13, 2019
1 parent 53bef42 commit 03d43539f93be2c401f57d7eac87a5ae933ef905
@@ -4,6 +4,8 @@
*/
'use strict';

const { isRequireCall } = require('./rules-utils.js');

//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------
@@ -13,10 +15,6 @@ function isString(node) {
return node && node.type === 'Literal' && typeof node.value === 'string';
}

function isRequireCall(node) {
return node.callee.type === 'Identifier' && node.callee.name === 'require';
}

function isTopLevel(node) {
do {
if (node.type === 'FunctionDeclaration' ||
@@ -4,6 +4,7 @@
'use strict';

const path = require('path');
const { isRequireCall } = require('./rules-utils.js');

//------------------------------------------------------------------------------
// Rule Definition
@@ -23,15 +24,6 @@ module.exports = function(context) {
return node && node.type === 'Literal' && typeof node.value === 'string';
}

/**
* Function to check if a node is a require call.
* @param {ASTNode} node The node to check.
* @returns {boolean} If the node is a require call.
*/
function isRequireCall(node) {
return node.callee.type === 'Identifier' && node.callee.name === 'require';
}

/**
* Function to check if the path is a module and return its name.
* @param {String} str The path to check
@@ -4,6 +4,8 @@
*/
'use strict';

const { isRequireCall } = require('./rules-utils.js');

//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------
@@ -32,15 +34,6 @@ module.exports = function(context) {
return node && node.type === 'Literal' && typeof node.value === 'string';
}

/**
* Function to check if a node is a require call.
* @param {ASTNode} node The node to check.
* @returns {boolean} If the node is a require call.
*/
function isRequireCall(node) {
return node.callee.type === 'Identifier' && node.callee.name === 'require';
}

/**
* Function to check if the path is a required module and return its name.
* @param {String} str The path to check
@@ -3,6 +3,11 @@
*/
'use strict';

function isRequireCall(node) {
return node.callee.type === 'Identifier' && node.callee.name === 'require';
}
module.exports.isRequireCall = isRequireCall;

module.exports.isDefiningError = function(node) {
return node.expression &&
node.expression.type === 'CallExpression' &&
@@ -16,7 +21,7 @@ module.exports.isDefiningError = function(node) {
* require calls.
*/
module.exports.isRequired = function(node, modules) {
return node.callee.name === 'require' && node.arguments.length !== 0 &&
return isRequireCall(node) && node.arguments.length !== 0 &&
modules.includes(node.arguments[0].value);
};

@@ -26,7 +31,7 @@ module.exports.isRequired = function(node, modules) {
*/
const commonModuleRegExp = new RegExp(/^(\.\.\/)*common(\.js)?$/);
module.exports.isCommonModule = function(node) {
return node.callee.name === 'require' &&
return isRequireCall(node) &&
node.arguments.length !== 0 &&
commonModuleRegExp.test(node.arguments[0].value);
};

0 comments on commit 03d4353

Please sign in to comment.
You can’t perform that action at this time.