@atlaskit/eslint-plugin-platform 0.0.4 → 0.0.6

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/eslint-plugin-platform
 
+## 0.0.6
+
+### Patch Changes
+
+- [`99449cce7f5`](https://bitbucket.org/atlassian/atlassian-frontend/commits/99449cce7f5) - Eslint rules around test runner arguments and limit on nested test runners
+
+## 0.0.5
+
+### Patch Changes
+
+- [`aeb52cac34c`](https://bitbucket.org/atlassian/atlassian-frontend/commits/aeb52cac34c) - Split feature flag registration rule into two to more easily use it in products
+
 ## 0.0.4
 
 ### Patch Changes

package/dist/cjs/index.js

@@ -6,15 +6,24 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.rules = exports.configs = void 0;
 var _ensureFeatureFlagRegistration = _interopRequireDefault(require("./rules/ensure-feature-flag-registration"));
+var _ensureTestRunnerArguments = _interopRequireDefault(require("./rules/ensure-test-runner-arguments"));
+var _ensureTestRunnerNestedCount = _interopRequireDefault(require("./rules/ensure-test-runner-nested-count"));
+var _noInvalidFeatureFlagUsage = _interopRequireDefault(require("./rules/no-invalid-feature-flag-usage"));
 var rules = {
-  'ensure-feature-flag-registration': _ensureFeatureFlagRegistration.default
+  'ensure-feature-flag-registration': _ensureFeatureFlagRegistration.default,
+  'ensure-test-runner-arguments': _ensureTestRunnerArguments.default,
+  'ensure-test-runner-nested-count': _ensureTestRunnerNestedCount.default,
+  'no-invalid-feature-flag-usage': _noInvalidFeatureFlagUsage.default
 };
 exports.rules = rules;
 var configs = {
   recommended: {
     plugins: ['@atlaskit/platform'],
     rules: {
-      '@atlaskit/platform/ensure-feature-flag-registration': 'error'
+      '@atlaskit/platform/ensure-feature-flag-registration': 'error',
+      '@atlaskit/platform/ensure-test-runner-arguments': 'error',
+      '@atlaskit/platform/ensure-test-runner-nested-count': 'warn',
+      '@atlaskit/platform/no-invalid-feature-flag-usage': 'error'
     }
   }
 };

package/dist/cjs/rules/ensure-feature-flag-registration/index.js

@@ -31,34 +31,6 @@ var getPackageJsonForFileName = function getPackageJsonForFileName(filename) {
   pkgJsonCache.set(pkgJsonPath, packageJson);
   return packageJson;
 };
-var __isOnlyOneFlagCheckInExpression = function __isOnlyOneFlagCheckInExpression(root, ignoredNode) {
-  switch (root.type) {
-    case 'IfStatement':
-      return __isOnlyOneFlagCheckInExpression(root.test, ignoredNode);
-    case 'CallExpression':
-      if (root === ignoredNode) {
-        return true;
-      }
-      return !(root.callee.type === 'Identifier' && root.callee.name === 'getBooleanFF');
-
-    // shouldn't ever get here but just in case
-    case 'Identifier':
-      return root.name !== 'getBooleanFF';
-    case 'BinaryExpression':
-    case 'LogicalExpression':
-      return __isOnlyOneFlagCheckInExpression(root.left, ignoredNode) && __isOnlyOneFlagCheckInExpression(root.right, ignoredNode);
-    default:
-      return true;
-  }
-};
-var isOnlyOneFlagCheckInExpression = function isOnlyOneFlagCheckInExpression(node) {
-  var root = node.parent;
-  // find the root node of the expression
-  while (root.type === 'LogicalExpression') {
-    root = root.parent;
-  }
-  return __isOnlyOneFlagCheckInExpression(root, node);
-};
 var rule = {
   meta: {
     hasSuggestions: false,
@@ -67,11 +39,8 @@ var rule = {
     },
     type: 'problem',
     messages: {
-      onlyInlineIf: "Only call feature flags as part of an expression, don't assign to a variable! See http://go/pff-eslint for more details",
-      onlyStringLiteral: "Only get feature flags by string literal, don't use variables! See http://go/pff-eslint for more details",
       registrationSectionMissing: 'Please add a "platform-feature-flags" section to your package.json! See http://go/pff-eslint for more details',
-      featureFlagMissing: "Please add a \"{{ featureFlag }}\" section to the \"platform-feature-flags\" section in your package.json. See http://go/pff-eslint for more details",
-      multipleFlagCheckInExpression: "Only check one flag per expression! See http://go/pff-eslint for more details"
+      featureFlagMissing: "Please add a \"{{ featureFlag }}\" section to the \"platform-feature-flags\" section in your package.json. See http://go/pff-eslint for more details"
     }
   },
   create: function create(context) {
@@ -79,33 +48,7 @@ var rule = {
       'CallExpression[callee.name=/getBooleanFF/]': function CallExpressionCalleeNameGetBooleanFF(node) {
         // to make typescript happy
         if (node.type === 'CallExpression') {
-          var _node$parent;
           var args = node.arguments;
-          if (args.length === 1 && args[0].type !== 'Literal') {
-            return context.report({
-              node: node,
-              messageId: 'onlyStringLiteral'
-            });
-          }
-          switch ((_node$parent = node.parent) === null || _node$parent === void 0 ? void 0 : _node$parent.type) {
-            case 'IfStatement':
-            case 'ConditionalExpression':
-              break;
-            case 'LogicalExpression':
-              if (!isOnlyOneFlagCheckInExpression(node)) {
-                context.report({
-                  node: node,
-                  messageId: 'multipleFlagCheckInExpression'
-                });
-              }
-              break;
-            default:
-              return context.report({
-                node: node,
-                messageId: 'onlyInlineIf'
-              });
-              break;
-          }
           var filename = context.getFilename();
           var packageJson = getPackageJsonForFileName(filename);
           var platformFeatureFlags = packageJson['platform-feature-flags'];

package/dist/cjs/rules/ensure-test-runner-arguments/index.js

@@ -0,0 +1,95 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var TEST_RUNNER_IDENTIFIER = 'ffTest';
+var rule = {
+  meta: {
+    docs: {
+      recommended: false
+    },
+    type: 'problem',
+    messages: {
+      onlyInlineFeatureFlag: 'Only pass in feature flag as string literal, please replace {{identifierName}} with its value.',
+      onlyInlineTestFunction: 'Only pass in test functions/cases in an inline manner. Test functions/cases should be passed in directly, instead of as variables. Please replace {{identifierName}} with its own definition.',
+      passDownExistingFeatureFlagParam: 'Existing feature flags need to be passed down as params when calling nested test runner. See examples in the package which declares this function.',
+      passDownExistingFeatureFlagArgument: 'Existing feature flags need to be passed in as argument when calling nested test runner. See examples in the package which declares this function.',
+      passDownExistingFeatureFlagNamesMatch: 'Argument names not matching when passing down existing feature flags. See examples in the package which declares this function.'
+    }
+  },
+  create: function create(context) {
+    return (0, _defineProperty2.default)({}, "CallExpression[callee.name=/".concat(TEST_RUNNER_IDENTIFIER, "/]"), function CallExpressionCalleeName(node) {
+      if (node.type === 'CallExpression') {
+        var _node$parent, _node$parent2;
+        var args = node.arguments;
+
+        // Verify FF is passed inline
+        if (args[0] && args[0].type !== 'Literal') {
+          return context.report({
+            node: node,
+            messageId: 'onlyInlineFeatureFlag',
+            data: {
+              identifierName: args[0].type === 'Identifier' ? args[0].name : ''
+            }
+          });
+        }
+
+        // Verify test functions/cases are passed inline
+        if (args[1] && args[1].type !== 'ArrowFunctionExpression') {
+          return context.report({
+            node: node,
+            messageId: 'onlyInlineTestFunction',
+            data: {
+              identifierName: args[1].type === 'Identifier' ? args[1].name : ''
+            }
+          });
+        }
+        if (args[2] && args[2].type !== 'ArrowFunctionExpression') {
+          return context.report({
+            node: node,
+            messageId: 'onlyInlineTestFunction',
+            data: {
+              identifierName: args[2].type === 'Identifier' ? args[2].name : ''
+            }
+          });
+        }
+
+        // Verify existing ff overrides are passed down if test runner is nested
+        var upperTestRunner = (_node$parent = node.parent) === null || _node$parent === void 0 ? void 0 : _node$parent.parent;
+        if ((upperTestRunner === null || upperTestRunner === void 0 ? void 0 : upperTestRunner.type) === 'CallExpression' && (upperTestRunner === null || upperTestRunner === void 0 ? void 0 : upperTestRunner.callee.type) === 'Identifier' && (upperTestRunner === null || upperTestRunner === void 0 ? void 0 : upperTestRunner.callee.name) === TEST_RUNNER_IDENTIFIER && ((_node$parent2 = node.parent) === null || _node$parent2 === void 0 ? void 0 : _node$parent2.type) === 'ArrowFunctionExpression') {
+          // Not pass in ff to the function that calls test runner
+          if (!node.parent.params[0] || node.parent.params[0].type !== 'Identifier') {
+            return context.report({
+              node: node,
+              messageId: 'passDownExistingFeatureFlagParam'
+            });
+          }
+
+          // Not pass in ff to test runner as 4th argument
+          if (!node.arguments[3] || node.arguments[3].type !== 'Identifier') {
+            return context.report({
+              node: node,
+              messageId: 'passDownExistingFeatureFlagArgument'
+            });
+          }
+          // Pass in the above two, but names don't match
+          var paramName = node.parent.params[0].name;
+          var arguName = node.arguments[3].name;
+          if (paramName !== arguName) {
+            return context.report({
+              node: node,
+              messageId: 'passDownExistingFeatureFlagNamesMatch'
+            });
+          }
+        }
+      }
+      return {};
+    });
+  }
+};
+var _default = rule;
+exports.default = _default;

package/dist/cjs/rules/ensure-test-runner-nested-count/index.js

@@ -0,0 +1,69 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+var NESTED_LIMIT = 4;
+var TEST_RUNNER_IDENTIFIER = 'ffTest';
+var getDepthOfNestedRunner = function getDepthOfNestedRunner(node) {
+  // Calculate the depth of a binary tree, using a queue to track path
+  var queue = [];
+  queue.push(node);
+  var depth = 0;
+  while (queue.length > 0) {
+    var nodeCount = queue.length;
+    while (nodeCount > 0) {
+      var _currentNode$argument;
+      var currentNode = queue.shift();
+      if (currentNode.arguments[1].type === 'ArrowFunctionExpression' && currentNode.arguments[1].body.type === 'CallExpression' && currentNode.arguments[1].body.callee.type === 'Identifier' && currentNode.arguments[1].body.callee.name === TEST_RUNNER_IDENTIFIER) {
+        queue.push(_objectSpread(_objectSpread({}, currentNode.arguments[1].body), {}, {
+          parent: currentNode.parent
+        }));
+      }
+      if (((_currentNode$argument = currentNode.arguments[2]) === null || _currentNode$argument === void 0 ? void 0 : _currentNode$argument.type) === 'ArrowFunctionExpression' && currentNode.arguments[2].body.type === 'CallExpression' && currentNode.arguments[2].body.callee.type === 'Identifier' && currentNode.arguments[2].body.callee.name === TEST_RUNNER_IDENTIFIER) {
+        queue.push(_objectSpread(_objectSpread({}, currentNode.arguments[2].body), {}, {
+          parent: currentNode.parent
+        }));
+      }
+      nodeCount--;
+    }
+    depth++;
+  }
+  return depth;
+};
+var rule = {
+  meta: {
+    docs: {
+      recommended: false
+    },
+    type: 'problem',
+    messages: {
+      tooManyNestedTestRunner: '{{nestedTestRunner}} test runners are nested. Feature flags may need a clean-up'
+    }
+  },
+  create: function create(context) {
+    return (0, _defineProperty2.default)({}, "Program > * > CallExpression[callee.name=/".concat(TEST_RUNNER_IDENTIFIER, "/], CallExpression[callee.name=/describe/] > * > * > * > CallExpression[callee.name=/").concat(TEST_RUNNER_IDENTIFIER, "/]"), function ProgramCallExpressionCalleeNameCallExpressionCalleeNameDescribeCallExpressionCalleeName(node) {
+      if (node.type === 'CallExpression') {
+        // Calculate the depth of nested test runners, counting from the most outside
+        var depth = getDepthOfNestedRunner(node);
+        if (depth > NESTED_LIMIT) {
+          return context.report({
+            node: node,
+            messageId: 'tooManyNestedTestRunner',
+            data: {
+              nestedTestRunner: depth.toString()
+            }
+          });
+        }
+      }
+      return {};
+    });
+  }
+};
+var _default = rule;
+exports.default = _default;

package/dist/cjs/rules/no-invalid-feature-flag-usage/index.js

@@ -0,0 +1,87 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var FF_GETTER_BOOLEAN_IDENTIFIER = 'getBooleanFF';
+var __isOnlyOneFlagCheckInExpression = function __isOnlyOneFlagCheckInExpression(root, ignoredNode) {
+  switch (root.type) {
+    case 'IfStatement':
+      return __isOnlyOneFlagCheckInExpression(root.test, ignoredNode);
+    case 'CallExpression':
+      if (root === ignoredNode) {
+        return true;
+      }
+      return !(root.callee.type === 'Identifier' && root.callee.name === FF_GETTER_BOOLEAN_IDENTIFIER);
+
+    // shouldn't ever get here but just in case
+    case 'Identifier':
+      return root.name !== FF_GETTER_BOOLEAN_IDENTIFIER;
+    case 'BinaryExpression':
+    case 'LogicalExpression':
+      return __isOnlyOneFlagCheckInExpression(root.left, ignoredNode) && __isOnlyOneFlagCheckInExpression(root.right, ignoredNode);
+    default:
+      return true;
+  }
+};
+var isOnlyOneFlagCheckInExpression = function isOnlyOneFlagCheckInExpression(node) {
+  var root = node.parent;
+  // find the root node of the expression
+  while (root.type === 'LogicalExpression') {
+    root = root.parent;
+  }
+  return __isOnlyOneFlagCheckInExpression(root, node);
+};
+var rule = {
+  meta: {
+    hasSuggestions: false,
+    docs: {
+      recommended: false
+    },
+    type: 'problem',
+    messages: {
+      onlyInlineIf: "Only call feature flags as part of an expression, don't assign to a variable! See http://go/pff-eslint for more details",
+      onlyStringLiteral: "Only get feature flags by string literal, don't use variables! See http://go/pff-eslint for more details",
+      multipleFlagCheckInExpression: "Only check one flag per expression! See http://go/pff-eslint for more details"
+    }
+  },
+  create: function create(context) {
+    return (0, _defineProperty2.default)({}, "CallExpression[callee.name=/".concat(FF_GETTER_BOOLEAN_IDENTIFIER, "/]"), function CallExpressionCalleeName(node) {
+      // to make typescript happy
+      if (node.type === 'CallExpression') {
+        var _node$parent;
+        var args = node.arguments;
+        if (args.length === 1 && args[0].type !== 'Literal') {
+          return context.report({
+            node: node,
+            messageId: 'onlyStringLiteral'
+          });
+        }
+        switch ((_node$parent = node.parent) === null || _node$parent === void 0 ? void 0 : _node$parent.type) {
+          case 'IfStatement':
+          case 'ConditionalExpression':
+            break;
+          case 'LogicalExpression':
+            if (!isOnlyOneFlagCheckInExpression(node)) {
+              context.report({
+                node: node,
+                messageId: 'multipleFlagCheckInExpression'
+              });
+            }
+            break;
+          default:
+            return context.report({
+              node: node,
+              messageId: 'onlyInlineIf'
+            });
+        }
+      }
+      return {};
+    });
+  }
+};
+var _default = rule;
+exports.default = _default;

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/eslint-plugin-platform",
-	"version": "0.0.4",
+	"version": "0.0.6",
 	"sideEffects": false
 }

package/dist/es2019/index.js

@@ -1,12 +1,21 @@
 import ensureFeatureFlagRegistration from './rules/ensure-feature-flag-registration';
+import ensureTestRunnerArguments from './rules/ensure-test-runner-arguments';
+import ensureTestRunnerNestedCount from './rules/ensure-test-runner-nested-count';
+import noInvalidFeatureFlagUsage from './rules/no-invalid-feature-flag-usage';
 export const rules = {
-  'ensure-feature-flag-registration': ensureFeatureFlagRegistration
+  'ensure-feature-flag-registration': ensureFeatureFlagRegistration,
+  'ensure-test-runner-arguments': ensureTestRunnerArguments,
+  'ensure-test-runner-nested-count': ensureTestRunnerNestedCount,
+  'no-invalid-feature-flag-usage': noInvalidFeatureFlagUsage
 };
 export const configs = {
   recommended: {
     plugins: ['@atlaskit/platform'],
     rules: {
-      '@atlaskit/platform/ensure-feature-flag-registration': 'error'
+      '@atlaskit/platform/ensure-feature-flag-registration': 'error',
+      '@atlaskit/platform/ensure-test-runner-arguments': 'error',
+      '@atlaskit/platform/ensure-test-runner-nested-count': 'warn',
+      '@atlaskit/platform/no-invalid-feature-flag-usage': 'error'
     }
   }
 };

package/dist/es2019/rules/ensure-feature-flag-registration/index.js

@@ -24,34 +24,6 @@ const getPackageJsonForFileName = filename => {
   pkgJsonCache.set(pkgJsonPath, packageJson);
   return packageJson;
 };
-const __isOnlyOneFlagCheckInExpression = (root, ignoredNode) => {
-  switch (root.type) {
-    case 'IfStatement':
-      return __isOnlyOneFlagCheckInExpression(root.test, ignoredNode);
-    case 'CallExpression':
-      if (root === ignoredNode) {
-        return true;
-      }
-      return !(root.callee.type === 'Identifier' && root.callee.name === 'getBooleanFF');
-
-    // shouldn't ever get here but just in case
-    case 'Identifier':
-      return root.name !== 'getBooleanFF';
-    case 'BinaryExpression':
-    case 'LogicalExpression':
-      return __isOnlyOneFlagCheckInExpression(root.left, ignoredNode) && __isOnlyOneFlagCheckInExpression(root.right, ignoredNode);
-    default:
-      return true;
-  }
-};
-const isOnlyOneFlagCheckInExpression = node => {
-  let root = node.parent;
-  // find the root node of the expression
-  while (root.type === 'LogicalExpression') {
-    root = root.parent;
-  }
-  return __isOnlyOneFlagCheckInExpression(root, node);
-};
 const rule = {
   meta: {
     hasSuggestions: false,
@@ -60,11 +32,8 @@ const rule = {
     },
     type: 'problem',
     messages: {
-      onlyInlineIf: "Only call feature flags as part of an expression, don't assign to a variable! See http://go/pff-eslint for more details",
-      onlyStringLiteral: "Only get feature flags by string literal, don't use variables! See http://go/pff-eslint for more details",
       registrationSectionMissing: 'Please add a "platform-feature-flags" section to your package.json! See http://go/pff-eslint for more details',
-      featureFlagMissing: `Please add a "{{ featureFlag }}" section to the "platform-feature-flags" section in your package.json. See http://go/pff-eslint for more details`,
-      multipleFlagCheckInExpression: `Only check one flag per expression! See http://go/pff-eslint for more details`
+      featureFlagMissing: `Please add a "{{ featureFlag }}" section to the "platform-feature-flags" section in your package.json. See http://go/pff-eslint for more details`
     }
   },
   create(context) {
@@ -72,33 +41,7 @@ const rule = {
       'CallExpression[callee.name=/getBooleanFF/]': node => {
         // to make typescript happy
         if (node.type === 'CallExpression') {
-          var _node$parent;
           const args = node.arguments;
-          if (args.length === 1 && args[0].type !== 'Literal') {
-            return context.report({
-              node,
-              messageId: 'onlyStringLiteral'
-            });
-          }
-          switch ((_node$parent = node.parent) === null || _node$parent === void 0 ? void 0 : _node$parent.type) {
-            case 'IfStatement':
-            case 'ConditionalExpression':
-              break;
-            case 'LogicalExpression':
-              if (!isOnlyOneFlagCheckInExpression(node)) {
-                context.report({
-                  node,
-                  messageId: 'multipleFlagCheckInExpression'
-                });
-              }
-              break;
-            default:
-              return context.report({
-                node,
-                messageId: 'onlyInlineIf'
-              });
-              break;
-          }
           const filename = context.getFilename();
           const packageJson = getPackageJsonForFileName(filename);
           const platformFeatureFlags = packageJson['platform-feature-flags'];

package/dist/es2019/rules/ensure-test-runner-arguments/index.js

@@ -0,0 +1,88 @@
+const TEST_RUNNER_IDENTIFIER = 'ffTest';
+const rule = {
+  meta: {
+    docs: {
+      recommended: false
+    },
+    type: 'problem',
+    messages: {
+      onlyInlineFeatureFlag: 'Only pass in feature flag as string literal, please replace {{identifierName}} with its value.',
+      onlyInlineTestFunction: 'Only pass in test functions/cases in an inline manner. Test functions/cases should be passed in directly, instead of as variables. Please replace {{identifierName}} with its own definition.',
+      passDownExistingFeatureFlagParam: 'Existing feature flags need to be passed down as params when calling nested test runner. See examples in the package which declares this function.',
+      passDownExistingFeatureFlagArgument: 'Existing feature flags need to be passed in as argument when calling nested test runner. See examples in the package which declares this function.',
+      passDownExistingFeatureFlagNamesMatch: 'Argument names not matching when passing down existing feature flags. See examples in the package which declares this function.'
+    }
+  },
+  create(context) {
+    return {
+      [`CallExpression[callee.name=/${TEST_RUNNER_IDENTIFIER}/]`]: node => {
+        if (node.type === 'CallExpression') {
+          var _node$parent, _node$parent2;
+          const args = node.arguments;
+
+          // Verify FF is passed inline
+          if (args[0] && args[0].type !== 'Literal') {
+            return context.report({
+              node,
+              messageId: 'onlyInlineFeatureFlag',
+              data: {
+                identifierName: args[0].type === 'Identifier' ? args[0].name : ''
+              }
+            });
+          }
+
+          // Verify test functions/cases are passed inline
+          if (args[1] && args[1].type !== 'ArrowFunctionExpression') {
+            return context.report({
+              node,
+              messageId: 'onlyInlineTestFunction',
+              data: {
+                identifierName: args[1].type === 'Identifier' ? args[1].name : ''
+              }
+            });
+          }
+          if (args[2] && args[2].type !== 'ArrowFunctionExpression') {
+            return context.report({
+              node,
+              messageId: 'onlyInlineTestFunction',
+              data: {
+                identifierName: args[2].type === 'Identifier' ? args[2].name : ''
+              }
+            });
+          }
+
+          // Verify existing ff overrides are passed down if test runner is nested
+          let upperTestRunner = (_node$parent = node.parent) === null || _node$parent === void 0 ? void 0 : _node$parent.parent;
+          if ((upperTestRunner === null || upperTestRunner === void 0 ? void 0 : upperTestRunner.type) === 'CallExpression' && (upperTestRunner === null || upperTestRunner === void 0 ? void 0 : upperTestRunner.callee.type) === 'Identifier' && (upperTestRunner === null || upperTestRunner === void 0 ? void 0 : upperTestRunner.callee.name) === TEST_RUNNER_IDENTIFIER && ((_node$parent2 = node.parent) === null || _node$parent2 === void 0 ? void 0 : _node$parent2.type) === 'ArrowFunctionExpression') {
+            // Not pass in ff to the function that calls test runner
+            if (!node.parent.params[0] || node.parent.params[0].type !== 'Identifier') {
+              return context.report({
+                node,
+                messageId: 'passDownExistingFeatureFlagParam'
+              });
+            }
+
+            // Not pass in ff to test runner as 4th argument
+            if (!node.arguments[3] || node.arguments[3].type !== 'Identifier') {
+              return context.report({
+                node,
+                messageId: 'passDownExistingFeatureFlagArgument'
+              });
+            }
+            // Pass in the above two, but names don't match
+            const paramName = node.parent.params[0].name;
+            const arguName = node.arguments[3].name;
+            if (paramName !== arguName) {
+              return context.report({
+                node,
+                messageId: 'passDownExistingFeatureFlagNamesMatch'
+              });
+            }
+          }
+        }
+        return {};
+      }
+    };
+  }
+};
+export default rule;

package/dist/es2019/rules/ensure-test-runner-nested-count/index.js

@@ -0,0 +1,63 @@
+const NESTED_LIMIT = 4;
+const TEST_RUNNER_IDENTIFIER = 'ffTest';
+const getDepthOfNestedRunner = node => {
+  // Calculate the depth of a binary tree, using a queue to track path
+  let queue = [];
+  queue.push(node);
+  let depth = 0;
+  while (queue.length > 0) {
+    let nodeCount = queue.length;
+    while (nodeCount > 0) {
+      var _currentNode$argument;
+      let currentNode = queue.shift();
+      if (currentNode.arguments[1].type === 'ArrowFunctionExpression' && currentNode.arguments[1].body.type === 'CallExpression' && currentNode.arguments[1].body.callee.type === 'Identifier' && currentNode.arguments[1].body.callee.name === TEST_RUNNER_IDENTIFIER) {
+        queue.push({
+          ...currentNode.arguments[1].body,
+          parent: currentNode.parent
+        });
+      }
+      if (((_currentNode$argument = currentNode.arguments[2]) === null || _currentNode$argument === void 0 ? void 0 : _currentNode$argument.type) === 'ArrowFunctionExpression' && currentNode.arguments[2].body.type === 'CallExpression' && currentNode.arguments[2].body.callee.type === 'Identifier' && currentNode.arguments[2].body.callee.name === TEST_RUNNER_IDENTIFIER) {
+        queue.push({
+          ...currentNode.arguments[2].body,
+          parent: currentNode.parent
+        });
+      }
+      nodeCount--;
+    }
+    depth++;
+  }
+  return depth;
+};
+const rule = {
+  meta: {
+    docs: {
+      recommended: false
+    },
+    type: 'problem',
+    messages: {
+      tooManyNestedTestRunner: '{{nestedTestRunner}} test runners are nested. Feature flags may need a clean-up'
+    }
+  },
+  create(context) {
+    return {
+      // Find the most outside test runner, could be inside a describe or not
+      [`Program > * > CallExpression[callee.name=/${TEST_RUNNER_IDENTIFIER}/], CallExpression[callee.name=/describe/] > * > * > * > CallExpression[callee.name=/${TEST_RUNNER_IDENTIFIER}/]`]: node => {
+        if (node.type === 'CallExpression') {
+          // Calculate the depth of nested test runners, counting from the most outside
+          const depth = getDepthOfNestedRunner(node);
+          if (depth > NESTED_LIMIT) {
+            return context.report({
+              node,
+              messageId: 'tooManyNestedTestRunner',
+              data: {
+                nestedTestRunner: depth.toString()
+              }
+            });
+          }
+        }
+        return {};
+      }
+    };
+  }
+};
+export default rule;