@atlaskit/eslint-plugin-design-system 8.25.2 → 8.27.0

package/dist/esm/rules/no-invalid-css-map/index.js

@@ -0,0 +1,96 @@
+import { checkIfSupportedExport } from '../utils/create-no-exported-rule/check-if-supported-export';
+import { createLintRule } from '../utils/create-rule';
+import { CSS_IN_JS_IMPORTS, isCssMap } from '../utils/is-supported-import';
+import { CssMapObjectChecker, getCssMapObject } from './utils';
+var IMPORT_SOURCES = [CSS_IN_JS_IMPORTS.compiled, CSS_IN_JS_IMPORTS.atlaskitCss];
+var reportIfExported = function reportIfExported(node, context) {
+  var state = checkIfSupportedExport(context, node, IMPORT_SOURCES);
+  if (!state.isExport) {
+    return;
+  }
+  context.report({
+    messageId: 'noExportedCssMap',
+    node: state.node
+  });
+};
+var reportIfNotTopLevelScope = function reportIfNotTopLevelScope(node, context) {
+  // Treat `export` keyword as valid because the reportIfExported function already handles those
+  var validTypes = ['ExportDefaultDeclaration', 'ExportNamedDeclaration', 'Program', 'VariableDeclaration', 'VariableDeclarator'];
+  var parentNode = node.parent;
+  while (parentNode) {
+    if (!validTypes.includes(parentNode.type)) {
+      context.report({
+        node: node,
+        messageId: 'mustBeTopLevelScope'
+      });
+      return;
+    }
+    parentNode = parentNode.parent;
+  }
+};
+var createCssMapRule = function createCssMapRule(context) {
+  var _context$getSourceCod = context.getSourceCode(),
+    text = _context$getSourceCod.text;
+  if (IMPORT_SOURCES.every(function (importSource) {
+    return !text.includes(importSource);
+  })) {
+    return {};
+  }
+  return {
+    CallExpression: function CallExpression(node) {
+      var references = context.getScope().references;
+      if (!isCssMap(node.callee, references, IMPORT_SOURCES)) {
+        return;
+      }
+      reportIfExported(node, context);
+      reportIfNotTopLevelScope(node, context);
+      var cssMapObject = getCssMapObject(node);
+      if (!cssMapObject) {
+        return;
+      }
+      var cssMapObjectChecker = new CssMapObjectChecker(cssMapObject, context);
+      cssMapObjectChecker.run();
+    }
+  };
+};
+var noInvalidCssMapRule = createLintRule({
+  meta: {
+    name: 'no-invalid-css-map',
+    docs: {
+      description: "Checks the validity of a CSS map created through cssMap. This is intended to be used alongside TypeScript's type-checking.",
+      recommended: true,
+      severity: 'error'
+    },
+    messages: {
+      mustBeTopLevelScope: 'cssMap must only be used in the top-most scope of the module.',
+      noNonStaticallyEvaluable: 'Cannot statically evaluate the value of this variable. Values used in the cssMap function call should have a value evaluable at build time.',
+      noExportedCssMap: 'cssMap usages cannot be exported.',
+      noInlineFunctions: 'Cannot use functions as values in cssMap - values must only be statically evaluable values (e.g. strings, numbers).',
+      noFunctionCalls: 'Cannot call external functions in cssMap - values must only be statically evaluable values (e.g. strings, numbers).',
+      noSpreadElement: 'Cannot use the spread operator in cssMap.'
+    },
+    schema: [{
+      type: 'object',
+      properties: {
+        allowedFunctionCalls: {
+          type: 'array',
+          items: {
+            type: 'array',
+            minItems: 2,
+            maxItems: 2,
+            items: [{
+              type: 'string'
+            }, {
+              type: 'string'
+            }]
+          },
+          uniqueItems: true
+        }
+      },
+      additionalProperties: false
+    }],
+    type: 'problem'
+  },
+  create: createCssMapRule
+});
+export default noInvalidCssMapRule;

package/dist/esm/rules/no-invalid-css-map/utils.js

