@atlaskit/eslint-plugin-design-system 9.5.2 → 9.7.0

package/dist/esm/rules/use-popup-label/index.js

@@ -0,0 +1,84 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+
+import { isNodeOfType } from 'eslint-codemod-utils';
+import { createLintRule } from '../utils/create-rule';
+var elementsAccessibleNameProps = ['label', 'titleId'];
+var rule = createLintRule({
+  meta: {
+    name: 'use-popup-label',
+    type: 'suggestion',
+    docs: {
+      description: 'Encourages to provide accessible name for Atlassian Design System Popup component.',
+      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/popup') {
+          if (node.specifiers.length) {
+            var defaultImport = node.specifiers.filter(function (spec) {
+              return spec.type === 'ImportDefaultSpecifier';
+            });
+            if (defaultImport.length) {
+              var local = defaultImport[0].local;
+              contextLocalIdentifier.push(local.name);
+            }
+          }
+        }
+      },
+      JSXElement: function JSXElement(node) {
+        if (!isNodeOfType(node, 'JSXElement')) {
+          return;
+        }
+        if (!isNodeOfType(node.openingElement.name, 'JSXIdentifier')) {
+          return;
+        }
+        var name = node.openingElement.name.name;
+        if (contextLocalIdentifier.includes(name)) {
+          var componentRoleDialogProp = node.openingElement.attributes.find(function (attr) {
+            return isNodeOfType(attr, 'JSXAttribute') && isNodeOfType(attr.name, 'JSXIdentifier') && attr.value && isNodeOfType(attr.value, 'Literal') && attr.name.name === 'role' && attr.value.value === 'dialog';
+          });
+          var componentLabelProps = node.openingElement.attributes.filter(function (attr) {
+            return isNodeOfType(attr, 'JSXAttribute') && isNodeOfType(attr.name, 'JSXIdentifier') && elementsAccessibleNameProps.includes(attr.name.name);
+          });
+          if (componentLabelProps.length === 1) {
+            var prop = componentLabelProps[0];
+            if ('value' in prop && prop.value) {
+              if (isNodeOfType(prop.value, 'Literal') && !prop.value.value || 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 {
+            if (componentRoleDialogProp) {
+              context.report({
+                node: node.openingElement,
+                messageId: 'missingLabelProp'
+              });
+            } else {
+              return;
+            }
+          }
+        }
+      }
+    };
+  }
+});
+export default rule;

package/dist/types/index.codegen.d.ts

@@ -32,6 +32,7 @@ export declare const configs: {
             '@atlaskit/design-system/use-heading': string;
             '@atlaskit/design-system/use-heading-level-in-spotlight-card': string;
             '@atlaskit/design-system/use-href-in-link-item': string;
+            '@atlaskit/design-system/use-popup-label': string;
             '@atlaskit/design-system/use-primitives': string;
             '@atlaskit/design-system/use-primitives-text': string;
             '@atlaskit/design-system/use-tokens-space': string;
@@ -62,6 +63,7 @@ export declare const configs: {
             '@atlaskit/design-system/use-drawer-label': string;
             '@atlaskit/design-system/use-heading-level-in-spotlight-card': string;
             '@atlaskit/design-system/use-href-in-link-item': string;
+            '@atlaskit/design-system/use-popup-label': string;
             '@atlaskit/design-system/use-visually-hidden': string;
         };
     };

package/dist/types/presets/all.codegen.d.ts

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::1ab11547db880eba1206f334a9b2150f>>
+ * @codegen <<SignedSource::5a5b0ed8cf86631274d7d30df4199e5d>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 declare const _default: {
@@ -35,6 +35,7 @@ declare const _default: {
         '@atlaskit/design-system/use-heading': string;
         '@atlaskit/design-system/use-heading-level-in-spotlight-card': string;
         '@atlaskit/design-system/use-href-in-link-item': string;
+        '@atlaskit/design-system/use-popup-label': string;
         '@atlaskit/design-system/use-primitives': string;
         '@atlaskit/design-system/use-primitives-text': string;
         '@atlaskit/design-system/use-tokens-space': string;

package/dist/types/presets/recommended.codegen.d.ts

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::05b4fe8f97edc4f7e46ded52b4917037>>
+ * @codegen <<SignedSource::af55c21605e3b8ee7836cb8950a9f713>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 declare const _default: {
@@ -26,6 +26,7 @@ declare const _default: {
         '@atlaskit/design-system/use-drawer-label': string;
         '@atlaskit/design-system/use-heading-level-in-spotlight-card': string;
         '@atlaskit/design-system/use-href-in-link-item': string;
+        '@atlaskit/design-system/use-popup-label': string;
         '@atlaskit/design-system/use-visually-hidden': string;
     };
 };

package/dist/types/rules/index.codegen.d.ts

@@ -32,6 +32,7 @@ declare const _default: {
     'use-heading': import("eslint").Rule.RuleModule;
     'use-heading-level-in-spotlight-card': import("eslint").Rule.RuleModule;
     'use-href-in-link-item': import("eslint").Rule.RuleModule;
+    'use-popup-label': import("eslint").Rule.RuleModule;
     'use-primitives': import("eslint").Rule.RuleModule;
     'use-primitives-text': import("eslint").Rule.RuleModule;
     'use-tokens-space': import("eslint").Rule.RuleModule;

package/dist/types/rules/use-popup-label/index.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export default rule;

package/dist/types/rules/use-tokens-typography/utils.d.ts

@@ -127,39 +127,6 @@ export declare const fontFamilyTokens: ({
     name: string;
     path: string[];
     cleanName: string;
-} | {
-    attributes: {
-        group: string;
-        state: string;
-        introduced: string;
-        deprecated: string;
-        description: string;
-        responsiveSmallerVariant?: undefined;
-    };
-    value: string;
-    filePath: string;
-    isSource: boolean;
-    original: {
-        attributes: {
-            group: string;
-            state: string;
-            introduced: string;
-            deprecated: string;
-            description: string;
-            responsiveSmallerVariant?: undefined;
-        };
-        value: {
-            fontWeight: string;
-            fontSize: string;
-            lineHeight: string;
-            fontFamily: string;
-            fontStyle: string;
-            letterSpacing: string;
-        };
-    };
-    name: string;
-    path: string[];
-    cleanName: string;
 } | {
     attributes: {
         group: string;

package/dist/types-ts4.5/index.codegen.d.ts

@@ -32,6 +32,7 @@ export declare const configs: {
             '@atlaskit/design-system/use-heading': string;
             '@atlaskit/design-system/use-heading-level-in-spotlight-card': string;
             '@atlaskit/design-system/use-href-in-link-item': string;
+            '@atlaskit/design-system/use-popup-label': string;
             '@atlaskit/design-system/use-primitives': string;
             '@atlaskit/design-system/use-primitives-text': string;
             '@atlaskit/design-system/use-tokens-space': string;
@@ -62,6 +63,7 @@ export declare const configs: {
             '@atlaskit/design-system/use-drawer-label': string;
             '@atlaskit/design-system/use-heading-level-in-spotlight-card': string;
             '@atlaskit/design-system/use-href-in-link-item': string;
+            '@atlaskit/design-system/use-popup-label': string;
             '@atlaskit/design-system/use-visually-hidden': string;
         };
     };

package/dist/types-ts4.5/presets/all.codegen.d.ts

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::1ab11547db880eba1206f334a9b2150f>>
+ * @codegen <<SignedSource::5a5b0ed8cf86631274d7d30df4199e5d>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 declare const _default: {
@@ -35,6 +35,7 @@ declare const _default: {
         '@atlaskit/design-system/use-heading': string;
         '@atlaskit/design-system/use-heading-level-in-spotlight-card': string;
         '@atlaskit/design-system/use-href-in-link-item': string;
+        '@atlaskit/design-system/use-popup-label': string;
         '@atlaskit/design-system/use-primitives': string;
         '@atlaskit/design-system/use-primitives-text': string;
         '@atlaskit/design-system/use-tokens-space': string;

package/dist/types-ts4.5/presets/recommended.codegen.d.ts

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::05b4fe8f97edc4f7e46ded52b4917037>>
+ * @codegen <<SignedSource::af55c21605e3b8ee7836cb8950a9f713>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 declare const _default: {
@@ -26,6 +26,7 @@ declare const _default: {
         '@atlaskit/design-system/use-drawer-label': string;
         '@atlaskit/design-system/use-heading-level-in-spotlight-card': string;
         '@atlaskit/design-system/use-href-in-link-item': string;
+        '@atlaskit/design-system/use-popup-label': string;
         '@atlaskit/design-system/use-visually-hidden': string;
     };
 };

package/dist/types-ts4.5/rules/index.codegen.d.ts

@@ -36,6 +36,7 @@ declare const _default: {
     'use-heading': import("eslint").Rule.RuleModule;
     'use-heading-level-in-spotlight-card': import("eslint").Rule.RuleModule;
     'use-href-in-link-item': import("eslint").Rule.RuleModule;
+    'use-popup-label': import("eslint").Rule.RuleModule;
     'use-primitives': import("eslint").Rule.RuleModule;
     'use-primitives-text': import("eslint").Rule.RuleModule;
     'use-tokens-space': import("eslint").Rule.RuleModule;

package/dist/types-ts4.5/rules/use-popup-label/index.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export default rule;

package/dist/types-ts4.5/rules/use-tokens-typography/utils.d.ts

@@ -127,39 +127,6 @@ export declare const fontFamilyTokens: ({
     name: string;
     path: string[];
     cleanName: string;
-} | {
-    attributes: {
-        group: string;
-        state: string;
-        introduced: string;
-        deprecated: string;
-        description: string;
-        responsiveSmallerVariant?: undefined;
-    };
-    value: string;
-    filePath: string;
-    isSource: boolean;
-    original: {
-        attributes: {
-            group: string;
-            state: string;
-            introduced: string;
-            deprecated: string;
-            description: string;
-            responsiveSmallerVariant?: undefined;
-        };
-        value: {
-            fontWeight: string;
-            fontSize: string;
-            lineHeight: string;
-            fontFamily: string;
-            fontStyle: string;
-            letterSpacing: string;
-        };
-    };
-    name: string;
-    path: string[];
-    cleanName: string;
 } | {
     attributes: {
         group: string;

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": "9.5.2",
+  "version": "9.7.0",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
   "publishConfig": {
@@ -53,6 +53,7 @@
     "semver": "^7.5.2"
   },
   "devDependencies": {
+    "@af/formatting": "*",
     "@atlaskit/ds-lib": "^2.3.0",
     "@atlaskit/theme": "^12.7.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
@@ -66,7 +67,6 @@
     "eslint": "^8.49.0",
     "jscodeshift": "^0.13.0",
     "outdent": "^0.5.0",
-    "prettier": "^2.8.0",
     "react": "^16.8.0",
     "ts-jest": "26.5.6",
     "ts-node": "^10.9.1",