@atlaskit/eslint-plugin-platform 0.0.5 → 0.0.6

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @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

package/dist/cjs/index.js

@@ -6,9 +6,13 @@ 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-test-runner-arguments': _ensureTestRunnerArguments.default,
+  'ensure-test-runner-nested-count': _ensureTestRunnerNestedCount.default,
   'no-invalid-feature-flag-usage': _noInvalidFeatureFlagUsage.default
 };
 exports.rules = rules;
@@ -17,6 +21,8 @@ var configs = {
     plugins: ['@atlaskit/platform'],
     rules: {
       '@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-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/version.json

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

package/dist/es2019/index.js

@@ -1,7 +1,11 @@
 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-test-runner-arguments': ensureTestRunnerArguments,
+  'ensure-test-runner-nested-count': ensureTestRunnerNestedCount,
   'no-invalid-feature-flag-usage': noInvalidFeatureFlagUsage
 };
 export const configs = {
@@ -9,6 +13,8 @@ export const configs = {
     plugins: ['@atlaskit/platform'],
     rules: {
       '@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-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;

package/dist/es2019/version.json

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

package/dist/esm/index.js

@@ -1,7 +1,11 @@
 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 var rules = {
   'ensure-feature-flag-registration': ensureFeatureFlagRegistration,
+  'ensure-test-runner-arguments': ensureTestRunnerArguments,
+  'ensure-test-runner-nested-count': ensureTestRunnerNestedCount,
   'no-invalid-feature-flag-usage': noInvalidFeatureFlagUsage
 };
 export var configs = {
@@ -9,6 +13,8 @@ export var configs = {
     plugins: ['@atlaskit/platform'],
     rules: {
       '@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/esm/rules/ensure-test-runner-arguments/index.js

@@ -0,0 +1,87 @@
+import _defineProperty from "@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 _defineProperty({}, "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 {};
+    });
+  }
+};
+export default rule;

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

@@ -0,0 +1,61 @@
+import _defineProperty from "@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) { _defineProperty(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 _defineProperty({}, "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 {};
+    });
+  }
+};
+export default rule;

package/dist/esm/version.json

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

package/dist/types/index.d.ts

@@ -1,5 +1,7 @@
 export declare const rules: {
     'ensure-feature-flag-registration': import("eslint").Rule.RuleModule;
+    'ensure-test-runner-arguments': import("eslint").Rule.RuleModule;
+    'ensure-test-runner-nested-count': import("eslint").Rule.RuleModule;
     'no-invalid-feature-flag-usage': import("eslint").Rule.RuleModule;
 };
 export declare const configs: {
@@ -7,6 +9,8 @@ export declare const configs: {
         plugins: string[];
         rules: {
             '@atlaskit/platform/ensure-feature-flag-registration': string;
+            '@atlaskit/platform/ensure-test-runner-arguments': string;
+            '@atlaskit/platform/ensure-test-runner-nested-count': string;
             '@atlaskit/platform/no-invalid-feature-flag-usage': string;
         };
     };

package/dist/types/rules/ensure-test-runner-arguments/index.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export default rule;

package/dist/types/rules/ensure-test-runner-nested-count/index.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export default rule;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@atlaskit/eslint-plugin-platform",
   "description": "The essential plugin for use with Atlassian frontend platform tools",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "author": "Atlassian Pty Ltd",
   "atlassian": {
     "team": "UIP - Platform Integration Trust (PITa)",

package/report.api.md

@@ -23,6 +23,8 @@ export const configs: {
     plugins: string[];
     rules: {
       '@atlaskit/platform/ensure-feature-flag-registration': string;
+      '@atlaskit/platform/ensure-test-runner-arguments': string;
+      '@atlaskit/platform/ensure-test-runner-nested-count': string;
       '@atlaskit/platform/no-invalid-feature-flag-usage': string;
     };
   };
@@ -31,6 +33,8 @@ export const configs: {
 // @public (undocumented)
 export const rules: {
   'ensure-feature-flag-registration': Rule.RuleModule;
+  'ensure-test-runner-arguments': Rule.RuleModule;
+  'ensure-test-runner-nested-count': Rule.RuleModule;
   'no-invalid-feature-flag-usage': Rule.RuleModule;
 };
 

package/src/index.tsx

@@ -1,8 +1,12 @@
 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-test-runner-arguments': ensureTestRunnerArguments,
+  'ensure-test-runner-nested-count': ensureTestRunnerNestedCount,
   'no-invalid-feature-flag-usage': noInvalidFeatureFlagUsage,
 };
 
@@ -11,6 +15,8 @@ export const configs = {
     plugins: ['@atlaskit/platform'],
     rules: {
       '@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',
     },
   },