@@ -0,0 +1,186 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _createClass from "@babel/runtime/helpers/createClass";
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+export var getCssMapObject = function getCssMapObject(node) {
+  // We assume the argument `node` is already a cssMap() call.
+
+  // Things like the number of arguments to cssMap and the type of
+  // cssMap's argument are handled by the TypeScript compiler, so
+  // we don't bother with creating eslint errors for these here
+
+  if (node.arguments.length !== 1 || node.arguments[0].type !== 'ObjectExpression') {
+    return;
+  }
+  return node.arguments[0];
+};
+var findNodeReference = function findNodeReference(references, node) {
+  return references.find(function (reference) {
+    return reference.identifier === node;
+  });
+};
+var getAllowedFunctionCalls = function getAllowedFunctionCalls(options) {
+  var _options$;
+  if (options.length === 0 || ((_options$ = options[0]) === null || _options$ === void 0 ? void 0 : _options$.allowedFunctionCalls) === undefined) {
+    return [];
+  }
+
+  // Beyond the basic check of "does allowedFunctionCalls exist?",
+  // we assume ESLint's rule checker type checks the contents of allowedFunctionCalls
+  // as it should
+  return options[0].allowedFunctionCalls;
+};
+export var CssMapObjectChecker = /*#__PURE__*/function () {
+  function CssMapObjectChecker(cssMapObject, context) {
+    _classCallCheck(this, CssMapObjectChecker);
+    this.allowedFunctionCalls = getAllowedFunctionCalls(context.options);
+    this.cssMapObject = cssMapObject;
+    this.report = context.report;
+    this.references = context.getScope().references;
+  }
+  _createClass(CssMapObjectChecker, [{
+    key: "isNotWhitelistedFunction",
+    value: function isNotWhitelistedFunction(callee) {
+      var _reference$resolved,
+        _this = this;
+      if (callee.type !== 'Identifier' || this.allowedFunctionCalls.length === 0) {
+        return true;
+      }
+      var reference = findNodeReference(this.references, callee);
+      var definitions = reference === null || reference === void 0 || (_reference$resolved = reference.resolved) === null || _reference$resolved === void 0 ? void 0 : _reference$resolved.defs;
+      if (!definitions) {
+        return true;
+      }
+      return definitions.some(function (definition) {
+        // We add some restrictions to keep this simple...
+        // Forbid non-imported functions
+        if (definition.type !== 'ImportBinding') {
+          return true;
+        }
+        // Forbid default imports (e.g. `import React from 'react'`)
+        if (definition.node.type !== 'ImportSpecifier') {
+          return true;
+        }
+        var packageName = definition.parent.source.value;
+        var importedFunctionName = definition.node.imported.name;
+        return !_this.allowedFunctionCalls.some(function (_ref) {
+          var _ref2 = _slicedToArray(_ref, 2),
+            allowedPackageName = _ref2[0],
+            allowedFunctionName = _ref2[1];
+          return allowedPackageName === packageName && allowedFunctionName === importedFunctionName;
+        });
+      });
+    }
+  }, {
+    key: "checkCssMapObjectValue",
+    value: function checkCssMapObjectValue(value) {
+      if (value.type === 'CallExpression' && this.isNotWhitelistedFunction(value.callee)) {
+        // object value is a function call in the style
+        // {
+        //     key: functionCall(), ...
+        // }
+        this.report({
+          node: value,
+          messageId: 'noFunctionCalls'
+        });
+      } else if (value.type === 'ArrowFunctionExpression' || value.type === 'FunctionExpression') {
+        // object value is a function call in the style
+        // {
+        //     key: (prop) => prop.color,       // ArrowFunctionExpression
+        //     get danger() { return { ... } }, // FunctionExpression
+        // }
+        this.report({
+          node: value,
+          messageId: 'noInlineFunctions'
+        });
+      } else if (value.type === 'BinaryExpression' || value.type === 'LogicalExpression') {
+        this.checkCssMapObjectValue(value.left);
+        this.checkCssMapObjectValue(value.right);
+      } else if (value.type === 'Identifier') {
+        var _reference$resolved2;
+        var reference = findNodeReference(this.references, value);
+
+        // Get the variable's definition when initialised. Assume that the last definition
+        // is the most recent one.
+        //
+        // Ideally we would try to get the variable's value at the point at which
+        // cssMap() is run, but ESLint doesn't seem to give us an easy way to
+        // do that...
+        var definitions = reference === null || reference === void 0 || (_reference$resolved2 = reference.resolved) === null || _reference$resolved2 === void 0 ? void 0 : _reference$resolved2.defs;
+        if (!definitions || definitions.length === 0) {
+          // Variable is not defined :thinking:
+          return;
+        }
+        var _iterator = _createForOfIteratorHelper(definitions),
+          _step;
+        try {
+          for (_iterator.s(); !(_step = _iterator.n()).done;) {
+            var definition = _step.value;
+            if (definition.type === 'Variable' && definition.node.init) {
+              return this.checkCssMapObjectValue(definition.node.init);
+            }
+          }
+        } catch (err) {
+          _iterator.e(err);
+        } finally {
+          _iterator.f();
+        }
+      } else if (value.type === 'ObjectExpression') {
+        // Object inside another object
+        this.checkCssMapObject(value);
+      } else if (value.type === 'TemplateLiteral') {
+        // object value is a template literal, something like
+        //     `hello world`
+        //     `hello ${functionCall()} world`
+        //     `hello ${someVariable} world`
+        // etc.
+        //
+        // where the expressions are the parts enclosed within the
+        // ${ ... }
+        var _iterator2 = _createForOfIteratorHelper(value.expressions),
+          _step2;
+        try {
+          for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+            var expression = _step2.value;
+            this.checkCssMapObjectValue(expression);
+          }
+        } catch (err) {
+          _iterator2.e(err);
+        } finally {
+          _iterator2.f();
+        }
+      }
+    }
+  }, {
+    key: "checkCssMapObject",
+    value: function checkCssMapObject(cssMapObject) {
+      var _iterator3 = _createForOfIteratorHelper(cssMapObject.properties),
+        _step3;
+      try {
+        for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
+          var property = _step3.value;
+          if (property.type === 'SpreadElement') {
+            this.report({
+              node: property,
+              messageId: 'noSpreadElement'
+            });
+            continue;
+          }
+          this.checkCssMapObjectValue(property.value);
+        }
+      } catch (err) {
+        _iterator3.e(err);
+      } finally {
+        _iterator3.f();
+      }
+    }
+  }, {
+    key: "run",
+    value: function run() {
+      this.checkCssMapObject(this.cssMapObject);
+    }
+  }]);
+  return CssMapObjectChecker;
+}();

