tools: add eslint check for skipIfEslintMissing

Add a custom eslint rule to check for `common.skipIfEslintMissing()` to
allow tests to run from source tarballs that do not include eslint.
Fix up rule tests that were failing the new check.
Refs: #20336
PR-URL: #20372
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

Author: richardlau

test/.eslintrc.yaml

@@ -13,6 +13,7 @@ rules:
 node-core/prefer-common-expectserror: error
 node-core/prefer-common-mustnotcall: error
 node-core/crypto-check: error
+node-core/eslint-check: error
 node-core/inspector-check: error
 node-core/number-isnan: error
 ## common module is mandatory in tests

test/common/index.js

@@ -494,7 +494,7 @@ exports.fileExists = function(pathname) {
 
 exports.skipIfEslintMissing=function(){
 if(!exports.fileExists(
-path.join('..','..','tools','node_modules','eslint')
+path.join(__dirname,'..','..','tools','node_modules','eslint')
 )){
 exports.skip('missing ESLint');
 }

test/parallel/test-eslint-alphabetize-errors.js

@@ -1,6 +1,7 @@
 'use strict';
 
-require('../common');
+constcommon=require('../common');
+common.skipIfEslintMissing();
 
 constRuleTester=require('../../tools/node_modules/eslint').RuleTester;
 construle=require('../../tools/eslint-rules/alphabetize-errors');

test/parallel/test-eslint-buffer-constructor.js

@@ -1,6 +1,7 @@
 'use strict';
 
-require('../common');
+constcommon=require('../common');
+common.skipIfEslintMissing();
 
 constRuleTester=require('../../tools/node_modules/eslint').RuleTester;
 construle=require('../../tools/eslint-rules/buffer-constructor');

test/parallel/test-eslint-documented-errors.js

@@ -1,6 +1,7 @@
 'use strict';
 
-require('../common');
+constcommon=require('../common');
+common.skipIfEslintMissing();
 
 constRuleTester=require('../../tools/node_modules/eslint').RuleTester;
 construle=require('../../tools/eslint-rules/documented-errors');

test/parallel/test-eslint-eslint-check.js

@@ -0,0 +1,31 @@
+'use strict';
+
+constcommon=require('../common');
+
+common.skipIfEslintMissing();
+
+constRuleTester=require('../../tools/node_modules/eslint').RuleTester;
+construle=require('../../tools/eslint-rules/eslint-check');
+
+constmessage='Please add a skipIfEslintMissing() call to allow this '+
+'test to be skipped when Node.js is built '+
+'from a source tarball.';
+
+newRuleTester().run('eslint-check',rule,{
+valid: [
+'foo;',
+'require("common")\n'+
+'common.skipIfEslintMissing();\n'+
+'require("../../tools/node_modules/eslint")'
+],
+invalid: [
+{
+code: 'require("common")\n'+
+'require("../../tools/node_modules/eslint").RuleTester',
+errors: [{ message }],
+output: 'require("common")\n'+
+'common.skipIfEslintMissing();\n'+
+'require("../../tools/node_modules/eslint").RuleTester'
+}
+]
+});

test/parallel/test-eslint-inspector-check.js

@@ -1,12 +1,13 @@
 'use strict';
 
-require('../common');
+constcommon=require('../common');
+common.skipIfEslintMissing();
 
 constRuleTester=require('../../tools/node_modules/eslint').RuleTester;
 construle=require('../../tools/eslint-rules/inspector-check');
 
 constmessage='Please add a skipIfInspectorDisabled() call to allow this '+
-'test to be skippped when Node is built '+
+'test to be skipped when Node is built '+
 '\'--without-inspector\'.';
 
 newRuleTester().run('inspector-check',rule,{

test/parallel/test-eslint-require-buffer.js

@@ -11,7 +11,7 @@ const ruleTester = new RuleTester({
 env: {node: true}
 });
 
-constmessage="Use const Buffer = require('buffer').Buffer; "+
+constmessage="Use const { Buffer } = require('buffer'); "+
 'at the beginning of this file';
 
 constuseStrict='\'use strict\';\n\n';

tools/eslint-rules/eslint-check.js

@@ -0,0 +1,60 @@
+/**
+ * @fileoverview Check that common.skipIfEslintMissing is used if
+ * the eslint module is required.
+ */
+'use strict';
+
+constutils=require('./rules-utils.js');
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+constmsg='Please add a skipIfEslintMissing() call to allow this test to '+
+'be skipped when Node.js is built from a source tarball.';
+
+module.exports=function(context){
+constmissingCheckNodes=[];
+varcommonModuleNode=null;
+varhasEslintCheck=false;
+
+functiontestEslintUsage(context,node){
+if(utils.isRequired(node,['../../tools/node_modules/eslint'])){
+missingCheckNodes.push(node);
+}
+
+if(utils.isCommonModule(node)){
+commonModuleNode=node;
+}
+}
+
+functioncheckMemberExpression(context,node){
+if(utils.usesCommonProperty(node,['skipIfEslintMissing'])){
+hasEslintCheck=true;
+}
+}
+
+functionreportIfMissing(context){
+if(!hasEslintCheck){
+missingCheckNodes.forEach((node)=>{
+context.report({
+ node,
+message: msg,
+fix: (fixer)=>{
+if(commonModuleNode){
+returnfixer.insertTextAfter(
+commonModuleNode,
+'\ncommon.skipIfEslintMissing();'
+);
+}
+}
+});
+});
+}
+}
+
+return{
+'CallExpression': (node)=>testEslintUsage(context,node),
+'MemberExpression': (node)=>checkMemberExpression(context,node),
+'Program:exit': (node)=>reportIfMissing(context,node)
+};
+};

tools/eslint-rules/inspector-check.js

@@ -11,7 +11,7 @@ const utils = require('./rules-utils.js');
 // Rule Definition
 //------------------------------------------------------------------------------
 constmsg='Please add a skipIfInspectorDisabled() call to allow this '+
-'test to be skippped when Node is built \'--without-inspector\'.';
+'test to be skipped when Node is built \'--without-inspector\'.';
 
 module.exports=function(context){
 constmissingCheckNodes=[];