@elastic/eslint-plugin-eui 2.5.0 → 2.6.0

package/README.md

@@ -160,8 +160,13 @@ Ensure that appropriate aria-attributes are set for `EuiBetaBadge`, `EuiButtonIc
 Ensure `EuiTooltip` components are anchored to elements that can receive keyboard focus, making them accessible to all users. When using non-interactive elements (like `span`or `EuiText`) as tooltip anchors, they must include `tabIndex={0}` to be keyboard-focusable. For better accessibility, prefer using semantic interactive components (like `EuiButton` or `EuiLink`) which are focusable by default.
 
 ### `@elastic/eui/accessible-interactive-element`
+
 Ensure interactive EUI components (like e.g. `EuiLink`, `EuiButton`, `EuiRadio`) remain accessible by prohibiting `tabIndex={-1}`, which removes them from keyboard navigation.
 
+### `@elastic/eui/require-table-caption`
+
+Ensure `EuiInMemoryTable`, `EuiBasicTable` have a `tableCaption` property for accessibility.
+
 ## Testing
 
 ### Running unit tests

package/lib/cjs/index.js

@@ -12,6 +12,7 @@ var _no_unnamed_interactive_element = require("./rules/a11y/no_unnamed_interacti
 var _tooltip_focusable_anchor = require("./rules/a11y/tooltip_focusable_anchor");
 var _callout_announce_on_mount = require("./rules/a11y/callout_announce_on_mount");
 var _accessible_interactive_element = require("./rules/a11y/accessible_interactive_element");
+var _require_table_caption = require("./rules/a11y/require_table_caption");
 /*
  * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
  * or more contributor license agreements. Licensed under the Elastic License
@@ -33,7 +34,8 @@ const config = {
     'callout-announce-on-mount': _callout_announce_on_mount.CallOutAnnounceOnMount,
     'no-unnamed-interactive-element': _no_unnamed_interactive_element.NoUnnamedInteractiveElement,
     'tooltip-focusable-anchor': _tooltip_focusable_anchor.TooltipFocusableAnchor,
-    'accessible-interactive-element': _accessible_interactive_element.AccessibleInteractiveElements
+    'accessible-interactive-element': _accessible_interactive_element.AccessibleInteractiveElements,
+    'require-table-caption': _require_table_caption.RequireTableCaption
   },
   configs: {
     recommended: {
@@ -50,7 +52,8 @@ const config = {
         '@elastic/eui/callout-announce-on-mount': 'warn',
         '@elastic/eui/no-unnamed-interactive-element': 'warn',
         '@elastic/eui/tooltip-focusable-anchor': 'warn',
-        '@elastic/eui/accessible-interactive-element': 'warn'
+        '@elastic/eui/accessible-interactive-element': 'warn',
+        '@elastic/eui/require-table-caption': 'warn'
       }
     }
   }

package/lib/cjs/rules/a11y/require_table_caption.d.ts

@@ -0,0 +1,3 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+export declare const RequireTableCaption: ESLintUtils.RuleModule<"missingTableCaption", [], unknown, ESLintUtils.RuleListener>;
+//# sourceMappingURL=require_table_caption.d.ts.map

package/lib/cjs/rules/a11y/require_table_caption.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"require_table_caption.d.ts","sourceRoot":"","sources":["../../../../src/rules/a11y/require_table_caption.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,WAAW,EAAiB,MAAM,0BAA0B,CAAC;AAKtE,eAAO,MAAM,mBAAmB,sFA+C9B,CAAC"}

package/lib/cjs/rules/a11y/require_table_caption.js

@@ -0,0 +1,53 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.RequireTableCaption = void 0;
+var _utils = require("@typescript-eslint/utils");
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+const TABLE_COMPONENTS = ['EuiInMemoryTable', 'EuiBasicTable'];
+const TABLE_CAPTION_PROP = 'tableCaption';
+const RequireTableCaption = exports.RequireTableCaption = _utils.ESLintUtils.RuleCreator.withoutDocs({
+  create(context) {
+    return {
+      JSXOpeningElement(node) {
+        if (node.name.type !== 'JSXIdentifier') {
+          return;
+        }
+        const component = node.name.name;
+        if (!TABLE_COMPONENTS.includes(component)) {
+          return;
+        }
+        const hasTableCaption = node.attributes.some(attr => attr.type === 'JSXAttribute' && attr.name.type === 'JSXIdentifier' && attr.name.name === TABLE_CAPTION_PROP);
+        if (!hasTableCaption) {
+          context.report({
+            node,
+            messageId: 'missingTableCaption',
+            data: {
+              component
+            }
+          });
+        }
+      }
+    };
+  },
+  defaultOptions: [],
+  meta: {
+    type: 'problem',
+    docs: {
+      description: `Ensure ${TABLE_COMPONENTS.join(', ')} have a \`${TABLE_CAPTION_PROP}\` prop for accessibility.`
+    },
+    schema: [],
+    messages: {
+      missingTableCaption: ['{{component}} must include a `tableCaption` prop for accessibility.', '', 'Example:', '  <{{component}} tableCaption="Descriptive caption for the table" ... />'].join('\n')
+    }
+  }
+});