package/dist/esm/rules/utils/create-no-exported-rule/check-if-supported-export.js

@@ -0,0 +1,151 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+import { isStyledComponent } from './is-styled-component';
+var getStack = function getStack(context, node) {
+  var _scope;
+  var _context$getSourceCod = context.getSourceCode(),
+    scopeManager = _context$getSourceCod.scopeManager;
+  var stack = {
+    nodes: [],
+    root: node
+  };
+  var scope;
+  for (var current = node; current.type !== 'Program'; current = current.parent) {
+    if (!scope) {
+      var currentScope = scopeManager.acquire(current);
+      if (currentScope) {
+        scope = currentScope;
+      }
+    }
+    switch (current.type) {
+      case 'ExportDefaultDeclaration':
+      case 'ExportNamedDeclaration':
+        stack.root = current;
+        break;
+      case 'VariableDeclarator':
+        stack.root = current;
+        break;
+      case 'ExportSpecifier':
+      case 'ObjectExpression':
+      case 'VariableDeclaration':
+        break;
+      default:
+        stack.nodes.unshift(current);
+    }
+  }
+  return _objectSpread(_objectSpread({}, stack), {}, {
+    scope: (_scope = scope) !== null && _scope !== void 0 ? _scope : context.getScope()
+  });
+};
+var matches = function matches(defs, refs) {
+  // When there are no defs, the definition is inlined. This must be a match as we know the refs contain the initial
+  // definition.
+  if (!defs.length) {
+    return true;
+  }
+
+  // When there are no refs, the reference refers to the entire definition and therefore must be a match.
+  if (!refs.length) {
+    return true;
+  }
+
+  // When both the references and definitions exist, they should match in length
+  if (defs.length !== refs.length) {
+    return false;
+  }
+  return defs.every(function (def, i) {
+    var ref = refs[i];
+    if (def.type === 'Property') {
+      // There is a match between the def and the ref when both names match:
+      //
+      // const fooDef = { bar: '' };
+      // const barRef = fooDef.bar
+      //
+      // There is no match when the ref property does not match the definition key name:
+      //
+      // const barRef = fooDef.notFound
+      return def.key.type === 'Identifier' && ref.type === 'MemberExpression' && ref.property.type === 'Identifier' && ref.property.name === def.key.name;
+    }
+
+    // Anything here is either unsupported or should not match...
+    return false;
+  });
+};
+export var checkIfSupportedExport = function checkIfSupportedExport(context, node, importSources) {
+  var _resolved$references;
+  var scope = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : context.getScope();
+  // Ignore any expression defined outside of the global or module scope as we have no way of statically analysing them
+  if (scope.type !== 'global' && scope.type !== 'module') {
+    return {
+      isExport: false
+    };
+  }
+  var _getStack = getStack(context, node.parent),
+    root = _getStack.root,
+    nodes = _getStack.nodes;
+  // Exporting a component with a css reference should be allowed
+  if (isStyledComponent(nodes, context, importSources)) {
+    return {
+      isExport: false
+    };
+  }
+  if (root.type === 'ExportDefaultDeclaration' || root.type === 'ExportNamedDeclaration') {
+    return {
+      isExport: true,
+      node: root
+    };
+  }
+  if (root.type !== 'VariableDeclarator') {
+    return {
+      isExport: false
+    };
+  }
+
+  // Find the reference to the variable declarator
+  var reference = scope.references.find(function (_ref) {
+    var identifier = _ref.identifier;
+    return identifier === root.id;
+  });
+  if (!reference) {
+    return {
+      isExport: false
+    };
+  }
+
+  // Iterate through all of the references to the resolved variable declarator node
+  var resolved = reference.resolved;
+  var _iterator = _createForOfIteratorHelper((_resolved$references = resolved === null || resolved === void 0 ? void 0 : resolved.references) !== null && _resolved$references !== void 0 ? _resolved$references : []),
+    _step;
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var identifier = _step.value.identifier;
+      // Skip references to the root, since it has already been processed above
+      if (identifier === root.id) {
+        continue;
+      }
+      var _getStack2 = getStack(context, identifier.parent),
+        refs = _getStack2.nodes,
+        nextScope = _getStack2.scope;
+
+      // Only validate the resolved reference if it accesses the definition node
+      if (matches(nodes, refs.reverse())) {
+        // Now validate the identifier reference as a definition
+        var validity = checkIfSupportedExport(context, identifier, importSources, nextScope);
+        if (validity.isExport) {
+          return validity;
+        }
+      }
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  return {
+    isExport: false
+  };
+};

