@atlaskit/eslint-plugin-design-system 10.0.0 → 10.0.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/eslint-plugin-design-system
 
+## 10.0.1
+
+### Patch Changes
+
+-   [#98294](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/98294)
+    [`0663be43d057`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/0663be43d057) -
+    The `ensure-design-token-usage` rule will now ignore `xcss()` calls even if the `xcss` variable
+    has been aliased.
+
 ## 10.0.0
 
 ### Major Changes

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

@@ -7,6 +7,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = exports.createWithConfig = void 0;
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _eslintCodemodUtils = require("eslint-codemod-utils");
+var _isSupportedImport = require("@atlaskit/eslint-utils/is-supported-import");
 var _createRule = require("../utils/create-rule");
 var _isColor = require("../utils/is-color");
 var _isNode = require("../utils/is-node");
@@ -67,6 +68,14 @@ var createWithConfig = exports.createWithConfig = function createWithConfig(init
         return ObjectExpression;
       }(function (parentNode) {
         return (0, _errorBoundary.errorBoundary)(function () {
+          var _context$getScope = context.getScope(),
+            references = _context$getScope.references;
+          /**
+           * NOTE: This rule doesn't have an `importSources` config option,
+           * so this will just be equal to DEFAULT_IMPORT_SOURCES (which is fine)
+           */
+          var importSources = (0, _isSupportedImport.getImportSources)(context);
+
           // To force the correct node type
           if (!(0, _eslintCodemodUtils.isNodeOfType)(parentNode, 'ObjectExpression')) {
             return;
@@ -76,7 +85,7 @@ var createWithConfig = exports.createWithConfig = function createWithConfig(init
           if (parentNode.parent.type === 'Property') {
             return;
           }
-          if ((0, _isNode.isDecendantOfXcssBlock)(parentNode)) {
+          if ((0, _isNode.isDecendantOfXcssBlock)(parentNode, references, importSources)) {
             return;
           }
           if (!(0, _isNode.isDecendantOfStyleBlock)(parentNode) && !(0, _isNode.isDecendantOfType)(parentNode, 'JSXExpressionContainer')) {

package/dist/cjs/rules/utils/is-node.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.isPropertyKey = exports.isDecendantOfXcssBlock = exports.isDecendantOfType = exports.isDecendantOfSvgElement = exports.isDecendantOfStyleJsxAttribute = exports.isDecendantOfStyleBlock = exports.isDecendantOfPrimitive = exports.isDecendantOfGlobalToken = exports.isCssInJsTemplateNode = exports.isCssInJsObjectNode = exports.isCssInJsCallNode = exports.isChildOfType = void 0;
 var _eslintCodemodUtils = require("eslint-codemod-utils");
+var _isSupportedImport = require("@atlaskit/eslint-utils/is-supported-import");
 var _astNodes = require("../../ast-nodes");
 // eslint-disable-next-line import/no-extraneous-dependencies
 
@@ -81,16 +82,13 @@ var isCssInJsCallNode = exports.isCssInJsCallNode = function isCssInJsCallNode(n
 var isCssInJsObjectNode = exports.isCssInJsObjectNode = function isCssInJsObjectNode(node) {
   return (node === null || node === void 0 ? void 0 : node.type) === 'CallExpression' && node.callee.type === 'MemberExpression' && node.callee.object.type === 'Identifier' && cssInJsCallees.includes(node.callee.object.name);
 };
-var isXcssCallNode = function isXcssCallNode(node) {
-  return (node === null || node === void 0 ? void 0 : node.type) === 'CallExpression' && node.callee.type === 'Identifier' && node.callee.name === 'xcss';
-};
-var isDecendantOfXcssBlock = exports.isDecendantOfXcssBlock = function isDecendantOfXcssBlock(node) {
+var isDecendantOfXcssBlock = exports.isDecendantOfXcssBlock = function isDecendantOfXcssBlock(node, referencesInScope, importSources) {
   // xcss contains types for all properties that accept tokens, so ignore xcss for linting as it will report false positives
-  if (isXcssCallNode(node)) {
+  if (node.type === 'CallExpression' && (0, _isSupportedImport.isXcss)(node.callee, referencesInScope, importSources)) {
     return true;
   }
   if (node.parent) {
-    return isDecendantOfXcssBlock(node.parent);
+    return isDecendantOfXcssBlock(node.parent, referencesInScope, importSources);
   }
   return false;
 };

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

@@ -1,6 +1,7 @@
 // eslint-disable-next-line import/no-extraneous-dependencies
 
 import { isNodeOfType } from 'eslint-codemod-utils';
+import { getImportSources } from '@atlaskit/eslint-utils/is-supported-import';
 import { createLintRule } from '../utils/create-rule';
 import { includesHardCodedColor } from '../utils/is-color';
 import { isDecendantOfGlobalToken, isDecendantOfStyleBlock, isDecendantOfType, isDecendantOfXcssBlock } from '../utils/is-node';
@@ -45,6 +46,15 @@ const createWithConfig = initialConfig => context => {
     }),
     // const styles = css({ color: 'red', margin: '4px' }), styled.div({ color: 'red', margin: '4px' })
     ObjectExpression: parentNode => errorBoundary(() => {
+      const {
+        references
+      } = context.getScope();
+      /**
+       * NOTE: This rule doesn't have an `importSources` config option,
+       * so this will just be equal to DEFAULT_IMPORT_SOURCES (which is fine)
+       */
+      const importSources = getImportSources(context);
+
       // To force the correct node type
       if (!isNodeOfType(parentNode, 'ObjectExpression')) {
         return;
@@ -54,7 +64,7 @@ const createWithConfig = initialConfig => context => {
       if (parentNode.parent.type === 'Property') {
         return;
       }
-      if (isDecendantOfXcssBlock(parentNode)) {
+      if (isDecendantOfXcssBlock(parentNode, references, importSources)) {
         return;
       }
       if (!isDecendantOfStyleBlock(parentNode) && !isDecendantOfType(parentNode, 'JSXExpressionContainer')) {

package/dist/es2019/rules/utils/is-node.js

@@ -1,6 +1,7 @@
 // eslint-disable-next-line import/no-extraneous-dependencies
 
 import { isNodeOfType } from 'eslint-codemod-utils';
+import { isXcss } from '@atlaskit/eslint-utils/is-supported-import';
 import { Root } from '../../ast-nodes';
 export const isDecendantOfGlobalToken = node => {
   if (isNodeOfType(node, 'CallExpression') && isNodeOfType(node.callee, 'Identifier') && (node.callee.name === 'token' || node.callee.name === 'getTokenValue')) {
@@ -68,14 +69,13 @@ const cssInJsCallees = ['css', 'styled', 'styled2'];
 export const isCssInJsTemplateNode = node => (node === null || node === void 0 ? void 0 : node.type) === 'TaggedTemplateExpression' && node.tag.type === 'MemberExpression' && node.tag.object.type === 'Identifier' && node.tag.object.name === 'styled';
 export const isCssInJsCallNode = node => (node === null || node === void 0 ? void 0 : node.type) === 'CallExpression' && node.callee.type === 'Identifier' && cssInJsCallees.includes(node.callee.name);
 export const isCssInJsObjectNode = node => (node === null || node === void 0 ? void 0 : node.type) === 'CallExpression' && node.callee.type === 'MemberExpression' && node.callee.object.type === 'Identifier' && cssInJsCallees.includes(node.callee.object.name);
-const isXcssCallNode = node => (node === null || node === void 0 ? void 0 : node.type) === 'CallExpression' && node.callee.type === 'Identifier' && node.callee.name === 'xcss';
-export const isDecendantOfXcssBlock = node => {
+export const isDecendantOfXcssBlock = (node, referencesInScope, importSources) => {
   // xcss contains types for all properties that accept tokens, so ignore xcss for linting as it will report false positives
-  if (isXcssCallNode(node)) {
+  if (node.type === 'CallExpression' && isXcss(node.callee, referencesInScope, importSources)) {
     return true;
   }
   if (node.parent) {
-    return isDecendantOfXcssBlock(node.parent);
+    return isDecendantOfXcssBlock(node.parent, referencesInScope, importSources);
   }
   return false;
 };

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

@@ -2,6 +2,7 @@ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 // eslint-disable-next-line import/no-extraneous-dependencies
 
 import { isNodeOfType } from 'eslint-codemod-utils';
+import { getImportSources } from '@atlaskit/eslint-utils/is-supported-import';
 import { createLintRule } from '../utils/create-rule';
 import { includesHardCodedColor } from '../utils/is-color';
 import { isDecendantOfGlobalToken, isDecendantOfStyleBlock, isDecendantOfType, isDecendantOfXcssBlock } from '../utils/is-node';
@@ -60,6 +61,14 @@ var createWithConfig = function createWithConfig(initialConfig) {
         return ObjectExpression;
       }(function (parentNode) {
         return errorBoundary(function () {
+          var _context$getScope = context.getScope(),
+            references = _context$getScope.references;
+          /**
+           * NOTE: This rule doesn't have an `importSources` config option,
+           * so this will just be equal to DEFAULT_IMPORT_SOURCES (which is fine)
+           */
+          var importSources = getImportSources(context);
+
           // To force the correct node type
           if (!isNodeOfType(parentNode, 'ObjectExpression')) {
             return;
@@ -69,7 +78,7 @@ var createWithConfig = function createWithConfig(initialConfig) {
           if (parentNode.parent.type === 'Property') {
             return;
           }
-          if (isDecendantOfXcssBlock(parentNode)) {
+          if (isDecendantOfXcssBlock(parentNode, references, importSources)) {
             return;
           }
           if (!isDecendantOfStyleBlock(parentNode) && !isDecendantOfType(parentNode, 'JSXExpressionContainer')) {

package/dist/esm/rules/utils/is-node.js

@@ -1,6 +1,7 @@
 // eslint-disable-next-line import/no-extraneous-dependencies
 
 import { isNodeOfType } from 'eslint-codemod-utils';
+import { isXcss } from '@atlaskit/eslint-utils/is-supported-import';
 import { Root } from '../../ast-nodes';
 export var isDecendantOfGlobalToken = function isDecendantOfGlobalToken(node) {
   if (isNodeOfType(node, 'CallExpression') && isNodeOfType(node.callee, 'Identifier') && (node.callee.name === 'token' || node.callee.name === 'getTokenValue')) {
@@ -75,16 +76,13 @@ export var isCssInJsCallNode = function isCssInJsCallNode(node) {
 export var isCssInJsObjectNode = function isCssInJsObjectNode(node) {
   return (node === null || node === void 0 ? void 0 : node.type) === 'CallExpression' && node.callee.type === 'MemberExpression' && node.callee.object.type === 'Identifier' && cssInJsCallees.includes(node.callee.object.name);
 };
-var isXcssCallNode = function isXcssCallNode(node) {
-  return (node === null || node === void 0 ? void 0 : node.type) === 'CallExpression' && node.callee.type === 'Identifier' && node.callee.name === 'xcss';
-};
-export var isDecendantOfXcssBlock = function isDecendantOfXcssBlock(node) {
+export var isDecendantOfXcssBlock = function isDecendantOfXcssBlock(node, referencesInScope, importSources) {
   // xcss contains types for all properties that accept tokens, so ignore xcss for linting as it will report false positives
-  if (isXcssCallNode(node)) {
+  if (node.type === 'CallExpression' && isXcss(node.callee, referencesInScope, importSources)) {
     return true;
   }
   if (node.parent) {
-    return isDecendantOfXcssBlock(node.parent);
+    return isDecendantOfXcssBlock(node.parent, referencesInScope, importSources);
   }
   return false;
 };

package/dist/types/rules/ensure-design-token-usage/index.d.ts

@@ -1,5 +1,5 @@
 import type { Rule } from 'eslint';
-import { RuleConfig } from './types';
+import { type RuleConfig } from './types';
 declare const createWithConfig: (initialConfig: RuleConfig) => Rule.RuleModule['create'];
 declare const rule: Rule.RuleModule;
 export default rule;

package/dist/types/rules/utils/is-node.d.ts

@@ -1,5 +1,5 @@
-import type { Rule } from 'eslint';
-import { CallExpression, EslintNode, Expression, TaggedTemplateExpression } from 'eslint-codemod-utils';
+import type { Rule, Scope } from 'eslint';
+import { type CallExpression, type EslintNode, type Expression, type TaggedTemplateExpression } from 'eslint-codemod-utils';
 export declare const isDecendantOfGlobalToken: (node: EslintNode) => boolean;
 export declare const isDecendantOfType: (node: Rule.Node, type: Rule.Node['type'], skipNode?: boolean) => boolean;
 export declare const isPropertyKey: (node: Rule.Node) => boolean;
@@ -9,6 +9,6 @@ export declare const isDecendantOfPrimitive: (node: Rule.Node, context: Rule.Rul
 export declare const isCssInJsTemplateNode: (node?: Expression | null) => node is TaggedTemplateExpression;
 export declare const isCssInJsCallNode: (node?: Expression | null) => node is CallExpression;
 export declare const isCssInJsObjectNode: (node?: Expression | null) => node is CallExpression;
-export declare const isDecendantOfXcssBlock: (node: Rule.Node) => boolean;
+export declare const isDecendantOfXcssBlock: (node: Rule.Node, referencesInScope: Scope.Reference[], importSources: string[]) => boolean;
 export declare const isDecendantOfStyleBlock: (node: Rule.Node) => boolean;
 export declare const isChildOfType: (node: Rule.Node, type: Rule.Node['type']) => boolean;

package/dist/types-ts4.5/rules/ensure-design-token-usage/index.d.ts

@@ -1,5 +1,5 @@
 import type { Rule } from 'eslint';
-import { RuleConfig } from './types';
+import { type RuleConfig } from './types';
 declare const createWithConfig: (initialConfig: RuleConfig) => Rule.RuleModule['create'];
 declare const rule: Rule.RuleModule;
 export default rule;

package/dist/types-ts4.5/rules/utils/is-node.d.ts

@@ -1,5 +1,5 @@
-import type { Rule } from 'eslint';
-import { CallExpression, EslintNode, Expression, TaggedTemplateExpression } from 'eslint-codemod-utils';
+import type { Rule, Scope } from 'eslint';
+import { type CallExpression, type EslintNode, type Expression, type TaggedTemplateExpression } from 'eslint-codemod-utils';
 export declare const isDecendantOfGlobalToken: (node: EslintNode) => boolean;
 export declare const isDecendantOfType: (node: Rule.Node, type: Rule.Node['type'], skipNode?: boolean) => boolean;
 export declare const isPropertyKey: (node: Rule.Node) => boolean;
@@ -9,6 +9,6 @@ export declare const isDecendantOfPrimitive: (node: Rule.Node, context: Rule.Rul
 export declare const isCssInJsTemplateNode: (node?: Expression | null) => node is TaggedTemplateExpression;
 export declare const isCssInJsCallNode: (node?: Expression | null) => node is CallExpression;
 export declare const isCssInJsObjectNode: (node?: Expression | null) => node is CallExpression;
-export declare const isDecendantOfXcssBlock: (node: Rule.Node) => boolean;
+export declare const isDecendantOfXcssBlock: (node: Rule.Node, referencesInScope: Scope.Reference[], importSources: string[]) => boolean;
 export declare const isDecendantOfStyleBlock: (node: Rule.Node) => boolean;
 export declare const isChildOfType: (node: Rule.Node, type: Rule.Node['type']) => 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": "10.0.0",
+  "version": "10.0.1",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
   "publishConfig": {