package/lib/esm/index.js

@@ -19,6 +19,7 @@ const no_unnamed_interactive_element_1 = require("./rules/a11y/no_unnamed_intera
 const tooltip_focusable_anchor_1 = require("./rules/a11y/tooltip_focusable_anchor");
 const callout_announce_on_mount_1 = require("./rules/a11y/callout_announce_on_mount");
 const accessible_interactive_element_1 = require("./rules/a11y/accessible_interactive_element");
+const require_table_caption_1 = require("./rules/a11y/require_table_caption");
 const config = {
     rules: {
         'href-or-on-click': href_or_on_click_1.HrefOnClick,
@@ -33,6 +34,7 @@ const config = {
         'no-unnamed-interactive-element': no_unnamed_interactive_element_1.NoUnnamedInteractiveElement,
         'tooltip-focusable-anchor': tooltip_focusable_anchor_1.TooltipFocusableAnchor,
         'accessible-interactive-element': accessible_interactive_element_1.AccessibleInteractiveElements,
+        'require-table-caption': require_table_caption_1.RequireTableCaption,
     },
     configs: {
         recommended: {
@@ -50,6 +52,7 @@ const config = {
                 '@elastic/eui/no-unnamed-interactive-element': 'warn',
                 '@elastic/eui/tooltip-focusable-anchor': 'warn',
                 '@elastic/eui/accessible-interactive-element': 'warn',
+                '@elastic/eui/require-table-caption': 'warn',
             },
         },
     },

package/lib/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;AAGH,+DAAuD;AACvD,iFAA2E;AAC3E,uDAAkD;AAElD,8FAAuF;AACvF,0FAAoF;AACpF,wFAA4F;AAC5F,0EAAoE;AACpE,gFAA0E;AAC1E,gGAA0F;AAC1F,oFAA+E;AAC/E,sFAAgF;AAChF,gGAA4F;AAE5F,MAAM,MAAM,GAAG;IACb,KAAK,EAAE;QACL,kBAAkB,EAAE,8BAAW;QAC/B,2BAA2B,EAAE,kDAAsB;QACnD,cAAc,EAAE,yBAAU;QAC1B,+BAA+B,EAAE,yDAAyB;QAC1D,6BAA6B,EAAE,sDAAwB;QACvD,4BAA4B,EAAE,8DAAiC;QAC/D,qBAAqB,EAAE,sCAAgB;QACvC,wBAAwB,EAAG,4CAAmB;QAC9C,2BAA2B,EAAE,kDAAsB;QACnD,gCAAgC,EAAE,4DAA2B;QAC7D,0BAA0B,EAAE,iDAAsB;QAClD,gCAAgC,EAAE,8DAA6B;KAChE;IACD,OAAO,EAAE;QACP,WAAW,EAAE;YACX,OAAO,EAAE,CAAC,4BAA4B,CAAC;YACvC,KAAK,EAAE;gBACL,+BAA+B,EAAE,MAAM;gBACvC,wCAAwC,EAAE,MAAM;gBAChD,2BAA2B,EAAE,MAAM;gBACnC,4CAA4C,EAAE,MAAM;gBACpD,0CAA0C,EAAE,MAAM;gBAClD,yCAAyC,EAAE,MAAM;gBACjD,kCAAkC,EAAE,MAAM;gBAC1C,qCAAqC,EAAE,MAAM;gBAC7C,wCAAwC,EAAE,MAAM;gBAChD,6CAA6C,EAAE,MAAM;gBACrD,uCAAuC,EAAE,MAAM;gBAC/C,6CAA6C,EAAE,MAAM;aACtD;SACF;KACF;CACF,CAAC;AAEF,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;AAGH,+DAAuD;AACvD,iFAA2E;AAC3E,uDAAkD;AAElD,8FAAuF;AACvF,0FAAoF;AACpF,wFAA4F;AAC5F,0EAAoE;AACpE,gFAA0E;AAC1E,gGAA0F;AAC1F,oFAA+E;AAC/E,sFAAgF;AAChF,gGAA4F;AAC5F,8EAAyE;AAEzE,MAAM,MAAM,GAAG;IACb,KAAK,EAAE;QACL,kBAAkB,EAAE,8BAAW;QAC/B,2BAA2B,EAAE,kDAAsB;QACnD,cAAc,EAAE,yBAAU;QAC1B,+BAA+B,EAAE,yDAAyB;QAC1D,6BAA6B,EAAE,sDAAwB;QACvD,4BAA4B,EAAE,8DAAiC;QAC/D,qBAAqB,EAAE,sCAAgB;QACvC,wBAAwB,EAAG,4CAAmB;QAC9C,2BAA2B,EAAE,kDAAsB;QACnD,gCAAgC,EAAE,4DAA2B;QAC7D,0BAA0B,EAAE,iDAAsB;QAClD,gCAAgC,EAAE,8DAA6B;QAC/D,uBAAuB,EAAE,2CAAmB;KAC7C;IACD,OAAO,EAAE;QACP,WAAW,EAAE;YACX,OAAO,EAAE,CAAC,4BAA4B,CAAC;YACvC,KAAK,EAAE;gBACL,+BAA+B,EAAE,MAAM;gBACvC,wCAAwC,EAAE,MAAM;gBAChD,2BAA2B,EAAE,MAAM;gBACnC,4CAA4C,EAAE,MAAM;gBACpD,0CAA0C,EAAE,MAAM;gBAClD,yCAAyC,EAAE,MAAM;gBACjD,kCAAkC,EAAE,MAAM;gBAC1C,qCAAqC,EAAE,MAAM;gBAC7C,wCAAwC,EAAE,MAAM;gBAChD,6CAA6C,EAAE,MAAM;gBACrD,uCAAuC,EAAE,MAAM;gBAC/C,6CAA6C,EAAE,MAAM;gBACrD,oCAAoC,EAAE,MAAM;aAC7C;SACF;KACF;CACF,CAAC;AAEF,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC"}

package/lib/esm/rules/a11y/require_table_caption.d.ts

@@ -0,0 +1,2 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+export declare const RequireTableCaption: ESLintUtils.RuleModule<"missingTableCaption", [], unknown, ESLintUtils.RuleListener>;

package/lib/esm/rules/a11y/require_table_caption.js

@@ -0,0 +1,55 @@
+"use strict";
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequireTableCaption = void 0;
+const utils_1 = require("@typescript-eslint/utils");
+const TABLE_COMPONENTS = ['EuiInMemoryTable', 'EuiBasicTable'];
+const TABLE_CAPTION_PROP = 'tableCaption';
+exports.RequireTableCaption = utils_1.ESLintUtils.RuleCreator.withoutDocs({
+    create(context) {
+        return {
+            JSXOpeningElement(node) {
+                if (node.name.type !== 'JSXIdentifier') {
+                    return;
+                }
+                const component = node.name.name;
+                if (!TABLE_COMPONENTS.includes(component)) {
+                    return;
+                }
+                const hasTableCaption = node.attributes.some((attr) => attr.type === 'JSXAttribute' &&
+                    attr.name.type === 'JSXIdentifier' &&
+                    attr.name.name === TABLE_CAPTION_PROP);
+                if (!hasTableCaption) {
+                    context.report({
+                        node,
+                        messageId: 'missingTableCaption',
+                        data: { component }
+                    });
+                }
+            },
+        };
+    },
+    defaultOptions: [],
+    meta: {
+        type: 'problem',
+        docs: {
+            description: `Ensure ${TABLE_COMPONENTS.join(', ')} have a \`${TABLE_CAPTION_PROP}\` prop for accessibility.`,
+        },
+        schema: [],
+        messages: {
+            missingTableCaption: [
+                '{{component}} must include a `tableCaption` prop for accessibility.',
+                '',
+                'Example:',
+                '  <{{component}} tableCaption="Descriptive caption for the table" ... />',
+            ].join('\n'),
+        },
+    },
+});
+//# sourceMappingURL=require_table_caption.js.map

package/lib/esm/rules/a11y/require_table_caption.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"require_table_caption.js","sourceRoot":"","sources":["../../../../src/rules/a11y/require_table_caption.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAEH,oDAAsE;AAEtE,MAAM,gBAAgB,GAAG,CAAC,kBAAkB,EAAE,eAAe,CAAC,CAAC;AAC/D,MAAM,kBAAkB,GAAG,cAAc,CAAC;AAE7B,QAAA,mBAAmB,GAAG,mBAAW,CAAC,WAAW,CAAC,WAAW,CAAC;IACrE,MAAM,CAAC,OAAO;QACZ,OAAO;YACL,iBAAiB,CAAC,IAAgC;gBAChD,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;oBACvC,OAAO;gBACT,CAAC;gBAED,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBAEjC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC1C,OAAO;gBACT,CAAC;gBAED,MAAM,eAAe,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAC1C,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,CAAC,IAAI,KAAK,cAAc;oBAC5B,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,eAAe;oBAClC,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,kBAAkB,CACxC,CAAC;gBAEF,IAAI,CAAC,eAAe,EAAE,CAAC;oBACrB,OAAO,CAAC,MAAM,CAAC;wBACb,IAAI;wBACJ,SAAS,EAAE,qBAAqB;wBAChC,IAAI,EAAE,EAAE,SAAS,EAAE;qBACpB,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;IACD,cAAc,EAAE,EAAE;IAClB,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EAAE,UAAU,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,kBAAkB,4BAA4B;SAC9G;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,mBAAmB,EAAE;gBACnB,qEAAqE;gBACrE,EAAE;gBACF,UAAU;gBACV,0EAA0E;aAC3E,CAAC,IAAI,CAAC,IAAI,CAAC;SACb;KACF;CACF,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elastic/eslint-plugin-eui",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -43,7 +43,8 @@
     "typescript": "^5.8.3"
   },
   "scripts": {
-    "test": "jest src",
+    "test": "yarn test-unit",
+    "test-unit": "jest src",
     "build": "yarn build:clean && yarn build:compile && yarn build:compile:esm && yarn build:types",
     "build:clean": "rimraf lib/",
     "build:compile:esm": "tsc --project ./tsconfig.esm.json",