package/dist/esm/rules/utils/create-no-exported-rule/is-styled-component.js

@@ -0,0 +1,74 @@
+import { getFirstSupportedImport } from '../get-first-supported-import';
+/**
+ * Given a list of node, find and return the callee of the first Compiled or styled-components `styled` function call found in the list.
+ *
+ * For example, given `styled.div({ ... })`, we return the node corresponding to the
+ * `styled.div` part. Alternatively, given `styled(button)(style)`, we return the `styled`
+ * part.
+ *
+ * @param nodes
+ * @returns The callee of the first `styled` function call found.
+ */
+var findNode = function findNode(nodes) {
+  var node = nodes.find(function (n) {
+    return n.type === 'TaggedTemplateExpression' || n.type === 'CallExpression';
+  });
+  if (!node) {
+    return;
+  }
+  if (node.type === 'CallExpression') {
+    // Eg. const Component = styled.button(style)
+    if (node.callee.type === 'MemberExpression') {
+      return node.callee;
+    }
+
+    // Eg. const Component = styled(button)(style)
+    if (node.callee.type === 'CallExpression' && node.callee.callee.type === 'Identifier') {
+      return node.callee.callee;
+    }
+  }
+
+  // Eg. const Component = styled.div`${styles}`;
+  if (node.type === 'TaggedTemplateExpression' && node.tag.type === 'MemberExpression') {
+    return node.tag;
+  }
+  return;
+};
+
+/**
+ * Given a rule, return the local name used to import the `styled` API. (for Compiled or styled-components).
+ *
+ * @param context Rule context.
+ * @returns The local name used to import the `styled` API.
+ */
+var getStyledImportSpecifierName = function getStyledImportSpecifierName(context, importSources) {
+  var _supportedImport$spec;
+  var supportedImport = getFirstSupportedImport(context, importSources);
+  return supportedImport === null || supportedImport === void 0 || (_supportedImport$spec = supportedImport.specifiers.find(function (spec) {
+    return spec.type === 'ImportSpecifier' && spec.imported.name === 'styled' || spec.type === 'ImportDefaultSpecifier' && spec.local.name === 'styled';
+  })) === null || _supportedImport$spec === void 0 ? void 0 : _supportedImport$spec.local.name;
+};
+
+/**
+ * Returns whether the node is a usage of the `styled` API in the libraries we support.
+ *
+ * @param nodes Nodes to check.
+ * @param context Rule context.
+ * @param importSources A list of libraries we support.
+ * @returns Whether the node is a usage of the `styled` API.
+ */
+export var isStyledComponent = function isStyledComponent(nodes, context, importSources) {
+  var node = findNode(nodes);
+  if (!node) {
+    return false;
+  }
+  var styledImportSpecifierName = getStyledImportSpecifierName(context, importSources);
+  if (styledImportSpecifierName) {
+    if (node.type === 'Identifier') {
+      return node.name === styledImportSpecifierName;
+    } else {
+      return node.object.type === 'Identifier' && node.object.name === styledImportSpecifierName;
+    }
+  }
+  return false;
+};

