@atlaskit/eslint-plugin-design-system 8.21.0 → 8.22.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/eslint-plugin-design-system
 
+## 8.22.0
+
+### Minor Changes
+
+- [#63589](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/63589) [`f59d997d1913`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/f59d997d1913) - Implemented new fixers for cssOnTopOfModule and cssAtBottomOfModule violation cases
+
 ## 8.21.0
 
 ### Minor Changes

package/constellation/index/usage.mdx

@@ -66,6 +66,8 @@ This rule has options - see below.
 
 👎 Example of **incorrect** code for this rule:
 
+**Calling a css/xcss function or direct objects inside the JSX attribute.**
+
 ```js
 function Button({ children }) {
   return <div css={css({...})}>{children}</div>;
@@ -73,6 +75,8 @@ function Button({ children }) {
 }
 ```
 
+**Inserting a non css-function based object identifier into a css JSX attribute.**
+
 ```js
 const container = {
       ^^^^^^^^^ should be a css function call
@@ -84,6 +88,8 @@ function Button({ children }) {
 }
 ```
 
+**Importing styles from another file.**
+
 ```js
 import { container } from './styles';
          ^^^^^^^^^ styles should be local, not shared
@@ -93,6 +99,8 @@ function Button({ children }) {
 }
 ```
 
+**Nesting styles with objects instead of arrays.**
+
 ```js
 const baseContainerStyles = css({
   zIndex: 5,
@@ -111,6 +119,13 @@ function Button({ children }) {
 
 👍 Example of **correct** code for this rule:
 
+**Using the css() function to create a style object that follows the naming convention (ends in Styles) and passing it as a variable into the css={...} JSX attribute.**
+
+With the following options turned on:
+
+- cssFunctions = ['css']
+- stylesPlacement = 'top'
+
 ```js
 const containerStyles = css({
   zIndex: 1,
@@ -121,7 +136,38 @@ function Button({ children }) {
 }
 ```
 
+**Technically correct usage of the cssMap function.**
+
+With the following options turned on:
+
+- cssFunctions = ['css']
+- stylesPlacement = 'top'
+
 ```js
+const borderStyles = cssMap({
+  'solid': '1px solid';
+  'none': '0px';
+})
+
+function Button({ children }) {
+  return <button css={borderStyles[solid]}>{children}</button>;
+}
+```
+
+**Create composite styles with arrays, not objects.**
+
+With the following options turned on:
+
+- cssFunctions = ['css']
+- stylesPlacement = 'bottom'
+
+```js
+function Button({ children }) {
+  return (
+    <button css={[baseContainerStyles, containerStyles]}>{children}</button>
+  );
+}
+
 const baseContainerStyles = css({
   zIndex: 5,
 });
@@ -129,12 +175,15 @@ const baseContainerStyles = css({
 const containerStyles = css({
   zIndex: 7,
 });
+```
 
-function Button({ children }) {
-  return (
-    <button css={[baseContainerStyles, containerStyles]}>{children}</button>
-  );
-}
+**Ternaries can be used inline**
+
+```js
+const baseStyles = css({ color: token('color.text.primary') });
+const disabledStyles = css({ color: token('color.text.disabled') });
+
+<div css={props.disabled ? disabledStyles : baseStyles}></div>;
 ```
 
 <h3>Options</h3>

package/dist/cjs/rules/consistent-css-prop-usage/index.js

@@ -6,15 +6,15 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _eslintCodemodUtils = require("eslint-codemod-utils");
 var _assign = _interopRequireDefault(require("lodash/assign"));
 var _createRule = require("../utils/create-rule");
 // eslint-disable-next-line import/no-extraneous-dependencies
 
-var declarationSuffix = 'Styles';
 function isCssCallExpression(node, cssFunctions) {
+  cssFunctions = [].concat((0, _toConsumableArray2.default)(cssFunctions), ['cssMap']);
   return !!((0, _eslintCodemodUtils.isNodeOfType)(node, 'CallExpression') && node.callee && node.callee.type === 'Identifier' && cssFunctions.includes(node.callee.name) && node.arguments.length && node.arguments[0].type === 'ObjectExpression');
 }
 function findSpreadProperties(node) {
@@ -25,6 +25,44 @@ function findSpreadProperties(node) {
     property.type === 'ExperimentalSpreadProperty';
   });
 }
+var getTopLevelNode = function getTopLevelNode(expression) {
+  while (expression.parent.type !== 'Program') {
+    expression = expression.parent;
+  }
+  return expression;
+};
+
+// TODO: This can be optimised by implementing a fixer at the very end (Program:exit) and handling all validations at once
+/**
+ * Generates the declarator string when fixing the cssOnTopOfModule/cssAtBottomOfModule cases.
+ * When `styles` already exists, `styles_1, styles_2, ..., styles_X` are incrementally created for each unhoisted style.
+ * The generated `styles` varibale declaration names must be manually modified to be more informative at the discretion of owning teams.
+ */
+var getDeclaratorString = function getDeclaratorString(context) {
+  var scope = context.getScope();
+
+  // Get to ModuleScope
+  while (scope && scope.upper && scope.upper.type !== 'global') {
+    var _scope;
+    scope = (_scope = scope) === null || _scope === void 0 ? void 0 : _scope.upper;
+  }
+  var variables = scope.variables.map(function (variable) {
+    return variable.name;
+  });
+  var count = 2;
+  var declaratorName = 'styles';
+
+  // Base case
+  if (!variables.includes(declaratorName)) {
+    return declaratorName;
+  } else {
+    // If styles already exists, increment the number
+    while (variables.includes("".concat(declaratorName, "_").concat(count))) {
+      count++;
+    }
+  }
+  return "".concat(declaratorName, "_").concat(count);
+};
 function analyzeIdentifier(context, sourceIdentifier, configuration) {
   var _getIdentifierInParen, _getIdentifierInParen2;
   var scope = context.getScope();
@@ -47,11 +85,14 @@ function analyzeIdentifier(context, sourceIdentifier, configuration) {
     // When variable is declared inside the component
     context.report({
       node: sourceIdentifier,
-      messageId: configuration.stylesPlacement === 'bottom' ? 'cssAtBottomOfModule' : 'cssOnTopOfModule'
+      messageId: configuration.stylesPlacement === 'bottom' ? 'cssAtBottomOfModule' : 'cssOnTopOfModule',
+      fix: function fix(fixer) {
+        return fixCssNotInModuleScope(fixer, context, configuration, identifier);
+      }
     });
     return;
   }
-  if (identifier.parent && identifier.parent.init && !isCssCallExpression(identifier.parent.init, [].concat((0, _toConsumableArray2.default)(configuration.cssFunctions), ['cssMap']))) {
+  if (identifier.parent && identifier.parent.init && !isCssCallExpression(identifier.parent.init, configuration.cssFunctions)) {
     // When variable value is not of type css({})
     context.report({
       node: identifier,
@@ -71,13 +112,50 @@ function analyzeIdentifier(context, sourceIdentifier, configuration) {
   }
 }
 
+/**
+ * Fixer for the cssOnTopOfModule/cssAtBottomOfModule violation cases.
+ * This deals with Identifiers and Expressions passed from the traverseExpressionWithConfig() function.
+ * @param fixer The ESLint RuleFixer object
+ * @param context The context of the node
+ * @param configuration The configuration of the rule, determining whether the fix is implmeneted at the top or bottom of the module
+ * @param node Either an IdentifierWithParent node. Expression, or SpreadElement that we handle
+ * @param cssAttributeName An optional parameter only added when we fix an ObjectExpression
+ */
+var fixCssNotInModuleScope = function fixCssNotInModuleScope(fixer, context, configuration, node, cssAttributeName) {
+  var sourceCode = context.getSourceCode();
+  var topLevelNode = getTopLevelNode(node);
+  var moduleString;
+  var implementFixer = [];
+  if (node.type === 'Identifier') {
+    var identifier = node;
+    var declarator = identifier.parent.parent;
+    moduleString = sourceCode.getText(declarator);
+    implementFixer.push(fixer.remove(declarator));
+  } else {
+    var _declarator = getDeclaratorString(context);
+    var text = sourceCode.getText(node);
+
+    // If this has been passed, then we know it's an ObjectExpression
+    if (cssAttributeName) {
+      moduleString = "const ".concat(_declarator, " = ").concat(cssAttributeName, "(").concat(text, ");");
+    } else {
+      moduleString = moduleString = "const ".concat(_declarator, " = ").concat(text, ";");
+    }
+    implementFixer.push(fixer.replaceText(node, _declarator));
+  }
+  return [].concat(implementFixer, [
+  // Insert the node either before or after
+  configuration.stylesPlacement === 'bottom' ? fixer.insertTextAfter(topLevelNode, '\n' + moduleString) : fixer.insertTextBefore(topLevelNode, moduleString + '\n')]);
+};
+
 /**
  * Handle different cases based on what's been passed in the css-related JSXAttribute
  * @param context the context of the node
  * @param expression the expression of the JSXAttribute value
  * @param configuration what css-related functions to account for (eg. css, xcss, cssMap), and whether to detect bottom vs top expressions
+ * @param cssAttributeName used to encapsulate ObjectExpressions when cssOnTopOfModule/cssAtBottomOfModule violations are triggered
  */
-var traverseExpressionWithConfig = function traverseExpressionWithConfig(context, expression, configuration) {
+var traverseExpressionWithConfig = function traverseExpressionWithConfig(context, expression, configuration, cssAttributeName) {
   function traverseExpression(expression) {
     switch (expression.type) {
       case 'Identifier':
@@ -105,14 +183,24 @@ var traverseExpressionWithConfig = function traverseExpressionWithConfig(context
         traverseExpression(expression.consequent);
         traverseExpression(expression.alternate);
         break;
-      case 'CallExpression':
       case 'ObjectExpression':
+      case 'CallExpression':
       case 'TaggedTemplateExpression':
       case 'TemplateLiteral':
         // We've found elements that shouldn't be here! Report an error.
         context.report({
           node: expression,
-          messageId: configuration.stylesPlacement === 'bottom' ? 'cssAtBottomOfModule' : 'cssOnTopOfModule'
+          messageId: configuration.stylesPlacement === 'bottom' ? 'cssAtBottomOfModule' : 'cssOnTopOfModule',
+          fix: function fix(fixer) {
+            // Don't fix CallExpressions unless they're from cssFunctions or cssMap
+            if (expression.type === 'CallExpression' && !isCssCallExpression(expression, configuration.cssFunctions)) {
+              return [];
+            }
+            if (expression.type === 'ObjectExpression') {
+              return fixCssNotInModuleScope(fixer, context, configuration, expression, cssAttributeName);
+            }
+            return fixCssNotInModuleScope(fixer, context, configuration, expression);
+          }
         });
         break;
       default:
@@ -148,6 +236,7 @@ var rule = (0, _createRule.createLintRule)({
   create: function create(context) {
     var _ref3;
     var mergedConfig = (0, _assign.default)({}, defaultConfig, context.options[0]);
+    var declarationSuffix = 'Styles';
     var callSelectorFunctions = [].concat((0, _toConsumableArray2.default)(mergedConfig.cssFunctions), ['cssMap']);
     var callSelector = callSelectorFunctions.map(function (fn) {
       return "CallExpression[callee.name=".concat(fn, "]");
@@ -158,7 +247,7 @@ var rule = (0, _createRule.createLintRule)({
         return;
       }
       var identifier = node.parent.id;
-      if (identifier.type === 'Identifier' && identifier.name.endsWith(declarationSuffix)) {
+      if (identifier.type === 'Identifier' && (identifier.name.endsWith(declarationSuffix) || identifier.name.startsWith(declarationSuffix.toLowerCase() + '_') || identifier.name === declarationSuffix.toLowerCase())) {
         // Already prefixed! Nothing to do.
         return;
       }
@@ -196,7 +285,7 @@ var rule = (0, _createRule.createLintRule)({
           });
           return;
         }
-        traverseExpressionWithConfig(context, value.expression, mergedConfig);
+        traverseExpressionWithConfig(context, value.expression, mergedConfig, name.name);
       }
     }), _ref3;
   }

package/dist/es2019/rules/consistent-css-prop-usage/index.js

@@ -3,8 +3,8 @@
 import { getIdentifierInParentScope, isNodeOfType } from 'eslint-codemod-utils';
 import assign from 'lodash/assign';
 import { createLintRule } from '../utils/create-rule';
-const declarationSuffix = 'Styles';
 function isCssCallExpression(node, cssFunctions) {
+  cssFunctions = [...cssFunctions, 'cssMap'];
   return !!(isNodeOfType(node, 'CallExpression') && node.callee && node.callee.type === 'Identifier' && cssFunctions.includes(node.callee.name) && node.arguments.length && node.arguments[0].type === 'ObjectExpression');
 }
 function findSpreadProperties(node) {
@@ -13,6 +13,42 @@ function findSpreadProperties(node) {
   // @ts-ignore
   property.type === 'ExperimentalSpreadProperty');
 }
+const getTopLevelNode = expression => {
+  while (expression.parent.type !== 'Program') {
+    expression = expression.parent;
+  }
+  return expression;
+};
+
+// TODO: This can be optimised by implementing a fixer at the very end (Program:exit) and handling all validations at once
+/**
+ * Generates the declarator string when fixing the cssOnTopOfModule/cssAtBottomOfModule cases.
+ * When `styles` already exists, `styles_1, styles_2, ..., styles_X` are incrementally created for each unhoisted style.
+ * The generated `styles` varibale declaration names must be manually modified to be more informative at the discretion of owning teams.
+ */
+const getDeclaratorString = context => {
+  let scope = context.getScope();
+
+  // Get to ModuleScope
+  while (scope && scope.upper && scope.upper.type !== 'global') {
+    var _scope;
+    scope = (_scope = scope) === null || _scope === void 0 ? void 0 : _scope.upper;
+  }
+  const variables = scope.variables.map(variable => variable.name);
+  let count = 2;
+  let declaratorName = 'styles';
+
+  // Base case
+  if (!variables.includes(declaratorName)) {
+    return declaratorName;
+  } else {
+    // If styles already exists, increment the number
+    while (variables.includes(`${declaratorName}_${count}`)) {
+      count++;
+    }
+  }
+  return `${declaratorName}_${count}`;
+};
 function analyzeIdentifier(context, sourceIdentifier, configuration) {
   var _getIdentifierInParen, _getIdentifierInParen2;
   const scope = context.getScope();
@@ -33,11 +69,14 @@ function analyzeIdentifier(context, sourceIdentifier, configuration) {
     // When variable is declared inside the component
     context.report({
       node: sourceIdentifier,
-      messageId: configuration.stylesPlacement === 'bottom' ? 'cssAtBottomOfModule' : 'cssOnTopOfModule'
+      messageId: configuration.stylesPlacement === 'bottom' ? 'cssAtBottomOfModule' : 'cssOnTopOfModule',
+      fix: fixer => {
+        return fixCssNotInModuleScope(fixer, context, configuration, identifier);
+      }
     });
     return;
   }
-  if (identifier.parent && identifier.parent.init && !isCssCallExpression(identifier.parent.init, [...configuration.cssFunctions, 'cssMap'])) {
+  if (identifier.parent && identifier.parent.init && !isCssCallExpression(identifier.parent.init, configuration.cssFunctions)) {
     // When variable value is not of type css({})
     context.report({
       node: identifier,
@@ -57,13 +96,50 @@ function analyzeIdentifier(context, sourceIdentifier, configuration) {
   }
 }
 
+/**
+ * Fixer for the cssOnTopOfModule/cssAtBottomOfModule violation cases.
+ * This deals with Identifiers and Expressions passed from the traverseExpressionWithConfig() function.
+ * @param fixer The ESLint RuleFixer object
+ * @param context The context of the node
+ * @param configuration The configuration of the rule, determining whether the fix is implmeneted at the top or bottom of the module
+ * @param node Either an IdentifierWithParent node. Expression, or SpreadElement that we handle
+ * @param cssAttributeName An optional parameter only added when we fix an ObjectExpression
+ */
+const fixCssNotInModuleScope = (fixer, context, configuration, node, cssAttributeName) => {
+  const sourceCode = context.getSourceCode();
+  const topLevelNode = getTopLevelNode(node);
+  let moduleString;
+  let implementFixer = [];
+  if (node.type === 'Identifier') {
+    const identifier = node;
+    const declarator = identifier.parent.parent;
+    moduleString = sourceCode.getText(declarator);
+    implementFixer.push(fixer.remove(declarator));
+  } else {
+    const declarator = getDeclaratorString(context);
+    const text = sourceCode.getText(node);
+
+    // If this has been passed, then we know it's an ObjectExpression
+    if (cssAttributeName) {
+      moduleString = `const ${declarator} = ${cssAttributeName}(${text});`;
+    } else {
+      moduleString = moduleString = `const ${declarator} = ${text};`;
+    }
+    implementFixer.push(fixer.replaceText(node, declarator));
+  }
+  return [...implementFixer,
+  // Insert the node either before or after
+  configuration.stylesPlacement === 'bottom' ? fixer.insertTextAfter(topLevelNode, '\n' + moduleString) : fixer.insertTextBefore(topLevelNode, moduleString + '\n')];
+};
+
 /**
  * Handle different cases based on what's been passed in the css-related JSXAttribute
  * @param context the context of the node
  * @param expression the expression of the JSXAttribute value
  * @param configuration what css-related functions to account for (eg. css, xcss, cssMap), and whether to detect bottom vs top expressions
+ * @param cssAttributeName used to encapsulate ObjectExpressions when cssOnTopOfModule/cssAtBottomOfModule violations are triggered
  */
-const traverseExpressionWithConfig = (context, expression, configuration) => {
+const traverseExpressionWithConfig = (context, expression, configuration, cssAttributeName) => {
   function traverseExpression(expression) {
     switch (expression.type) {
       case 'Identifier':
@@ -89,14 +165,24 @@ const traverseExpressionWithConfig = (context, expression, configuration) => {
         traverseExpression(expression.consequent);
         traverseExpression(expression.alternate);
         break;
-      case 'CallExpression':
       case 'ObjectExpression':
+      case 'CallExpression':
       case 'TaggedTemplateExpression':
       case 'TemplateLiteral':
         // We've found elements that shouldn't be here! Report an error.
         context.report({
           node: expression,
-          messageId: configuration.stylesPlacement === 'bottom' ? 'cssAtBottomOfModule' : 'cssOnTopOfModule'
+          messageId: configuration.stylesPlacement === 'bottom' ? 'cssAtBottomOfModule' : 'cssOnTopOfModule',
+          fix: fixer => {
+            // Don't fix CallExpressions unless they're from cssFunctions or cssMap
+            if (expression.type === 'CallExpression' && !isCssCallExpression(expression, configuration.cssFunctions)) {
+              return [];
+            }
+            if (expression.type === 'ObjectExpression') {
+              return fixCssNotInModuleScope(fixer, context, configuration, expression, cssAttributeName);
+            }
+            return fixCssNotInModuleScope(fixer, context, configuration, expression);
+          }
         });
         break;
       default:
@@ -131,6 +217,7 @@ const rule = createLintRule({
   },
   create(context) {
     const mergedConfig = assign({}, defaultConfig, context.options[0]);
+    const declarationSuffix = 'Styles';
     const callSelectorFunctions = [...mergedConfig.cssFunctions, 'cssMap'];
     const callSelector = callSelectorFunctions.map(fn => `CallExpression[callee.name=${fn}]`).join(',');
     return {
@@ -140,7 +227,7 @@ const rule = createLintRule({
           return;
         }
         const identifier = node.parent.id;
-        if (identifier.type === 'Identifier' && identifier.name.endsWith(declarationSuffix)) {
+        if (identifier.type === 'Identifier' && (identifier.name.endsWith(declarationSuffix) || identifier.name.startsWith(declarationSuffix.toLowerCase() + '_') || identifier.name === declarationSuffix.toLowerCase())) {
           // Already prefixed! Nothing to do.
           return;
         }
@@ -177,7 +264,7 @@ const rule = createLintRule({
             });
             return;
           }
-          traverseExpressionWithConfig(context, value.expression, mergedConfig);
+          traverseExpressionWithConfig(context, value.expression, mergedConfig, name.name);
         }
       }
     };

package/dist/esm/rules/consistent-css-prop-usage/index.js

@@ -1,13 +1,13 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
-import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 // eslint-disable-next-line import/no-extraneous-dependencies
 
 import { getIdentifierInParentScope, isNodeOfType } from 'eslint-codemod-utils';
 import assign from 'lodash/assign';
 import { createLintRule } from '../utils/create-rule';
-var declarationSuffix = 'Styles';
 function isCssCallExpression(node, cssFunctions) {
+  cssFunctions = [].concat(_toConsumableArray(cssFunctions), ['cssMap']);
   return !!(isNodeOfType(node, 'CallExpression') && node.callee && node.callee.type === 'Identifier' && cssFunctions.includes(node.callee.name) && node.arguments.length && node.arguments[0].type === 'ObjectExpression');
 }
 function findSpreadProperties(node) {
@@ -18,6 +18,44 @@ function findSpreadProperties(node) {
     property.type === 'ExperimentalSpreadProperty';
   });
 }
+var getTopLevelNode = function getTopLevelNode(expression) {
+  while (expression.parent.type !== 'Program') {
+    expression = expression.parent;
+  }
+  return expression;
+};
+
+// TODO: This can be optimised by implementing a fixer at the very end (Program:exit) and handling all validations at once
+/**
+ * Generates the declarator string when fixing the cssOnTopOfModule/cssAtBottomOfModule cases.
+ * When `styles` already exists, `styles_1, styles_2, ..., styles_X` are incrementally created for each unhoisted style.
+ * The generated `styles` varibale declaration names must be manually modified to be more informative at the discretion of owning teams.
+ */
+var getDeclaratorString = function getDeclaratorString(context) {
+  var scope = context.getScope();
+
+  // Get to ModuleScope
+  while (scope && scope.upper && scope.upper.type !== 'global') {
+    var _scope;
+    scope = (_scope = scope) === null || _scope === void 0 ? void 0 : _scope.upper;
+  }
+  var variables = scope.variables.map(function (variable) {
+    return variable.name;
+  });
+  var count = 2;
+  var declaratorName = 'styles';
+
+  // Base case
+  if (!variables.includes(declaratorName)) {
+    return declaratorName;
+  } else {
+    // If styles already exists, increment the number
+    while (variables.includes("".concat(declaratorName, "_").concat(count))) {
+      count++;
+    }
+  }
+  return "".concat(declaratorName, "_").concat(count);
+};
 function analyzeIdentifier(context, sourceIdentifier, configuration) {
   var _getIdentifierInParen, _getIdentifierInParen2;
   var scope = context.getScope();
@@ -40,11 +78,14 @@ function analyzeIdentifier(context, sourceIdentifier, configuration) {
     // When variable is declared inside the component
     context.report({
       node: sourceIdentifier,
-      messageId: configuration.stylesPlacement === 'bottom' ? 'cssAtBottomOfModule' : 'cssOnTopOfModule'
+      messageId: configuration.stylesPlacement === 'bottom' ? 'cssAtBottomOfModule' : 'cssOnTopOfModule',
+      fix: function fix(fixer) {
+        return fixCssNotInModuleScope(fixer, context, configuration, identifier);
+      }
     });
     return;
   }
-  if (identifier.parent && identifier.parent.init && !isCssCallExpression(identifier.parent.init, [].concat(_toConsumableArray(configuration.cssFunctions), ['cssMap']))) {
+  if (identifier.parent && identifier.parent.init && !isCssCallExpression(identifier.parent.init, configuration.cssFunctions)) {
     // When variable value is not of type css({})
     context.report({
       node: identifier,
@@ -64,13 +105,50 @@ function analyzeIdentifier(context, sourceIdentifier, configuration) {
   }
 }
 
+/**
+ * Fixer for the cssOnTopOfModule/cssAtBottomOfModule violation cases.
+ * This deals with Identifiers and Expressions passed from the traverseExpressionWithConfig() function.
+ * @param fixer The ESLint RuleFixer object
+ * @param context The context of the node
+ * @param configuration The configuration of the rule, determining whether the fix is implmeneted at the top or bottom of the module
+ * @param node Either an IdentifierWithParent node. Expression, or SpreadElement that we handle
+ * @param cssAttributeName An optional parameter only added when we fix an ObjectExpression
+ */
+var fixCssNotInModuleScope = function fixCssNotInModuleScope(fixer, context, configuration, node, cssAttributeName) {
+  var sourceCode = context.getSourceCode();
+  var topLevelNode = getTopLevelNode(node);
+  var moduleString;
+  var implementFixer = [];
+  if (node.type === 'Identifier') {
+    var identifier = node;
+    var declarator = identifier.parent.parent;
+    moduleString = sourceCode.getText(declarator);
+    implementFixer.push(fixer.remove(declarator));
+  } else {
+    var _declarator = getDeclaratorString(context);
+    var text = sourceCode.getText(node);
+
+    // If this has been passed, then we know it's an ObjectExpression
+    if (cssAttributeName) {
+      moduleString = "const ".concat(_declarator, " = ").concat(cssAttributeName, "(").concat(text, ");");
+    } else {
+      moduleString = moduleString = "const ".concat(_declarator, " = ").concat(text, ";");
+    }
+    implementFixer.push(fixer.replaceText(node, _declarator));
+  }
+  return [].concat(implementFixer, [
+  // Insert the node either before or after
+  configuration.stylesPlacement === 'bottom' ? fixer.insertTextAfter(topLevelNode, '\n' + moduleString) : fixer.insertTextBefore(topLevelNode, moduleString + '\n')]);
+};
+
 /**
  * Handle different cases based on what's been passed in the css-related JSXAttribute
  * @param context the context of the node
  * @param expression the expression of the JSXAttribute value
  * @param configuration what css-related functions to account for (eg. css, xcss, cssMap), and whether to detect bottom vs top expressions
+ * @param cssAttributeName used to encapsulate ObjectExpressions when cssOnTopOfModule/cssAtBottomOfModule violations are triggered
  */
-var traverseExpressionWithConfig = function traverseExpressionWithConfig(context, expression, configuration) {
+var traverseExpressionWithConfig = function traverseExpressionWithConfig(context, expression, configuration, cssAttributeName) {
   function traverseExpression(expression) {
     switch (expression.type) {
       case 'Identifier':
@@ -98,14 +176,24 @@ var traverseExpressionWithConfig = function traverseExpressionWithConfig(context
         traverseExpression(expression.consequent);
         traverseExpression(expression.alternate);
         break;
-      case 'CallExpression':
       case 'ObjectExpression':
+      case 'CallExpression':
       case 'TaggedTemplateExpression':
       case 'TemplateLiteral':
         // We've found elements that shouldn't be here! Report an error.
         context.report({
           node: expression,
-          messageId: configuration.stylesPlacement === 'bottom' ? 'cssAtBottomOfModule' : 'cssOnTopOfModule'
+          messageId: configuration.stylesPlacement === 'bottom' ? 'cssAtBottomOfModule' : 'cssOnTopOfModule',
+          fix: function fix(fixer) {
+            // Don't fix CallExpressions unless they're from cssFunctions or cssMap
+            if (expression.type === 'CallExpression' && !isCssCallExpression(expression, configuration.cssFunctions)) {
+              return [];
+            }
+            if (expression.type === 'ObjectExpression') {
+              return fixCssNotInModuleScope(fixer, context, configuration, expression, cssAttributeName);
+            }
+            return fixCssNotInModuleScope(fixer, context, configuration, expression);
+          }
         });
         break;
       default:
@@ -141,6 +229,7 @@ var rule = createLintRule({
   create: function create(context) {
     var _ref3;
     var mergedConfig = assign({}, defaultConfig, context.options[0]);
+    var declarationSuffix = 'Styles';
     var callSelectorFunctions = [].concat(_toConsumableArray(mergedConfig.cssFunctions), ['cssMap']);
     var callSelector = callSelectorFunctions.map(function (fn) {
       return "CallExpression[callee.name=".concat(fn, "]");
@@ -151,7 +240,7 @@ var rule = createLintRule({
         return;
       }
       var identifier = node.parent.id;
-      if (identifier.type === 'Identifier' && identifier.name.endsWith(declarationSuffix)) {
+      if (identifier.type === 'Identifier' && (identifier.name.endsWith(declarationSuffix) || identifier.name.startsWith(declarationSuffix.toLowerCase() + '_') || identifier.name === declarationSuffix.toLowerCase())) {
         // Already prefixed! Nothing to do.
         return;
       }
@@ -189,7 +278,7 @@ var rule = createLintRule({
           });
           return;
         }
-        traverseExpressionWithConfig(context, value.expression, mergedConfig);
+        traverseExpressionWithConfig(context, value.expression, mergedConfig, name.name);
       }
     }), _ref3;
   }

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": "8.21.0",
+  "version": "8.22.0",
   "author": "Atlassian Pty Ltd",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -55,6 +55,7 @@
     "@types/eslint": "^8.4.5",
     "eslint": "^7.7.0",
     "jscodeshift": "^0.13.0",
+    "outdent": "^0.5.0",
     "prettier": "^2.8.0",
     "react": "^16.8.0",
     "ts-jest": "26.5.6",