@atlaskit/eslint-plugin-design-system 9.5.0 → 9.5.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/eslint-plugin-design-system
 
+## 9.5.1
+
+### Patch Changes
+
+- [#87213](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/87213) [`c7caf85c839c`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/c7caf85c839c) - Internal refactoring to `no-invalid-css-map` to use new shared utilities from `@atlaskit/eslint-utils` for determining allowed functions calls.
+- Updated dependencies
+
 ## 9.5.0
 
 ### Minor Changes

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

@@ -5,9 +5,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getCssMapObject = exports.CssMapObjectChecker = void 0;
-var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _allowedFunctionCalls = require("@atlaskit/eslint-utils/allowed-function-calls");
+var _findVariable = require("@atlaskit/eslint-utils/find-variable");
 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; }
@@ -23,75 +24,35 @@ var getCssMapObject = exports.getCssMapObject = function getCssMapObject(node) {
   }
   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;
-};
 var CssMapObjectChecker = exports.CssMapObjectChecker = /*#__PURE__*/function () {
   function CssMapObjectChecker(cssMapObject, context) {
     (0, _classCallCheck2.default)(this, CssMapObjectChecker);
-    this.allowedFunctionCalls = getAllowedFunctionCalls(context.options);
+    this.allowedFunctionCalls = (0, _allowedFunctionCalls.getAllowedFunctionCalls)(context.options);
     this.cssMapObject = cssMapObject;
     this.report = context.report;
-    this.references = context.getScope().references;
+    this.context = context;
   }
   (0, _createClass2.default)(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 = (0, _slicedToArray2.default)(_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)) {
+      if (value.type === 'CallExpression' && value.callee.type === 'Identifier') {
         // object value is a function call in the style
         // {
         //     key: functionCall(), ...
         // }
-        this.report({
-          node: value,
-          messageId: 'noFunctionCalls'
+        var variable = (0, _findVariable.findVariable)({
+          identifier: value.callee,
+          sourceCode: this.context.sourceCode
         });
+        if (!variable || !(0, _allowedFunctionCalls.isAllowListedVariable)({
+          allowList: this.allowedFunctionCalls,
+          variable: variable
+        })) {
+          this.report({
+            node: value,
+            messageId: 'noFunctionCalls'
+          });
+        }
       } else if (value.type === 'ArrowFunctionExpression' || value.type === 'FunctionExpression') {
         // object value is a function call in the style
         // {
@@ -106,16 +67,17 @@ var CssMapObjectChecker = exports.CssMapObjectChecker = /*#__PURE__*/function ()
         this.checkCssMapObjectValue(value.left);
         this.checkCssMapObjectValue(value.right);
       } else if (value.type === 'Identifier') {
-        var _reference$resolved2;
-        var reference = findNodeReference(this.references, value);
+        var _variable = (0, _findVariable.findVariable)({
+          identifier: value,
+          sourceCode: this.context.sourceCode
+        });
 
-        // Get the variable's definition when initialised. Assume that the last definition
-        // is the most recent one.
+        // Get the variable's definition when initialised, and check the first definition that we find.
         //
         // 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;
+        var definitions = _variable === null || _variable === void 0 ? void 0 : _variable.defs;
         if (!definitions || definitions.length === 0) {
           // Variable is not defined :thinking:
           return;

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

@@ -1,3 +1,5 @@
+import { getAllowedFunctionCalls, isAllowListedVariable } from '@atlaskit/eslint-utils/allowed-function-calls';
+import { findVariable } from '@atlaskit/eslint-utils/find-variable';
 export const getCssMapObject = node => {
   // We assume the argument `node` is already a cssMap() call.
 
@@ -10,62 +12,32 @@ export const getCssMapObject = node => {
   }
   return node.arguments[0];
 };
-const findNodeReference = (references, node) => {
-  return references.find(reference => reference.identifier === node);
-};
-const 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 class CssMapObjectChecker {
   constructor(cssMapObject, context) {
     this.allowedFunctionCalls = getAllowedFunctionCalls(context.options);
     this.cssMapObject = cssMapObject;
     this.report = context.report;
-    this.references = context.getScope().references;
-  }
-  isNotWhitelistedFunction(callee) {
-    var _reference$resolved;
-    if (callee.type !== 'Identifier' || this.allowedFunctionCalls.length === 0) {
-      return true;
-    }
-    const reference = findNodeReference(this.references, callee);
-    const definitions = reference === null || reference === void 0 ? void 0 : (_reference$resolved = reference.resolved) === null || _reference$resolved === void 0 ? void 0 : _reference$resolved.defs;
-    if (!definitions) {
-      return true;
-    }
-    return definitions.some(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;
-      }
-      const packageName = definition.parent.source.value;
-      const importedFunctionName = definition.node.imported.name;
-      return !this.allowedFunctionCalls.some(([allowedPackageName, allowedFunctionName]) => allowedPackageName === packageName && allowedFunctionName === importedFunctionName);
-    });
+    this.context = context;
   }
   checkCssMapObjectValue(value) {
-    if (value.type === 'CallExpression' && this.isNotWhitelistedFunction(value.callee)) {
+    if (value.type === 'CallExpression' && value.callee.type === 'Identifier') {
       // object value is a function call in the style
       // {
       //     key: functionCall(), ...
       // }
-      this.report({
-        node: value,
-        messageId: 'noFunctionCalls'
+      const variable = findVariable({
+        identifier: value.callee,
+        sourceCode: this.context.sourceCode
       });
+      if (!variable || !isAllowListedVariable({
+        allowList: this.allowedFunctionCalls,
+        variable
+      })) {
+        this.report({
+          node: value,
+          messageId: 'noFunctionCalls'
+        });
+      }
     } else if (value.type === 'ArrowFunctionExpression' || value.type === 'FunctionExpression') {
       // object value is a function call in the style
       // {
@@ -80,16 +52,17 @@ export class CssMapObjectChecker {
       this.checkCssMapObjectValue(value.left);
       this.checkCssMapObjectValue(value.right);
     } else if (value.type === 'Identifier') {
-      var _reference$resolved2;
-      const reference = findNodeReference(this.references, value);
+      const variable = findVariable({
+        identifier: value,
+        sourceCode: this.context.sourceCode
+      });
 
-      // Get the variable's definition when initialised. Assume that the last definition
-      // is the most recent one.
+      // Get the variable's definition when initialised, and check the first definition that we find.
       //
       // 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...
-      const definitions = reference === null || reference === void 0 ? void 0 : (_reference$resolved2 = reference.resolved) === null || _reference$resolved2 === void 0 ? void 0 : _reference$resolved2.defs;
+      const definitions = variable === null || variable === void 0 ? void 0 : variable.defs;
       if (!definitions || definitions.length === 0) {
         // Variable is not defined :thinking:
         return;

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

@@ -1,9 +1,10 @@
-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; }
+import { getAllowedFunctionCalls, isAllowListedVariable } from '@atlaskit/eslint-utils/allowed-function-calls';
+import { findVariable } from '@atlaskit/eslint-utils/find-variable';
 export var getCssMapObject = function getCssMapObject(node) {
   // We assume the argument `node` is already a cssMap() call.
 
@@ -16,75 +17,35 @@ export var getCssMapObject = function getCssMapObject(node) {
   }
   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;
+    this.context = context;
   }
   _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)) {
+      if (value.type === 'CallExpression' && value.callee.type === 'Identifier') {
         // object value is a function call in the style
         // {
         //     key: functionCall(), ...
         // }
-        this.report({
-          node: value,
-          messageId: 'noFunctionCalls'
+        var variable = findVariable({
+          identifier: value.callee,
+          sourceCode: this.context.sourceCode
         });
+        if (!variable || !isAllowListedVariable({
+          allowList: this.allowedFunctionCalls,
+          variable: variable
+        })) {
+          this.report({
+            node: value,
+            messageId: 'noFunctionCalls'
+          });
+        }
       } else if (value.type === 'ArrowFunctionExpression' || value.type === 'FunctionExpression') {
         // object value is a function call in the style
         // {
@@ -99,16 +60,17 @@ export var CssMapObjectChecker = /*#__PURE__*/function () {
         this.checkCssMapObjectValue(value.left);
         this.checkCssMapObjectValue(value.right);
       } else if (value.type === 'Identifier') {
-        var _reference$resolved2;
-        var reference = findNodeReference(this.references, value);
+        var _variable = findVariable({
+          identifier: value,
+          sourceCode: this.context.sourceCode
+        });
 
-        // Get the variable's definition when initialised. Assume that the last definition
-        // is the most recent one.
+        // Get the variable's definition when initialised, and check the first definition that we find.
         //
         // 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;
+        var definitions = _variable === null || _variable === void 0 ? void 0 : _variable.defs;
         if (!definitions || definitions.length === 0) {
           // Variable is not defined :thinking:
           return;

package/dist/types/rules/no-invalid-css-map/utils.d.ts

@@ -5,9 +5,8 @@ export declare class CssMapObjectChecker {
     private readonly allowedFunctionCalls;
     private readonly cssMapObject;
     private readonly report;
-    private readonly references;
+    private readonly context;
     constructor(cssMapObject: ObjectExpression, context: Rule.RuleContext);
-    private isNotWhitelistedFunction;
     private checkCssMapObjectValue;
     private checkCssMapObject;
     run(): void;

package/dist/types-ts4.5/rules/no-invalid-css-map/utils.d.ts

@@ -5,9 +5,8 @@ export declare class CssMapObjectChecker {
     private readonly allowedFunctionCalls;
     private readonly cssMapObject;
     private readonly report;
-    private readonly references;
+    private readonly context;
     constructor(cssMapObject: ObjectExpression, context: Rule.RuleContext);
-    private isNotWhitelistedFunction;
     private checkCssMapObjectValue;
     private checkCssMapObject;
     run(): void;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@atlaskit/eslint-plugin-design-system",
   "description": "The essential plugin for use with the Atlassian Design System.",
-  "version": "9.5.0",
+  "version": "9.5.1",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
   "publishConfig": {
@@ -41,7 +41,7 @@
     "react": "^16.8.0 || ^17.0.0 || ~18.2.0"
   },
   "dependencies": {
-    "@atlaskit/eslint-utils": "^1.2.0",
+    "@atlaskit/eslint-utils": "^1.3.0",
     "@atlaskit/tokens": "*",
     "@babel/runtime": "^7.0.0",
     "@typescript-eslint/utils": "^5.48.1",