[Refactor] versionUtil: expand to take a semver range

ljharb · ljharb · commit b5d24c580e3c · 2022-02-04T16:23:54.000-08:00
This would be breaking, but this util isn't part of our API.
diff --git a/lib/rules/jsx-fragments.js b/lib/rules/jsx-fragments.js
@@ -8,7 +8,7 @@
 const elementType = require('jsx-ast-utils/elementType');
 const pragmaUtil = require('../util/pragma');
 const variableUtil = require('../util/variable');
-const versionUtil = require('../util/version');
+const testReactVersion = require('../util/version').testReactVersion;
 const docsUrl = require('../util/docsUrl');
 const report = require('../util/report');
 
@@ -54,7 +54,7 @@ module.exports = {
     const closeFragLong = `</${reactPragma}.${fragmentPragma}>`;
 
     function reportOnReactVersion(node) {
-      if (!versionUtil.testReactVersion(context, '16.2.0')) {
+      if (!testReactVersion(context, '>= 16.2.0')) {
         report(context, messages.fragmentsNotSupported, 'fragmentsNotSupported', {
           node,
         });
diff --git a/lib/rules/no-deprecated.js b/lib/rules/no-deprecated.js
@@ -13,7 +13,7 @@ const Components = require('../util/Components');
 const astUtil = require('../util/ast');
 const docsUrl = require('../util/docsUrl');
 const pragmaUtil = require('../util/pragma');
-const versionUtil = require('../util/version');
+const testReactVersion = require('../util/version').testReactVersion;
 const report = require('../util/report');
 
 // ------------------------------------------------------------------------------
@@ -114,7 +114,7 @@ module.exports = {
         deprecated
         && deprecated[method]
         && deprecated[method][0]
-        && versionUtil.testReactVersion(context, deprecated[method][0])
+        && testReactVersion(context, `>= ${deprecated[method][0]}`)
       );
     }
 
diff --git a/lib/rules/no-render-return-value.js b/lib/rules/no-render-return-value.js
@@ -5,7 +5,7 @@
 
 'use strict';
 
-const versionUtil = require('../util/version');
+const testReactVersion = require('../util/version').testReactVersion;
 const docsUrl = require('../util/docsUrl');
 const report = require('../util/report');
 
@@ -37,16 +37,15 @@ module.exports = {
     // --------------------------------------------------------------------------
 
     let calleeObjectName = /^ReactDOM$/;
-    if (versionUtil.testReactVersion(context, '15.0.0')) {
+    if (testReactVersion(context, '>= 15.0.0')) {
       calleeObjectName = /^ReactDOM$/;
-    } else if (versionUtil.testReactVersion(context, '0.14.0')) {
+    } else if (testReactVersion(context, '^0.14.0')) {
       calleeObjectName = /^React(DOM)?$/;
-    } else if (versionUtil.testReactVersion(context, '0.13.0')) {
+    } else if (testReactVersion(context, '^0.13.0')) {
       calleeObjectName = /^React$/;
     }
 
     return {
-
       CallExpression(node) {
         const callee = node.callee;
         const parent = node.parent;
diff --git a/lib/rules/no-unknown-property.js b/lib/rules/no-unknown-property.js
@@ -7,7 +7,7 @@
 
 const has = require('object.hasown/polyfill')();
 const docsUrl = require('../util/docsUrl');
-const versionUtil = require('../util/version');
+const testReactVersion = require('../util/version').testReactVersion;
 const report = require('../util/report');
 
 // ------------------------------------------------------------------------------
@@ -135,7 +135,7 @@ const DOM_PROPERTY_NAMES = [
 ];
 function getDOMPropertyNames(context) {
   // this was removed in React v16.1+, see https://github.com/facebook/react/pull/10823
-  if (!versionUtil.testReactVersion(context, '16.1.0')) {
+  if (!testReactVersion(context, '>= 16.1.0')) {
     return ['allowTransparency'].concat(DOM_PROPERTY_NAMES);
   }
   return DOM_PROPERTY_NAMES;
diff --git a/lib/rules/no-unsafe.js b/lib/rules/no-unsafe.js
@@ -8,7 +8,7 @@
 const Components = require('../util/Components');
 const astUtil = require('../util/ast');
 const docsUrl = require('../util/docsUrl');
-const versionUtil = require('../util/version');
+const testReactVersion = require('../util/version').testReactVersion;
 const report = require('../util/report');
 
 // ------------------------------------------------------------------------------
@@ -48,7 +48,7 @@ module.exports = {
     const config = context.options[0] || {};
     const checkAliases = config.checkAliases || false;
 
-    const isApplicable = versionUtil.testReactVersion(context, '16.3.0');
+    const isApplicable = testReactVersion(context, '>= 16.3.0');
     if (!isApplicable) {
       return {};
     }
diff --git a/lib/rules/no-will-update-set-state.js b/lib/rules/no-will-update-set-state.js
@@ -6,9 +6,9 @@
 'use strict';
 
 const makeNoMethodSetStateRule = require('../util/makeNoMethodSetStateRule');
-const versionUtil = require('../util/version');
+const testReactVersion = require('../util/version').testReactVersion;
 
 module.exports = makeNoMethodSetStateRule(
   'componentWillUpdate',
-  (context) => versionUtil.testReactVersion(context, '16.3.0')
+  (context) => testReactVersion(context, '>= 16.3.0')
 );
diff --git a/lib/rules/prefer-stateless-function.js b/lib/rules/prefer-stateless-function.js
@@ -8,7 +8,7 @@
 'use strict';
 
 const Components = require('../util/Components');
-const versionUtil = require('../util/version');
+const testReactVersion = require('../util/version').testReactVersion;
 const astUtil = require('../util/ast');
 const docsUrl = require('../util/docsUrl');
 const report = require('../util/report');
@@ -347,7 +347,7 @@ module.exports = {
           scope = scope.upper;
         }
         const isRender = blockNode && blockNode.key && blockNode.key.name === 'render';
-        const allowNull = versionUtil.testReactVersion(context, '15.0.0'); // Stateless components can return null since React 15
+        const allowNull = testReactVersion(context, '>= 15.0.0'); // Stateless components can return null since React 15
         const isReturningJSX = utils.isReturningJSX(node, !allowNull);
         const isReturningNull = node.argument && (node.argument.value === null || node.argument.value === false);
         if (
diff --git a/lib/util/makeNoMethodSetStateRule.js b/lib/util/makeNoMethodSetStateRule.js
@@ -66,7 +66,6 @@ function makeNoMethodSetStateRule(methodName, shouldCheckUnsafeCb) {
       // --------------------------------------------------------------------------
 
       return {
-
         CallExpression(node) {
           const callee = node.callee;
           if (
diff --git a/lib/util/propTypes.js b/lib/util/propTypes.js
@@ -9,7 +9,7 @@ const flatMap = require('array.prototype.flatmap');
 const annotations = require('./annotations');
 const propsUtil = require('./props');
 const variableUtil = require('./variable');
-const versionUtil = require('./version');
+const testFlowVersion = require('./version').testFlowVersion;
 const propWrapperUtil = require('./propWrapper');
 const astUtil = require('./ast');
 const isFirstLetterCapitalized = require('./isFirstLetterCapitalized');
@@ -1080,7 +1080,7 @@ module.exports = function propTypesInstructions(context, components, utils) {
     try {
       // Flow <=0.52 had 3 required TypedParameters of which the second one is the Props.
       // Flow >=0.53 has 2 optional TypedParameters of which the first one is the Props.
-      propsParameterPosition = versionUtil.testFlowVersion(context, '0.53.0') ? 0 : 1;
+      propsParameterPosition = testFlowVersion(context, '>= 0.53.0') ? 0 : 1;
     } catch (e) {
       // In case there is no flow version defined, we can safely assume that when there are 3 Props we are dealing with version <= 0.52
       propsParameterPosition = node.superTypeParameters.params.length <= 2 ? 0 : 1;
diff --git a/lib/util/usedPropTypes.js b/lib/util/usedPropTypes.js
@@ -5,7 +5,7 @@
 'use strict';
 
 const astUtil = require('./ast');
-const versionUtil = require('./version');
+const testReactVersion = require('./version').testReactVersion;
 const ast = require('./ast');
 
 // ------------------------------------------------------------------------------
@@ -282,7 +282,7 @@ function getPropertyName(node, context, utils, checkAsyncSafeLifeCycles) {
 }
 
 module.exports = function usedPropTypesInstructions(context, components, utils) {
-  const checkAsyncSafeLifeCycles = versionUtil.testReactVersion(context, '16.3.0');
+  const checkAsyncSafeLifeCycles = testReactVersion(context, '>= 16.3.0');
 
   const propVariables = createPropVariables();
   const pushScope = propVariables.pushScope;
diff --git a/lib/util/version.js b/lib/util/version.js
@@ -8,6 +8,7 @@
 const fs = require('fs');
 const resolve = require('resolve');
 const path = require('path');
+const semver = require('semver');
 const error = require('./error');
 
 let warnedForMissingVersion = false;
@@ -88,7 +89,7 @@ function getReactVersionFromContext(context) {
     warnedForMissingVersion = true;
   }
   confVer = /^[0-9]+\.[0-9]+$/.test(confVer) ? `${confVer}.0` : confVer;
-  return confVer.split('.').map((part) => Number(part));
+  return semver.coerce(confVer.split('.').map((part) => Number(part)).join('.')).version;
 }
 
 // TODO, semver-major: remove context fallback
@@ -126,31 +127,19 @@ function getFlowVersionFromContext(context) {
     throw 'Could not retrieve flowVersion from settings'; // eslint-disable-line no-throw-literal
   }
   confVer = /^[0-9]+\.[0-9]+$/.test(confVer) ? `${confVer}.0` : confVer;
-  return confVer.split('.').map((part) => Number(part));
+  return semver.coerce(confVer.split('.').map((part) => Number(part)).join('.')).version;
 }
 
-function normalizeParts(parts) {
-  return Array.from({ length: 3 }, (_, i) => (parts[i] || 0));
+function test(semverRange, confVer) {
+  return semver.satisfies(confVer, semverRange);
 }
 
-function test(context, methodVer, confVer) {
-  const methodVers = normalizeParts(String(methodVer || '').split('.').map((part) => Number(part)));
-  const confVers = normalizeParts(confVer);
-  const higherMajor = methodVers[0] < confVers[0];
-  const higherMinor = methodVers[0] === confVers[0] && methodVers[1] < confVers[1];
-  const higherOrEqualPatch = methodVers[0] === confVers[0]
-    && methodVers[1] === confVers[1]
-    && methodVers[2] <= confVers[2];
-
-  return higherMajor || higherMinor || higherOrEqualPatch;
-}
-
-function testReactVersion(context, methodVer) {
-  return test(context, methodVer, getReactVersionFromContext(context));
+function testReactVersion(context, semverRange) {
+  return test(semverRange, getReactVersionFromContext(context));
 }
 
-function testFlowVersion(context, methodVer) {
-  return test(context, methodVer, getFlowVersionFromContext(context));
+function testFlowVersion(context, semverRange) {
+  return test(semverRange, getFlowVersionFromContext(context));
 }
 
 module.exports = {
diff --git a/tests/util/version.js b/tests/util/version.js
@@ -34,25 +34,25 @@ describe('Version', () => {
     it('matches detected version', () => {
       sinon.stub(context, 'getFilename').callsFake(() => path.resolve(base, 'detect-version', 'test.js'));
 
-      assert.equal(versionUtil.testReactVersion(context, '1.2.3'), true);
-      assert.equal(versionUtil.testReactVersion(context, '1.2.4'), false);
-      assert.equal(versionUtil.testFlowVersion(context, '0.92.0'), true);
+      assert.equal(versionUtil.testReactVersion(context, '>= 1.2.3'), true);
+      assert.equal(versionUtil.testReactVersion(context, '>= 1.2.4'), false);
+      assert.equal(versionUtil.testFlowVersion(context, '>= 0.92.0'), true);
     });
 
     it('matches detected version in sibling project', () => {
       sinon.stub(context, 'getFilename').callsFake(() => path.resolve(base, 'detect-version-sibling', 'test.js'));
 
-      assert.equal(versionUtil.testReactVersion(context, '2.3.4'), true);
-      assert.equal(versionUtil.testReactVersion(context, '2.3.5'), false);
-      assert.equal(versionUtil.testFlowVersion(context, '2.92.0'), true);
+      assert.equal(versionUtil.testReactVersion(context, '>= 2.3.4'), true);
+      assert.equal(versionUtil.testReactVersion(context, '>= 2.3.5'), false);
+      assert.equal(versionUtil.testFlowVersion(context, '>= 2.92.0'), true);
     });
 
     it('matches detected version in child project', () => {
       sinon.stub(context, 'getFilename').callsFake(() => path.resolve(base, 'detect-version', 'detect-version-child', 'test.js'));
 
-      assert.equal(versionUtil.testReactVersion(context, '3.4.5'), true);
-      assert.equal(versionUtil.testReactVersion(context, '3.4.6'), false);
-      assert.equal(versionUtil.testFlowVersion(context, '3.92.0'), true);
+      assert.equal(versionUtil.testReactVersion(context, '>= 3.4.5'), true);
+      assert.equal(versionUtil.testReactVersion(context, '>= 3.4.6'), false);
+      assert.equal(versionUtil.testFlowVersion(context, '>= 3.92.0'), true);
     });
 
     it('assumes latest version if react is not installed', () => {
@@ -87,43 +87,43 @@ describe('Version', () => {
     it('works with virtual filename', () => {
       sinon.stub(context, 'getFilename').callsFake(() => path.resolve(base, 'detect-version-sibling', 'test.js/0_fake.js'));
 
-      assert.equal(versionUtil.testReactVersion(context, '2.3.4'), true);
-      assert.equal(versionUtil.testReactVersion(context, '2.3.5'), false);
-      assert.equal(versionUtil.testFlowVersion(context, '2.92.0'), true);
+      assert.equal(versionUtil.testReactVersion(context, '>= 2.3.4'), true);
+      assert.equal(versionUtil.testReactVersion(context, '>= 2.3.5'), false);
+      assert.equal(versionUtil.testFlowVersion(context, '>= 2.92.0'), true);
     });
 
     it('works with recursive virtual filename', () => {
       sinon.stub(context, 'getFilename').callsFake(() => path.resolve(base, 'detect-version-sibling', 'test.js/0_fake.md/1_fake.js'));
 
-      assert.equal(versionUtil.testReactVersion(context, '2.3.4'), true);
-      assert.equal(versionUtil.testReactVersion(context, '2.3.5'), false);
-      assert.equal(versionUtil.testFlowVersion(context, '2.92.0'), true);
+      assert.equal(versionUtil.testReactVersion(context, '>= 2.3.4'), true);
+      assert.equal(versionUtil.testReactVersion(context, '>= 2.3.5'), false);
+      assert.equal(versionUtil.testFlowVersion(context, '>= 2.92.0'), true);
     });
   });
 
   describe('string version', () => {
     const context = { settings: { react: { version: '15.0', flowVersion: '1.2' } } };
 
     it('works with react', () => {
-      assert.equal(versionUtil.testReactVersion(context, '0.14.0'), true);
-      assert.equal(versionUtil.testReactVersion(context, '15.0.0'), true);
-      assert.equal(versionUtil.testReactVersion(context, '16.0.0'), false);
+      assert.equal(versionUtil.testReactVersion(context, '>= 0.14.0'), true);
+      assert.equal(versionUtil.testReactVersion(context, '>= 15.0.0'), true);
+      assert.equal(versionUtil.testReactVersion(context, '>= 16.0.0'), false);
     });
 
     it('works with flow', () => {
-      assert.equal(versionUtil.testFlowVersion(context, '1.1.0'), true);
-      assert.equal(versionUtil.testFlowVersion(context, '1.2.0'), true);
-      assert.equal(versionUtil.testFlowVersion(context, '1.3.0'), false);
+      assert.equal(versionUtil.testFlowVersion(context, '>= 1.1.0'), true);
+      assert.equal(versionUtil.testFlowVersion(context, '>= 1.2.0'), true);
+      assert.equal(versionUtil.testFlowVersion(context, '>= 1.3.0'), false);
     });
   });
 
   describe('non-string version', () => {
     const context = { settings: { react: { version: 15.0, flowVersion: 1.2 } } };
 
     it('works with react', () => {
-      assert.equal(versionUtil.testReactVersion(context, '0.14.0'), true);
-      assert.equal(versionUtil.testReactVersion(context, '15.0.0'), true);
-      assert.equal(versionUtil.testReactVersion(context, '16.0.0'), false);
+      assert.equal(versionUtil.testReactVersion(context, '>= 0.14.0'), true, '>= 0.14.0');
+      assert.equal(versionUtil.testReactVersion(context, '>= 15.0.0'), true, '>= 15.0.0');
+      assert.equal(versionUtil.testReactVersion(context, '>= 16.0.0'), false, '>= 16.0.0');
 
       expectedErrorArgs = [
         ['Warning: React version specified in eslint-plugin-react-settings must be a string; got “number”'],
@@ -133,9 +133,9 @@ describe('Version', () => {
     });
 
     it('works with flow', () => {
-      assert.equal(versionUtil.testFlowVersion(context, '1.1.0'), true);
-      assert.equal(versionUtil.testFlowVersion(context, '1.2.0'), true);
-      assert.equal(versionUtil.testFlowVersion(context, '1.3.0'), false);
+      assert.equal(versionUtil.testFlowVersion(context, '>= 1.1.0'), true);
+      assert.equal(versionUtil.testFlowVersion(context, '>= 1.2.0'), true);
+      assert.equal(versionUtil.testFlowVersion(context, '>= 1.3.0'), false);
 
       expectedErrorArgs = [
         ['Warning: Flow version specified in eslint-plugin-react-settings must be a string; got “number”'],
