@atlaskit/eslint-plugin-design-system 10.22.0 → 10.23.0

package/dist/esm/rules/no-separator-with-list-elements/index.js

@@ -0,0 +1,56 @@
+import { isNodeOfType } from 'eslint-codemod-utils';
+import { createLintRule } from '../utils/create-rule';
+var separatorAsCombinationNotAllowed = 'The combination of `separator` with `as="li"`, `as="ol"`, or `as="dl"` is not allowed.';
+var rule = createLintRule({
+  meta: {
+    name: 'no-separator-with-list-elements',
+    type: 'suggestion',
+    docs: {
+      description: 'Warn when the `separator` prop is used with `as="li"`, `as="ol"`, or `as="dl"` in the Inline component.',
+      recommended: true,
+      severity: 'warn'
+    },
+    messages: {
+      separatorAsCombinationNotAllowed: separatorAsCombinationNotAllowed
+    }
+  },
+  create: function create(context) {
+    var inlineComponentNames = [];
+    return {
+      ImportDeclaration: function ImportDeclaration(node) {
+        if (node.type === 'ImportDeclaration' && (node.source.value === '../src' || node.source.value === '@atlaskit/primitives')) {
+          node.specifiers.forEach(function (specifier) {
+            if (specifier.type === 'ImportSpecifier' && specifier.imported.name === 'Inline') {
+              inlineComponentNames.push(specifier.local.name);
+            }
+          });
+        }
+      },
+      JSXElement: function JSXElement(node) {
+        if (!isNodeOfType(node, 'JSXElement') || !isNodeOfType(node.openingElement.name, 'JSXIdentifier')) {
+          return;
+        }
+        var componentName = node.openingElement.name.name;
+        if (!inlineComponentNames.includes(componentName)) {
+          return;
+        }
+        var inlineProps = node.openingElement.attributes.filter(function (attr) {
+          return isNodeOfType(attr, 'JSXAttribute') && isNodeOfType(attr.name, 'JSXIdentifier');
+        });
+        var separatorProp = inlineProps.find(function (attr) {
+          return attr.name.name === 'separator';
+        });
+        var asProp = inlineProps.find(function (attr) {
+          return attr.name.name === 'as';
+        });
+        if (separatorProp && asProp && asProp.value && isNodeOfType(asProp.value, 'Literal') && ['li', 'ol', 'dl'].includes(asProp.value.value)) {
+          context.report({
+            node: node,
+            messageId: 'separatorAsCombinationNotAllowed'
+          });
+        }
+      }
+    };
+  }
+});
+export default rule;