package/dist/esm/rules/utils/create-no-exported-rule/main.js

@@ -0,0 +1,60 @@
+import { getImportSources } from '../is-supported-import';
+import { checkIfSupportedExport } from './check-if-supported-export';
+/**
+ * Creates a new ESLint rule for banning exporting certain function calls, e.g.
+ * `css` and `keyframes`.
+ *
+ * Copied from the `utils/create-no-exported-rule/` folder in @compiled/eslint-plugin.
+ *
+ * Requires an importSources option defined on the rule, which is used to define additional
+ * packages which should be checked as part of this rule.
+ *
+ * @param isUsage A function that checks whether the current node matches the desired
+ *                function call to check.
+ * @param messageId The ESLint error message to use for lint violations.
+ * @returns An eslint rule.
+ */
+export var createNoExportedRule = function createNoExportedRule(isUsage, messageId) {
+  return function (context) {
+    var importSources = getImportSources(context);
+    var _context$getSourceCod = context.getSourceCode(),
+      text = _context$getSourceCod.text;
+    if (importSources.every(function (importSource) {
+      return !text.includes(importSource);
+    })) {
+      return {};
+    }
+    return {
+      CallExpression: function CallExpression(node) {
+        var _context$getScope = context.getScope(),
+          references = _context$getScope.references;
+        if (!isUsage(node.callee, references, importSources)) {
+          return;
+        }
+        var state = checkIfSupportedExport(context, node, importSources);
+        if (!state.isExport) {
+          return;
+        }
+        context.report({
+          messageId: messageId,
+          node: state.node
+        });
+      },
+      TaggedTemplateExpression: function TaggedTemplateExpression(node) {
+        var _context$getScope2 = context.getScope(),
+          references = _context$getScope2.references;
+        if (!isUsage(node.tag, references, importSources)) {
+          return;
+        }
+        var state = checkIfSupportedExport(context, node, importSources);
+        if (!state.isExport) {
+          return;
+        }
+        context.report({
+          messageId: messageId,
+          node: state.node
+        });
+      }
+    };
+  };
+};

package/dist/esm/rules/utils/get-first-supported-import.js

@@ -0,0 +1,22 @@
+import { isNodeOfType } from 'eslint-codemod-utils';
+/**
+ * Get the first import declaration in the file that matches any of the packages
+ * in `importSources`.
+ *
+ * @param context Rule context.
+ * @param importSources The packages to check import statements for. If importSources
+ *                      contains more than one package, the first import statement
+ *                      detected in the file that matches any of the packages will be
+ *                      returned.
+ * @returns The first import declaration found in the file.
+ */
+export var getFirstSupportedImport = function getFirstSupportedImport(context, importSources) {
+  var isSupportedImport = function isSupportedImport(node) {
+    return isNodeOfType(node, 'ImportDeclaration') && typeof node.source.value === 'string' && importSources.includes(node.source.value);
+  };
+  var source = context.getSourceCode();
+  var supportedImports = source.ast.body.filter(isSupportedImport);
+  if (supportedImports.length) {
+    return supportedImports[0];
+  }
+};