test: add common.skipIfEslintMissing

We've added a number of tests that hook into ESLint which can error
when running the test suite with the distributed tarball. This PR
adds a new test helper `common.skipIfEslintMissing` and will skip
remaining tests in a file when `ESLint` is not available at
`tools/node_modules/eslint`

PR-URL: nodejs#18807
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Yuta Hiroto <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>

Author: MylesBorins

test/common/README.md

@@ -353,6 +353,11 @@ Path to the 'root' directory. either `/` or `c:\\` (windows)
 
 Logs '1..0 # Skipped: ' + `msg` and exits with exit code `0`.
 
+### skipIfEslintMissing()
+
+Skip the rest of the tests in the current file when `ESLint` is not available
+at `tools/node_modules/eslint`
+
 ### skipIfInspectorDisabled()
 
 Skip the rest of the tests in the current file when the Inspector

test/common/index.js

@@ -494,6 +494,14 @@ exports.fileExists = function(pathname) {
   }
 };
 
+exports.skipIfEslintMissing = function() {
+  if (!exports.fileExists(
+    path.join('..', '..', 'tools', 'node_modules', 'eslint')
+  )) {
+    exports.skip('missing ESLint');
+  }
+};
+
 exports.canCreateSymLink = function() {
   // On Windows, creating symlinks requires admin privileges.
   // We'll only try to run symlink test if we have enough privileges.

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

@@ -1,6 +1,8 @@
 'use strict';
 
-require('../common');
+const common = require('../common');
+
+common.skipIfEslintMissing();
 
 const RuleTester = require('../../tools/node_modules/eslint').RuleTester;
 const rule = require('../../tools/eslint-rules/crypto-check');

test/parallel/test-eslint-lowercase-name-for-primitive.js

@@ -1,6 +1,8 @@
 'use strict';
 
-require('../common');
+const common = require('../common');
+
+common.skipIfEslintMissing();
 
 const RuleTester = require('../../tools/node_modules/eslint').RuleTester;
 const rule = require('../../tools/eslint-rules/lowercase-name-for-primitive');

test/parallel/test-eslint-no-let-in-for-declaration.js

@@ -1,6 +1,8 @@
 'use strict';
 
-require('../common');
+const common = require('../common');
+
+common.skipIfEslintMissing();
 
 const RuleTester = require('../../tools/node_modules/eslint').RuleTester;
 const rule = require('../../tools/eslint-rules/no-let-in-for-declaration');

test/parallel/test-eslint-no-unescaped-regexp-dot.js

@@ -1,6 +1,8 @@
 'use strict';
 
-require('../common');
+const common = require('../common');
+
+common.skipIfEslintMissing();
 
 const RuleTester = require('../../tools/node_modules/eslint').RuleTester;
 const rule = require('../../tools/eslint-rules/no-unescaped-regexp-dot');

test/parallel/test-eslint-number-isnan.js

@@ -1,6 +1,8 @@
 'use strict';
 
-require('../common');
+const common = require('../common');
+
+common.skipIfEslintMissing();
 
 const RuleTester = require('../../tools/node_modules/eslint').RuleTester;
 const rule = require('../../tools/eslint-rules/number-isnan');

test/parallel/test-eslint-prefer-assert-iferror.js

@@ -1,6 +1,8 @@
 'use strict';
 
-require('../common');
+const common = require('../common');
+
+common.skipIfEslintMissing();
 
 const RuleTester = require('../../tools/node_modules/eslint').RuleTester;
 const rule = require('../../tools/eslint-rules/prefer-assert-iferror');

test/parallel/test-eslint-prefer-assert-methods.js

@@ -1,6 +1,8 @@
 'use strict';
 
-require('../common');
+const common = require('../common');
+
+common.skipIfEslintMissing();
 
 const RuleTester = require('../../tools/node_modules/eslint').RuleTester;
 const rule = require('../../tools/eslint-rules/prefer-assert-methods');

test/parallel/test-eslint-prefer-common-expectserror.js

@@ -1,6 +1,8 @@
 'use strict';
 
-require('../common');
+const common = require('../common');
+
+common.skipIfEslintMissing();
 
 const RuleTester = require('../../tools/node_modules/eslint').RuleTester;
 const rule = require('../../tools/eslint-rules/prefer-common-expectserror');

test/parallel/test-eslint-prefer-common-mustnotcall.js

@@ -1,6 +1,8 @@
 'use strict';
 
-require('../common');
+const common = require('../common');
+
+common.skipIfEslintMissing();
 
 const RuleTester = require('../../tools/node_modules/eslint').RuleTester;
 const rule = require('../../tools/eslint-rules/prefer-common-mustnotcall');

test/parallel/test-eslint-prefer-util-format-errors.js

@@ -2,7 +2,9 @@
 
 /* eslint-disable no-template-curly-in-string */
 
-require('../common');
+const common = require('../common');
+
+common.skipIfEslintMissing();
 
 const RuleTester = require('../../tools/node_modules/eslint').RuleTester;
 const rule = require('../../tools/eslint-rules/prefer-util-format-errors');

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

@@ -1,6 +1,8 @@
 'use strict';
 
-require('../common');
+const common = require('../common');
+
+common.skipIfEslintMissing();
 
 const RuleTester = require('../../tools/node_modules/eslint').RuleTester;
 const rule = require('../../tools/eslint-rules/require-buffer');

test/parallel/test-eslint-required-modules.js

@@ -1,6 +1,8 @@
 'use strict';
 
-require('../common');
+const common = require('../common');
+
+common.skipIfEslintMissing();
 
 const RuleTester = require('../../tools/node_modules/eslint').RuleTester;
 const rule = require('../../tools/eslint-rules/required-modules');