@atlaskit/eslint-plugin-design-system 10.12.4 → 10.13.0

package/dist/es2019/rules/use-primitives-text/transformers/paragraph-elements.js

@@ -15,60 +15,65 @@ export const ParagraphElements = {
     // Check whether all criteria needed to make a transformation are met
     const {
       success,
+      autoFixable,
       refs
     } = ParagraphElements._check(node, {
       context,
       config
     });
-    if (!success) {
-      return;
-    }
-    if (refs.siblings.length > 1) {
-      var _refs$siblings$0$loc, _refs$siblings$loc;
-      /**
-       * Highlighting from first opening element to last closing element
-       * to indicate fix will change all p elements and wrap them in a Stack,
-       * falls back to first opening element.
-       */
-      const startLoc = (_refs$siblings$0$loc = refs.siblings[0].loc) === null || _refs$siblings$0$loc === void 0 ? void 0 : _refs$siblings$0$loc.start;
-      const endLoc = (_refs$siblings$loc = refs.siblings[refs.siblings.length - 1].loc) === null || _refs$siblings$loc === void 0 ? void 0 : _refs$siblings$loc.end;
-      const fix = ParagraphElements._fixMultiple(node, {
-        context,
-        config,
-        refs
-      });
-      context.report({
-        loc: startLoc && endLoc && {
-          start: startLoc,
-          end: endLoc
-        },
-        node: node.openingElement,
-        messageId: 'preferPrimitivesStackedText',
-        ...(config.enableUnsafeAutofix ? {
-          fix
-        } : {
-          suggest: [{
-            desc: `Convert to Text and Stack`,
+    if (success && autoFixable) {
+      if (refs.siblings.length > 1) {
+        var _refs$siblings$0$loc, _refs$siblings$loc;
+        /**
+         * Highlighting from first opening element to last closing element
+         * to indicate fix will change all p elements and wrap them in a Stack,
+         * falls back to first opening element.
+         */
+        const startLoc = (_refs$siblings$0$loc = refs.siblings[0].loc) === null || _refs$siblings$0$loc === void 0 ? void 0 : _refs$siblings$0$loc.start;
+        const endLoc = (_refs$siblings$loc = refs.siblings[refs.siblings.length - 1].loc) === null || _refs$siblings$loc === void 0 ? void 0 : _refs$siblings$loc.end;
+        const fix = ParagraphElements._fixMultiple(node, {
+          context,
+          config,
+          refs
+        });
+        context.report({
+          loc: startLoc && endLoc && {
+            start: startLoc,
+            end: endLoc
+          },
+          node: node.openingElement,
+          messageId: 'preferPrimitivesStackedText',
+          ...(config.enableUnsafeAutofix ? {
             fix
-          }]
-        })
-      });
-    } else {
-      const fix = ParagraphElements._fixSingle(node, {
-        context,
-        config
-      });
-      context.report({
-        node,
-        messageId: 'preferPrimitivesText',
-        ...(config.enableUnsafeAutofix ? {
-          fix
-        } : {
-          suggest: [{
-            desc: `Convert to Text`,
+          } : {
+            suggest: [{
+              desc: `Convert to Text and Stack`,
+              fix
+            }]
+          })
+        });
+      } else {
+        const fix = ParagraphElements._fixSingle(node, {
+          context,
+          config
+        });
+        context.report({
+          node: node.openingElement,
+          messageId: 'preferPrimitivesText',
+          ...(config.enableUnsafeAutofix ? {
             fix
-          }]
-        })
+          } : {
+            suggest: [{
+              desc: `Convert to Text`,
+              fix
+            }]
+          })
+        });
+      }
+    } else if (success && config.enableUnsafeReport) {
+      context.report({
+        node: node.openingElement,
+        messageId: 'preferPrimitivesText'
       });
     }
   },
@@ -105,7 +110,8 @@ export const ParagraphElements = {
     // All siblings have to be paragraph elements with no unallowed props
     if (!isNodeOfType(node.parent, 'JSXElement')) {
       return {
-        success: false,
+        success: true,
+        autoFixable: false,
         refs: {
           siblings: []
         }
@@ -117,7 +123,8 @@ export const ParagraphElements = {
       // Only report for the first p element by comparing node location
       if (((_siblings$0$range = siblings[0].range) === null || _siblings$0$range === void 0 ? void 0 : _siblings$0$range[0]) !== ((_node$range = node.range) === null || _node$range === void 0 ? void 0 : _node$range[0]) || ((_siblings$0$range2 = siblings[0].range) === null || _siblings$0$range2 === void 0 ? void 0 : _siblings$0$range2[1]) !== ((_node$range2 = node.range) === null || _node$range2 === void 0 ? void 0 : _node$range2[1])) {
         return {
-          success: false,
+          success: true,
+          autoFixable: false,
           refs: {
             siblings
           }
@@ -135,7 +142,8 @@ export const ParagraphElements = {
       });
       if (!siblingsMatch) {
         return {
-          success: false,
+          success: true,
+          autoFixable: false,
           refs: {
             siblings
           }
@@ -143,7 +151,8 @@ export const ParagraphElements = {
       }
     } else if (!ast.JSXElement.hasAllowedAttrsOnly(node, allowedAttrs)) {
       return {
-        success: false,
+        success: true,
+        autoFixable: false,
         refs: {
           siblings
         }
@@ -154,7 +163,8 @@ export const ParagraphElements = {
     // If there is more than one `@atlaskit/primitives` import, then it becomes difficult to determine which import to transform
     if (importDeclaration.length > 1) {
       return {
-        success: false,
+        success: true,
+        autoFixable: false,
         refs: {
           siblings
         }
@@ -162,6 +172,7 @@ export const ParagraphElements = {
     }
     return {
       success: true,
+      autoFixable: true,
       refs: {
         siblings
       }

package/dist/es2019/rules/use-primitives-text/transformers/span-elements.js

@@ -13,60 +13,85 @@ export const SpanElements = {
     }
 
     // Check whether all criteria needed to make a transformation are met
-    if (!SpanElements._check(node, {
-      context,
-      config
-    })) {
-      return;
-    }
-    const fix = SpanElements._fix(node, {
+    const {
+      success,
+      autoFixable
+    } = SpanElements._check(node, {
       context,
       config
     });
-    context.report({
-      node: node.openingElement,
-      messageId: 'preferPrimitivesText',
-      ...(config.enableUnsafeAutofix ? {
-        fix
-      } : {
-        suggest: [{
-          desc: `Convert to Text`,
+    if (success && autoFixable) {
+      const fix = SpanElements._fix(node, {
+        context,
+        config
+      });
+      context.report({
+        node: node.openingElement,
+        messageId: 'preferPrimitivesText',
+        ...(config.enableUnsafeAutofix ? {
           fix
-        }]
-      })
-    });
+        } : {
+          suggest: [{
+            desc: `Convert to Text`,
+            fix
+          }]
+        })
+      });
+    } else if (success && config.enableUnsafeReport) {
+      context.report({
+        node: node.openingElement,
+        messageId: 'preferPrimitivesText'
+      });
+    }
   },
   _check(node, {
     context,
     config
   }) {
     if (!config.patterns.includes('span-elements')) {
-      return false;
+      return {
+        success: false
+      };
     }
     const elementName = ast.JSXElement.getName(node);
     if (elementName !== 'span') {
-      return false;
+      return {
+        success: false
+      };
     }
     if (!node.children.length) {
-      return false;
-    }
-
-    // Element has no unallowed props
-    if (!ast.JSXElement.hasAllowedAttrsOnly(node, allowedAttrs)) {
-      return false;
+      return {
+        success: false
+      };
     }
 
     // Only allow elements with strings as children
     if (!hasTextChildrenOnly(node)) {
-      return false;
+      return {
+        success: false
+      };
+    }
+
+    // Element has no unallowed props
+    if (!ast.JSXElement.hasAllowedAttrsOnly(node, allowedAttrs)) {
+      return {
+        success: true,
+        autoFixable: false
+      };
     }
-    const importDeclaration = ast.Root.findImportsByModule(context.getSourceCode().ast.body, '@atlaskit/primitives');
 
     // If there is more than one `@atlaskit/primitives` import, then it becomes difficult to determine which import to transform
+    const importDeclaration = ast.Root.findImportsByModule(context.getSourceCode().ast.body, '@atlaskit/primitives');
     if (importDeclaration.length > 1) {
-      return false;
+      return {
+        success: true,
+        autoFixable: false
+      };
     }
-    return true;
+    return {
+      success: true,
+      autoFixable: true
+    };
   },
   _fix(node, {
     context,

package/dist/es2019/rules/use-primitives-text/transformers/strong-elements.js

@@ -13,55 +13,78 @@ export const StrongElements = {
     }
 
     // Check whether all criteria needed to make a transformation are met
-    if (!StrongElements._check(node, {
-      context,
-      config
-    })) {
-      return;
-    }
-    const fix = StrongElements._fix(node, {
+    const {
+      success,
+      autoFixable
+    } = StrongElements._check(node, {
       context,
       config
     });
-    context.report({
-      node: node.openingElement,
-      messageId: 'preferPrimitivesText',
-      ...(config.enableUnsafeAutofix ? {
-        fix
-      } : {
-        suggest: [{
-          desc: `Convert to Text`,
+    if (success && autoFixable) {
+      const fix = StrongElements._fix(node, {
+        context,
+        config
+      });
+      context.report({
+        node: node.openingElement,
+        messageId: 'preferPrimitivesText',
+        ...(config.enableUnsafeAutofix ? {
           fix
-        }]
-      })
-    });
+        } : {
+          suggest: [{
+            desc: `Convert to Text`,
+            fix
+          }]
+        })
+      });
+    } else if (success && config.enableUnsafeReport) {
+      context.report({
+        node: node.openingElement,
+        messageId: 'preferPrimitivesText'
+      });
+    }
   },
   _check(node, {
     context,
     config
   }) {
     if (!config.patterns.includes('strong-elements')) {
-      return false;
+      return {
+        success: false
+      };
     }
     const elementName = ast.JSXElement.getName(node);
     if (elementName !== 'strong') {
-      return false;
+      return {
+        success: false
+      };
     }
     if (!node.children.length) {
-      return false;
+      return {
+        success: false
+      };
     }
 
     // Element has no unallowed props
     if (!ast.JSXElement.hasAllowedAttrsOnly(node, allowedAttrs)) {
-      return false;
+      return {
+        success: true,
+        autoFixable: false
+      };
     }
 
     // If there is more than one `@atlaskit/primitives` import, then it becomes difficult to determine which import to transform
     const importDeclaration = ast.Root.findImportsByModule(context.getSourceCode().ast.body, '@atlaskit/primitives');
     if (importDeclaration.length > 1) {
-      return false;
+      return {
+        success: true,
+        autoFixable: false
+      };
     }
-    return true;
+    return {
+      success: true,
+      autoFixable: true
+    };
   },
   _fix(node, {
     context,