@atlaskit/eslint-plugin-design-system 4.10.1 → 4.11.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/eslint-plugin-design-system
 
+## 4.11.0
+
+### Minor Changes
+
+- [`268f92124e2`](https://bitbucket.org/atlassian/atlassian-frontend/commits/268f92124e2) - Bolster isException logic to support descendants of excepted functions and to be case-agnostic
+
 ## 4.10.1
 
 ### Patch Changes

package/dist/cjs/rules/ensure-design-token-usage/index.js

@@ -7,6 +7,8 @@ exports.default = void 0;
 
 var _eslintCodemodUtils = require("eslint-codemod-utils");
 
+var _getIsException = require("../utils/get-is-exception");
+
 var _isColor = require("../utils/is-color");
 
 var _isElevation = require("../utils/is-elevation");
@@ -58,20 +60,14 @@ var rule = {
   },
   create: function create(context) {
     var config = context.options[0] || defaultConfig;
-
-    var isException = function isException(value) {
-      var _config$exceptions$in, _config$exceptions;
-
-      return (_config$exceptions$in = (_config$exceptions = config.exceptions) === null || _config$exceptions === void 0 ? void 0 : _config$exceptions.includes(value)) !== null && _config$exceptions$in !== void 0 ? _config$exceptions$in : false;
-    };
-
+    var isException = (0, _getIsException.getIsException)(config.exceptions);
     return {
       'TemplateLiteral > Identifier': function TemplateLiteralIdentifier(node) {
         if (!(0, _isNode.isDecendantOfStyleBlock)(node)) {
           return;
         }
 
-        if (node.type === 'Identifier' && (0, _isColor.isLegacyNamedColor)(node.name) && !isException(node.name)) {
+        if (node.type === 'Identifier' && (0, _isColor.isLegacyNamedColor)(node.name) && !isException(node)) {
           context.report({
             messageId: 'hardCodedColor',
             node: node,
@@ -81,7 +77,7 @@ var rule = {
         }
       },
       Identifier: function Identifier(node) {
-        if (isException(node.name) || (0, _isNode.isDecendantOfGlobalToken)(node) || (0, _isNode.isDecendantOfType)(node, 'ImportDeclaration') || (0, _isNode.isPropertyKey)(node) || (0, _isNode.isVariableName)(node)) {
+        if (isException(node) || (0, _isNode.isDecendantOfGlobalToken)(node) || (0, _isNode.isDecendantOfType)(node, 'ImportDeclaration') || (0, _isNode.isPropertyKey)(node) || (0, _isNode.isVariableName)(node)) {
           return;
         }
 
@@ -159,11 +155,7 @@ var rule = {
         });
       },
       'ObjectExpression > Property > Literal': function ObjectExpressionPropertyLiteral(node) {
-        if (node.type !== 'Literal') {
-          return;
-        }
-
-        if (typeof node.value !== 'string') {
+        if (node.type !== 'Literal' || typeof node.value !== 'string') {
           return;
         }
 
@@ -171,11 +163,7 @@ var rule = {
           return;
         }
 
-        if (isException(node.value)) {
-          return;
-        }
-
-        if ((0, _isColor.isHardCodedColor)(node.value) || (0, _isColor.includesHardCodedColor)(node.value)) {
+        if (((0, _isColor.isHardCodedColor)(node.value) || (0, _isColor.includesHardCodedColor)(node.value)) && !isException(node)) {
           context.report({
             messageId: 'hardCodedColor',
             node: node,
@@ -193,7 +181,7 @@ var rule = {
           return;
         }
 
-        if (!(0, _isColor.isLegacyNamedColor)(node.callee.name) || (0, _isNode.isDecendantOfGlobalToken)(node) || isException(node.callee.name)) {
+        if (!(0, _isColor.isLegacyNamedColor)(node.callee.name) || (0, _isNode.isDecendantOfGlobalToken)(node) || isException(node)) {
           return;
         }
 
@@ -213,12 +201,12 @@ var rule = {
         }
 
         if (node.value.type === 'Literal') {
-          var literalValue = node.value.value;
-
-          if (isException(literalValue)) {
+          if (isException(node)) {
             return;
           }
 
+          var literalValue = node.value.value;
+
           if ((0, _isColor.isHardCodedColor)(literalValue) || (0, _isColor.includesHardCodedColor)(literalValue)) {
             context.report({
               messageId: 'hardCodedColor',

package/dist/cjs/rules/utils/get-is-exception.js

@@ -0,0 +1,65 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getIsException = void 0;
+
+var getNodeValue = function getNodeValue(node) {
+  var _node$value;
+
+  switch (node.type) {
+    case 'Identifier':
+      return node.name;
+
+    case 'Literal':
+      return typeof node.value === 'string' ? node.value : null;
+
+    case 'CallExpression':
+      return node.callee.type === 'Identifier' ? node.callee.name : null;
+    // @ts-expect-error
+
+    case 'JSXAttribute':
+      // @ts-expect-error
+      return ((_node$value = node.value) === null || _node$value === void 0 ? void 0 : _node$value.type) === 'Literal' ? node.value.value : null;
+
+    default:
+      return null;
+  }
+};
+
+var getIsException = function getIsException(exceptions) {
+  if (!(exceptions !== null && exceptions !== void 0 && exceptions.length)) {
+    return function () {
+      return false;
+    };
+  }
+
+  var exceptionsSet = new Set(exceptions.map(function (x) {
+    return x.toLowerCase();
+  }));
+
+  var isException = function isException(node) {
+    var value = getNodeValue(node);
+
+    if (value) {
+      var splitValues = value.split(/[-_\s]+/);
+
+      if (splitValues.some(function (v) {
+        return exceptionsSet.has(v.toLowerCase());
+      })) {
+        return true;
+      }
+    }
+
+    if (node.parent) {
+      return isException(node.parent);
+    }
+
+    return false;
+  };
+
+  return isException;
+};
+
+exports.getIsException = getIsException;

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/eslint-plugin-design-system",
-	"version": "4.10.1",
+	"version": "4.11.0",
 	"sideEffects": false
 }

package/dist/es2019/rules/ensure-design-token-usage/index.js

@@ -1,4 +1,5 @@
 import { isNodeOfType } from 'eslint-codemod-utils';
+import { getIsException } from '../utils/get-is-exception';
 import { includesHardCodedColor, isHardCodedColor, isLegacyColor, isLegacyNamedColor } from '../utils/is-color';
 import { isLegacyElevation } from '../utils/is-elevation';
 import { isChildOfType, isDecendantOfGlobalToken, isDecendantOfStyleBlock, isDecendantOfStyleJsxAttribute, isDecendantOfType, isPropertyKey, isVariableName } from '../utils/is-node';
@@ -49,20 +50,14 @@ token('color.background.blanket');
 
   create(context) {
     const config = context.options[0] || defaultConfig;
-
-    const isException = value => {
-      var _config$exceptions$in, _config$exceptions;
-
-      return (_config$exceptions$in = (_config$exceptions = config.exceptions) === null || _config$exceptions === void 0 ? void 0 : _config$exceptions.includes(value)) !== null && _config$exceptions$in !== void 0 ? _config$exceptions$in : false;
-    };
-
+    const isException = getIsException(config.exceptions);
     return {
       'TemplateLiteral > Identifier': node => {
         if (!isDecendantOfStyleBlock(node)) {
           return;
         }
 
-        if (node.type === 'Identifier' && isLegacyNamedColor(node.name) && !isException(node.name)) {
+        if (node.type === 'Identifier' && isLegacyNamedColor(node.name) && !isException(node)) {
           context.report({
             messageId: 'hardCodedColor',
             node,
@@ -73,7 +68,7 @@ token('color.background.blanket');
       },
 
       Identifier(node) {
-        if (isException(node.name) || isDecendantOfGlobalToken(node) || isDecendantOfType(node, 'ImportDeclaration') || isPropertyKey(node) || isVariableName(node)) {
+        if (isException(node) || isDecendantOfGlobalToken(node) || isDecendantOfType(node, 'ImportDeclaration') || isPropertyKey(node) || isVariableName(node)) {
           return;
         }
 
@@ -156,11 +151,7 @@ ${' '.repeat(getNodeColumn(node) - 2)}box-shadow: \${token('${elevation.shadow}'
         });
       },
       'ObjectExpression > Property > Literal': node => {
-        if (node.type !== 'Literal') {
-          return;
-        }
-
-        if (typeof node.value !== 'string') {
+        if (node.type !== 'Literal' || typeof node.value !== 'string') {
           return;
         }
 
@@ -168,11 +159,7 @@ ${' '.repeat(getNodeColumn(node) - 2)}box-shadow: \${token('${elevation.shadow}'
           return;
         }
 
-        if (isException(node.value)) {
-          return;
-        }
-
-        if (isHardCodedColor(node.value) || includesHardCodedColor(node.value)) {
+        if ((isHardCodedColor(node.value) || includesHardCodedColor(node.value)) && !isException(node)) {
           context.report({
             messageId: 'hardCodedColor',
             node,
@@ -191,7 +178,7 @@ ${' '.repeat(getNodeColumn(node) - 2)}box-shadow: \${token('${elevation.shadow}'
           return;
         }
 
-        if (!isLegacyNamedColor(node.callee.name) || isDecendantOfGlobalToken(node) || isException(node.callee.name)) {
+        if (!isLegacyNamedColor(node.callee.name) || isDecendantOfGlobalToken(node) || isException(node)) {
           return;
         }
 
@@ -212,12 +199,12 @@ ${' '.repeat(getNodeColumn(node) - 2)}box-shadow: \${token('${elevation.shadow}'
         }
 
         if (node.value.type === 'Literal') {
-          const literalValue = node.value.value;
-
-          if (isException(literalValue)) {
+          if (isException(node)) {
             return;
           }
 
+          const literalValue = node.value.value;
+
           if (isHardCodedColor(literalValue) || includesHardCodedColor(literalValue)) {
             context.report({
               messageId: 'hardCodedColor',

package/dist/es2019/rules/utils/get-is-exception.js

@@ -0,0 +1,50 @@
+const getNodeValue = node => {
+  var _node$value;
+
+  switch (node.type) {
+    case 'Identifier':
+      return node.name;
+
+    case 'Literal':
+      return typeof node.value === 'string' ? node.value : null;
+
+    case 'CallExpression':
+      return node.callee.type === 'Identifier' ? node.callee.name : null;
+    // @ts-expect-error
+
+    case 'JSXAttribute':
+      // @ts-expect-error
+      return ((_node$value = node.value) === null || _node$value === void 0 ? void 0 : _node$value.type) === 'Literal' ? node.value.value : null;
+
+    default:
+      return null;
+  }
+};
+
+export const getIsException = exceptions => {
+  if (!(exceptions !== null && exceptions !== void 0 && exceptions.length)) {
+    return () => false;
+  }
+
+  const exceptionsSet = new Set(exceptions.map(x => x.toLowerCase()));
+
+  const isException = node => {
+    const value = getNodeValue(node);
+
+    if (value) {
+      const splitValues = value.split(/[-_\s]+/);
+
+      if (splitValues.some(v => exceptionsSet.has(v.toLowerCase()))) {
+        return true;
+      }
+    }
+
+    if (node.parent) {
+      return isException(node.parent);
+    }
+
+    return false;
+  };
+
+  return isException;
+};

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/eslint-plugin-design-system",
-	"version": "4.10.1",
+	"version": "4.11.0",
 	"sideEffects": false
 }

package/dist/esm/rules/ensure-design-token-usage/index.js

@@ -1,4 +1,5 @@
 import { isNodeOfType } from 'eslint-codemod-utils';
+import { getIsException } from '../utils/get-is-exception';
 import { includesHardCodedColor, isHardCodedColor, isLegacyColor, isLegacyNamedColor } from '../utils/is-color';
 import { isLegacyElevation } from '../utils/is-elevation';
 import { isChildOfType, isDecendantOfGlobalToken, isDecendantOfStyleBlock, isDecendantOfStyleJsxAttribute, isDecendantOfType, isPropertyKey, isVariableName } from '../utils/is-node';
@@ -47,20 +48,14 @@ var rule = {
   },
   create: function create(context) {
     var config = context.options[0] || defaultConfig;
-
-    var isException = function isException(value) {
-      var _config$exceptions$in, _config$exceptions;
-
-      return (_config$exceptions$in = (_config$exceptions = config.exceptions) === null || _config$exceptions === void 0 ? void 0 : _config$exceptions.includes(value)) !== null && _config$exceptions$in !== void 0 ? _config$exceptions$in : false;
-    };
-
+    var isException = getIsException(config.exceptions);
     return {
       'TemplateLiteral > Identifier': function TemplateLiteralIdentifier(node) {
         if (!isDecendantOfStyleBlock(node)) {
           return;
         }
 
-        if (node.type === 'Identifier' && isLegacyNamedColor(node.name) && !isException(node.name)) {
+        if (node.type === 'Identifier' && isLegacyNamedColor(node.name) && !isException(node)) {
           context.report({
             messageId: 'hardCodedColor',
             node: node,
@@ -70,7 +65,7 @@ var rule = {
         }
       },
       Identifier: function Identifier(node) {
-        if (isException(node.name) || isDecendantOfGlobalToken(node) || isDecendantOfType(node, 'ImportDeclaration') || isPropertyKey(node) || isVariableName(node)) {
+        if (isException(node) || isDecendantOfGlobalToken(node) || isDecendantOfType(node, 'ImportDeclaration') || isPropertyKey(node) || isVariableName(node)) {
           return;
         }
 
@@ -148,11 +143,7 @@ var rule = {
         });
       },
       'ObjectExpression > Property > Literal': function ObjectExpressionPropertyLiteral(node) {
-        if (node.type !== 'Literal') {
-          return;
-        }
-
-        if (typeof node.value !== 'string') {
+        if (node.type !== 'Literal' || typeof node.value !== 'string') {
           return;
         }
 
@@ -160,11 +151,7 @@ var rule = {
           return;
         }
 
-        if (isException(node.value)) {
-          return;
-        }
-
-        if (isHardCodedColor(node.value) || includesHardCodedColor(node.value)) {
+        if ((isHardCodedColor(node.value) || includesHardCodedColor(node.value)) && !isException(node)) {
           context.report({
             messageId: 'hardCodedColor',
             node: node,
@@ -182,7 +169,7 @@ var rule = {
           return;
         }
 
-        if (!isLegacyNamedColor(node.callee.name) || isDecendantOfGlobalToken(node) || isException(node.callee.name)) {
+        if (!isLegacyNamedColor(node.callee.name) || isDecendantOfGlobalToken(node) || isException(node)) {
           return;
         }
 
@@ -202,12 +189,12 @@ var rule = {
         }
 
         if (node.value.type === 'Literal') {
-          var literalValue = node.value.value;
-
-          if (isException(literalValue)) {
+          if (isException(node)) {
             return;
           }
 
+          var literalValue = node.value.value;
+
           if (isHardCodedColor(literalValue) || includesHardCodedColor(literalValue)) {
             context.report({
               messageId: 'hardCodedColor',

package/dist/esm/rules/utils/get-is-exception.js

@@ -0,0 +1,56 @@
+var getNodeValue = function getNodeValue(node) {
+  var _node$value;
+
+  switch (node.type) {
+    case 'Identifier':
+      return node.name;
+
+    case 'Literal':
+      return typeof node.value === 'string' ? node.value : null;
+
+    case 'CallExpression':
+      return node.callee.type === 'Identifier' ? node.callee.name : null;
+    // @ts-expect-error
+
+    case 'JSXAttribute':
+      // @ts-expect-error
+      return ((_node$value = node.value) === null || _node$value === void 0 ? void 0 : _node$value.type) === 'Literal' ? node.value.value : null;
+
+    default:
+      return null;
+  }
+};
+
+export var getIsException = function getIsException(exceptions) {
+  if (!(exceptions !== null && exceptions !== void 0 && exceptions.length)) {
+    return function () {
+      return false;
+    };
+  }
+
+  var exceptionsSet = new Set(exceptions.map(function (x) {
+    return x.toLowerCase();
+  }));
+
+  var isException = function isException(node) {
+    var value = getNodeValue(node);
+
+    if (value) {
+      var splitValues = value.split(/[-_\s]+/);
+
+      if (splitValues.some(function (v) {
+        return exceptionsSet.has(v.toLowerCase());
+      })) {
+        return true;
+      }
+    }
+
+    if (node.parent) {
+      return isException(node.parent);
+    }
+
+    return false;
+  };
+
+  return isException;
+};

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/eslint-plugin-design-system",
-	"version": "4.10.1",
+	"version": "4.11.0",
 	"sideEffects": false
 }

package/dist/types/rules/utils/get-is-exception.d.ts

@@ -0,0 +1,2 @@
+import type { Rule } from 'eslint';
+export declare const getIsException: (exceptions?: string[] | undefined) => (node: Rule.Node) => boolean;

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": "4.10.1",
+  "version": "4.11.0",
   "author": "Atlassian Pty Ltd",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"