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

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @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
+
+- [#66250](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/66250) [`6ff74a16aee7`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/6ff74a16aee7) - Introducing new rule to encourage adding/referencing accessible name to a ButtonGroup component.
+
 ## 8.20.0
 
 ### Minor Changes

package/README.md

@@ -65,6 +65,7 @@ module.exports = {
 | <a href="./src/rules/no-unsafe-style-overrides/README.md">no-unsafe-style-overrides</a>                           | Discourage usage of unsafe style overrides used against the Atlassian Design System.                                                                                                                                                                                                                                | Yes         |         |             |
 | <a href="./src/rules/no-unsupported-drag-and-drop-libraries/README.md">no-unsupported-drag-and-drop-libraries</a> | Disallow importing unsupported drag and drop modules.                                                                                                                                                                                                                                                               | Yes         |         |             |
 | <a href="./src/rules/prefer-primitives/README.md">prefer-primitives</a>                                           | Increase awareness of primitive components via code hints. Strictly used for education purposes and discoverability. To enforce usage please refer to the `use-primitives` rule.                                                                                                                                    |             |         |             |
+| <a href="./src/rules/use-button-group-label/README.md">use-button-group-label</a>                                 | Ensures button groups are described to assistive technology by a direct label or by another element.                                                                                                                                                                                                                | Yes         |         | Yes         |
 | <a href="./src/rules/use-drawer-label/README.md">use-drawer-label</a>                                             | Encourages to provide accessible name for Atlassian Design System Drawer component.                                                                                                                                                                                                                                 | Yes         |         | Yes         |
 | <a href="./src/rules/use-heading-level-in-spotlight-card/README.md">use-heading-level-in-spotlight-card</a>       | Inform developers of eventual requirement of `headingLevel` prop in `SpotlightCard` component. The heading level should be the appropriate level according to the surrounding context.                                                                                                                              | Yes         | Yes     |             |
 | <a href="./src/rules/use-href-in-link-item/README.md">use-href-in-link-item</a>                                   | Inform developers of eventual requirement of `href` prop in `LinkItem` component. Elements with a `link` role require an `href` attribute for users to properly navigate, particularly those using assistive technologies. If no valid `href` is required for your use case, consider using a `ButtonItem` instead. | Yes         | Yes     | Yes         |

package/constellation/index/usage.mdx

@@ -29,6 +29,7 @@ This plugin contains rules that should be used when working with the [Atlassian
 | <a href="#no-unsafe-style-overrides">no-unsafe-style-overrides</a>                           | Discourage usage of unsafe style overrides used against the Atlassian Design System.                                                                                                                                                                                                                                | Yes         |         |             |
 | <a href="#no-unsupported-drag-and-drop-libraries">no-unsupported-drag-and-drop-libraries</a> | Disallow importing unsupported drag and drop modules.                                                                                                                                                                                                                                                               | Yes         |         |             |
 | <a href="#prefer-primitives">prefer-primitives</a>                                           | Increase awareness of primitive components via code hints. Strictly used for education purposes and discoverability. To enforce usage please refer to the `use-primitives` rule.                                                                                                                                    |             |         |             |
+| <a href="#use-button-group-label">use-button-group-label</a>                                 | Ensures button groups are described to assistive technology by a direct label or by another element.                                                                                                                                                                                                                | Yes         |         | Yes         |
 | <a href="#use-drawer-label">use-drawer-label</a>                                             | Encourages to provide accessible name for Atlassian Design System Drawer component.                                                                                                                                                                                                                                 | Yes         |         | Yes         |
 | <a href="#use-heading-level-in-spotlight-card">use-heading-level-in-spotlight-card</a>       | Inform developers of eventual requirement of `headingLevel` prop in `SpotlightCard` component. The heading level should be the appropriate level according to the surrounding context.                                                                                                                              | Yes         | Yes     |             |
 | <a href="#use-href-in-link-item">use-href-in-link-item</a>                                   | Inform developers of eventual requirement of `href` prop in `LinkItem` component. Elements with a `link` role require an `href` attribute for users to properly navigate, particularly those using assistive technologies. If no valid `href` is required for your use case, consider using a `ButtonItem` instead. | Yes         | Yes     | Yes         |
@@ -65,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>;
@@ -72,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
@@ -83,6 +88,8 @@ function Button({ children }) {
 }
 ```
 
+**Importing styles from another file.**
+
 ```js
 import { container } from './styles';
          ^^^^^^^^^ styles should be local, not shared
@@ -92,6 +99,8 @@ function Button({ children }) {
 }
 ```
 
+**Nesting styles with objects instead of arrays.**
+
 ```js
 const baseContainerStyles = css({
   zIndex: 5,
@@ -110,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,
@@ -120,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,
 });
@@ -128,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>
@@ -767,6 +817,65 @@ This rule marks code as violations when it may be able to be replaced with a pri
 </Component>
 ```
 
+## use-button-group-label
+
+ButtonGroup should have an accessible name or a reference to it, so that upon opening, users of assistive technologies could have contextual information of interaction with current element.
+
+<h3>Examples</h3>
+
+This rule will indicate user with warning to strongly recommend usage of either `label` or `titleId` prop.
+
+#### Incorrect
+
+```tsx
+<ButtonGroup>
+ ^^^^^^^^^^^ Missing either `label` or `titleId` prop.
+  <Button>Save</Button>
+  <Button>Edit</Button>
+  <Button>Delete</Button>
+</ButtonGroup>
+
+<ButtonGroup label="">
+             ^^^^^ `label` prop is missing accessible name value.
+  <Button>Save</Button>
+  <Button>Edit</Button>
+  <Button>Delete</Button>
+</ButtonGroup>
+
+<h2 id="button-group-title">ButtonGroup content title</hi>
+<ButtonGroup titleId="">
+             ^^^^^^^ `titleId` prop is missing reference value.
+  <Button>Save</Button>
+  <Button>Edit</Button>
+  <Button>Delete</Button>
+</ButtonGroup>
+
+<h2 id="button-group-title">ButtonGroup content title</h2>
+<ButtonGroup titleId="button-group-title" label="">
+             ^^^^^^^                      ^^^^^ Do not include both `titleId` and `label` properties. Use `titleId` if the label text is available in the DOM to reference it, otherwise use `label` to provide accessible name explicitly.
+  <Button>Save</Button>
+  <Button>Edit</Button>
+  <Button>Delete</Button>
+</ButtonGroup>
+```
+
+#### Correct
+
+```tsx
+<ButtonGroup label="ButtonGroup content title">
+  <Button>Save</Button>
+  <Button>Edit</Button>
+  <Button>Delete</Button>
+</ButtonGroup>
+
+<h2 id="button-group-title">ButtonGroup content title</h2>
+<ButtonGroup titleId="button-group-title">
+  <Button>Save</Button>
+  <Button>Edit</Button>
+  <Button>Delete</Button>
+</ButtonGroup>
+```
+
 ## use-drawer-label
 
 Drawer should have an accessible name or a reference to it, so that upon opening, users of assistive technologies could have contextual information of interaction with current element.

package/dist/cjs/presets/all.codegen.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::6efa1e48692b3e287d6dfcd500a5f0ab>>
+ * @codegen <<SignedSource::d1a459e1ea71650f65b2890dc86cc398>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 var _default = exports.default = {
@@ -28,6 +28,7 @@ var _default = exports.default = {
     '@atlaskit/design-system/no-unsafe-style-overrides': 'warn',
     '@atlaskit/design-system/no-unsupported-drag-and-drop-libraries': 'error',
     '@atlaskit/design-system/prefer-primitives': 'warn',
+    '@atlaskit/design-system/use-button-group-label': 'warn',
     '@atlaskit/design-system/use-drawer-label': 'warn',
     '@atlaskit/design-system/use-heading-level-in-spotlight-card': 'warn',
     '@atlaskit/design-system/use-href-in-link-item': 'warn',

package/dist/cjs/presets/recommended.codegen.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::be810d87ec2d253e3b053dc06ff1b99a>>
+ * @codegen <<SignedSource::3b93cfbbe0ea14514b9600509632394b>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 var _default = exports.default = {
@@ -23,6 +23,7 @@ var _default = exports.default = {
     '@atlaskit/design-system/no-unsafe-design-token-usage': 'error',
     '@atlaskit/design-system/no-unsafe-style-overrides': 'warn',
     '@atlaskit/design-system/no-unsupported-drag-and-drop-libraries': 'error',
+    '@atlaskit/design-system/use-button-group-label': 'warn',
     '@atlaskit/design-system/use-drawer-label': 'warn',
     '@atlaskit/design-system/use-heading-level-in-spotlight-card': 'warn',
     '@atlaskit/design-system/use-href-in-link-item': 'warn',

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/cjs/rules/index.codegen.js

@@ -21,6 +21,7 @@ var _noUnsafeDesignTokenUsage = _interopRequireDefault(require("./no-unsafe-desi
 var _noUnsafeStyleOverrides = _interopRequireDefault(require("./no-unsafe-style-overrides"));
 var _noUnsupportedDragAndDropLibraries = _interopRequireDefault(require("./no-unsupported-drag-and-drop-libraries"));
 var _preferPrimitives = _interopRequireDefault(require("./prefer-primitives"));
+var _useButtonGroupLabel = _interopRequireDefault(require("./use-button-group-label"));
 var _useDrawerLabel = _interopRequireDefault(require("./use-drawer-label"));
 var _useHeadingLevelInSpotlightCard = _interopRequireDefault(require("./use-heading-level-in-spotlight-card"));
 var _useHrefInLinkItem = _interopRequireDefault(require("./use-href-in-link-item"));
@@ -28,7 +29,7 @@ var _usePrimitives = _interopRequireDefault(require("./use-primitives"));
 var _useVisuallyHidden = _interopRequireDefault(require("./use-visually-hidden"));
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::ab1f5b129d07027c228dbd79da5f3572>>
+ * @codegen <<SignedSource::14cdfdcbd8b999ee097a1a5b245d7117>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 var _default = exports.default = {
@@ -48,6 +49,7 @@ var _default = exports.default = {
   'no-unsafe-style-overrides': _noUnsafeStyleOverrides.default,
   'no-unsupported-drag-and-drop-libraries': _noUnsupportedDragAndDropLibraries.default,
   'prefer-primitives': _preferPrimitives.default,
+  'use-button-group-label': _useButtonGroupLabel.default,
   'use-drawer-label': _useDrawerLabel.default,
   'use-heading-level-in-spotlight-card': _useHeadingLevelInSpotlightCard.default,
   'use-href-in-link-item': _useHrefInLinkItem.default,

package/dist/cjs/rules/use-button-group-label/index.js

@@ -0,0 +1,83 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _eslintCodemodUtils = require("eslint-codemod-utils");
+var _createRule = require("../utils/create-rule");
+// eslint-disable-next-line import/no-extraneous-dependencies
+
+var elementsAccessibleNameProps = ['label', 'titleId'];
+var rule = (0, _createRule.createLintRule)({
+  meta: {
+    name: 'use-button-group-label',
+    type: 'suggestion',
+    docs: {
+      description: 'Ensures button groups are described to assistive technology by a direct label or by another element.',
+      recommended: true,
+      severity: 'warn'
+    },
+    messages: {
+      missingLabelProp: 'Missing accessible name. If there is no visible content to associate use `label` prop, otherwise pass id of element to `titleId` prop to be associated as label.',
+      labelPropShouldHaveContents: 'Define string that labels the interactive element.',
+      titleIdShouldHaveValue: '`titleId` should reference the id of element that define accessible name.',
+      noBothPropsUsage: 'Do not include both `titleId` and `label` properties. Use `titleId` if the label text is available in the DOM to reference it, otherwise use `label` to provide accessible name explicitly.'
+    },
+    hasSuggestions: true
+  },
+  create: function create(context) {
+    var contextLocalIdentifier = [];
+    return {
+      ImportDeclaration: function ImportDeclaration(node) {
+        if (node.source.value === '@atlaskit/button') {
+          if (node.specifiers.length) {
+            var defaultImport = node.specifiers.filter(function (spec) {
+              return spec.type === 'ImportSpecifier';
+            });
+            if (defaultImport && defaultImport.length) {
+              var local = defaultImport[0].local;
+              contextLocalIdentifier.push(local.name);
+            }
+          }
+        }
+      },
+      JSXElement: function JSXElement(node) {
+        if (!(0, _eslintCodemodUtils.isNodeOfType)(node, 'JSXElement')) {
+          return;
+        }
+        if (!(0, _eslintCodemodUtils.isNodeOfType)(node.openingElement.name, 'JSXIdentifier')) {
+          return;
+        }
+        var name = node.openingElement.name.name;
+        if (contextLocalIdentifier.includes(name)) {
+          var componentLabelProps = node.openingElement.attributes.filter(function (attr) {
+            return (0, _eslintCodemodUtils.isNodeOfType)(attr, 'JSXAttribute') && (0, _eslintCodemodUtils.isNodeOfType)(attr.name, 'JSXIdentifier') && elementsAccessibleNameProps.includes(attr.name.name);
+          });
+          if (componentLabelProps.length === 1) {
+            var prop = componentLabelProps[0];
+            if ('value' in prop && prop.value) {
+              if ((0, _eslintCodemodUtils.isNodeOfType)(prop.value, 'Literal') && !prop.value.value || (0, _eslintCodemodUtils.isNodeOfType)(prop.value, 'JSXExpressionContainer') && !prop.value.expression) {
+                context.report({
+                  node: prop,
+                  messageId: prop.name.name === 'label' ? 'labelPropShouldHaveContents' : 'titleIdShouldHaveValue'
+                });
+              }
+            }
+          } else if (componentLabelProps.length > 1) {
+            context.report({
+              node: node.openingElement,
+              messageId: 'noBothPropsUsage'
+            });
+          } else {
+            context.report({
+              node: node.openingElement,
+              messageId: 'missingLabelProp'
+            });
+          }
+        }
+      }
+    };
+  }
+});
+var _default = exports.default = rule;

package/dist/es2019/presets/all.codegen.js

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::6efa1e48692b3e287d6dfcd500a5f0ab>>
+ * @codegen <<SignedSource::d1a459e1ea71650f65b2890dc86cc398>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 export default {
@@ -22,6 +22,7 @@ export default {
     '@atlaskit/design-system/no-unsafe-style-overrides': 'warn',
     '@atlaskit/design-system/no-unsupported-drag-and-drop-libraries': 'error',
     '@atlaskit/design-system/prefer-primitives': 'warn',
+    '@atlaskit/design-system/use-button-group-label': 'warn',
     '@atlaskit/design-system/use-drawer-label': 'warn',
     '@atlaskit/design-system/use-heading-level-in-spotlight-card': 'warn',
     '@atlaskit/design-system/use-href-in-link-item': 'warn',

package/dist/es2019/presets/recommended.codegen.js

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::be810d87ec2d253e3b053dc06ff1b99a>>
+ * @codegen <<SignedSource::3b93cfbbe0ea14514b9600509632394b>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 export default {
@@ -17,6 +17,7 @@ export default {
     '@atlaskit/design-system/no-unsafe-design-token-usage': 'error',
     '@atlaskit/design-system/no-unsafe-style-overrides': 'warn',
     '@atlaskit/design-system/no-unsupported-drag-and-drop-libraries': 'error',
+    '@atlaskit/design-system/use-button-group-label': 'warn',
     '@atlaskit/design-system/use-drawer-label': 'warn',
     '@atlaskit/design-system/use-heading-level-in-spotlight-card': 'warn',
     '@atlaskit/design-system/use-href-in-link-item': 'warn',