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

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/eslint-plugin-design-system
 
+## 10.13.0
+
+### Minor Changes
+
+- [#128427](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/128427)
+  [`ade1e717764e2`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/ade1e717764e2) -
+  Update no-legacy-icons eslint rule following changes to color prop of new icon components
+
+### Patch Changes
+
+- [#127303](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/127303)
+  [`8c7d9e510fc2a`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/8c7d9e510fc2a) -
+  New rule config option `enableUnsafeReport` for `use-primitives-text` and `use-heading` to enable
+  error reporting for native typography elements that are not autofixable.
+- Updated dependencies
+
 ## 10.12.5
 
 ### Patch Changes

package/dist/cjs/rules/no-legacy-icons/helpers.js

@@ -142,12 +142,12 @@ var createGuidance = exports.createGuidance = function createGuidance(iconPackag
  * @returns True if the color can be migrated, false otherwise
  */
 var canMigrateColor = exports.canMigrateColor = function canMigrateColor(color) {
-  if (color.match(/^color\.text$/)) {
-    return true;
-  } else if (color.match(/^color\.icon/)) {
+  if (color.match(/^color\.icon/)) {
     return true;
   } else if (color.match(/^color\.link/)) {
     return true;
+  } else if (color.match(/^color\.text/)) {
+    return true;
   } else if (color === 'currentColor') {
     return true;
   } else {

package/dist/cjs/rules/use-heading/config/index.js

@@ -7,7 +7,8 @@ exports.getConfig = void 0;
 var defaults = {
   failSilently: false,
   patterns: ['native-elements'],
-  enableUnsafeAutofix: false
+  enableUnsafeAutofix: false,
+  enableUnsafeReport: false
 };
 var getConfig = exports.getConfig = function getConfig(overrides) {
   return Object.assign({}, defaults, overrides);

package/dist/cjs/rules/use-heading/transformers/native-elements.js

@@ -28,63 +28,93 @@ var NativeElements = exports.NativeElements = {
     var context = _ref.context,
       config = _ref.config;
     // Check whether all criteria needed to make a transformation are met
-    if (!NativeElements._check(node, {
-      context: context,
-      config: config
-    })) {
-      return;
-    }
-    var fix = NativeElements._fix(node, {
-      context: context,
-      config: config
-    });
-    context.report(_objectSpread({
-      node: node,
-      messageId: 'preferHeading'
-    }, config.enableUnsafeAutofix ? {
-      fix: fix
-    } : {
-      suggest: [{
-        desc: "Convert to Heading",
+    var _NativeElements$_chec = NativeElements._check(node, {
+        context: context,
+        config: config
+      }),
+      success = _NativeElements$_chec.success,
+      autoFixable = _NativeElements$_chec.autoFixable;
+    if (success && autoFixable) {
+      var fix = NativeElements._fix(node, {
+        context: context,
+        config: config
+      });
+      context.report(_objectSpread({
+        node: node,
+        messageId: 'preferHeading'
+      }, config.enableUnsafeAutofix ? {
         fix: fix
-      }]
-    }));
+      } : {
+        suggest: [{
+          desc: "Convert to Heading",
+          fix: fix
+        }]
+      }));
+    } else if (success && config.enableUnsafeReport) {
+      context.report({
+        node: node,
+        messageId: 'preferHeading'
+      });
+    }
   },
   _check: function _check(node, _ref2) {
     var config = _ref2.config;
     if (!config.patterns.includes('native-elements')) {
-      return false;
+      return {
+        success: false
+      };
     }
     if (!(0, _eslintCodemodUtils.isNodeOfType)(node, 'JSXElement')) {
-      return false;
+      return {
+        success: false
+      };
     }
     if (!node.children.length) {
-      return false;
-    }
-    if (!node.parent) {
-      return false;
+      return {
+        success: false
+      };
     }
     var elementName = ast.JSXElement.getName(node);
     if (!Object.keys(tagSizeMap).includes(elementName)) {
-      return false;
+      return {
+        success: false
+      };
+    }
+    if (!node.parent) {
+      return {
+        success: true,
+        autoFixable: false
+      };
     }
 
     // Element has to be first element of its siblings
     if (!((0, _eslintCodemodUtils.isNodeOfType)(node.parent, 'JSXElement') || (0, _eslintCodemodUtils.isNodeOfType)(node.parent, 'JSXFragment'))) {
-      return false;
+      return {
+        success: true,
+        autoFixable: false
+      };
     }
     var siblings = ast.JSXElement.getChildren(node.parent);
     if (siblings.length > 1) {
       var _siblings$0$range, _node$range, _siblings$0$range2, _node$range2;
       // Only report if element is first child element
       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 false;
+        return {
+          success: true,
+          autoFixable: false
+        };
       }
     }
     if (!ast.JSXElement.hasAllowedAttrsOnly(node, _common.allowedAttrs)) {
-      return false;
+      return {
+        success: true,
+        autoFixable: false
+      };
     }
-    return true;
+    return {
+      success: true,
+      autoFixable: true
+    };
   },
   _fix: function _fix(node, _ref3) {
     var context = _ref3.context;

package/dist/cjs/rules/use-primitives-text/config/index.js

@@ -8,7 +8,8 @@ var defaults = {
   failSilently: false,
   patterns: ['paragraph-elements', 'span-elements', 'strong-elements', 'emphasis-elements'],
   inheritColor: false,
-  enableUnsafeAutofix: false
+  enableUnsafeAutofix: false,
+  enableUnsafeReport: false
 };
 var getConfig = exports.getConfig = function getConfig(overrides) {
   return Object.assign({}, defaults, overrides);

package/dist/cjs/rules/use-primitives-text/transformers/emphasis-elements.js

@@ -24,53 +24,75 @@ var EmphasisElements = exports.EmphasisElements = {
     }
 
     // Check whether all criteria needed to make a transformation are met
-    if (!EmphasisElements._check(node, {
-      context: context,
-      config: config
-    })) {
-      return;
-    }
-    var fix = EmphasisElements._fix(node, {
-      context: context,
-      config: config
-    });
-    context.report(_objectSpread({
-      node: node.openingElement,
-      messageId: 'preferPrimitivesText'
-    }, config.enableUnsafeAutofix ? {
-      fix: fix
-    } : {
-      suggest: [{
-        desc: "Convert to Text",
+    var _EmphasisElements$_ch = EmphasisElements._check(node, {
+        context: context,
+        config: config
+      }),
+      success = _EmphasisElements$_ch.success,
+      autoFixable = _EmphasisElements$_ch.autoFixable;
+    if (success && autoFixable) {
+      var fix = EmphasisElements._fix(node, {
+        context: context,
+        config: config
+      });
+      context.report(_objectSpread({
+        node: node.openingElement,
+        messageId: 'preferPrimitivesText'
+      }, config.enableUnsafeAutofix ? {
         fix: fix
-      }]
-    }));
+      } : {
+        suggest: [{
+          desc: "Convert to Text",
+          fix: fix
+        }]
+      }));
+    } else if (success && config.enableUnsafeReport) {
+      context.report({
+        node: node.openingElement,
+        messageId: 'preferPrimitivesText'
+      });
+    }
   },
   _check: function _check(node, _ref2) {
     var context = _ref2.context,
       config = _ref2.config;
     if (!config.patterns.includes('emphasis-elements')) {
-      return false;
+      return {
+        success: false
+      };
     }
     var elementName = ast.JSXElement.getName(node);
     if (elementName !== 'em') {
-      return false;
+      return {
+        success: false
+      };
     }
     if (!node.children.length) {
-      return false;
+      return {
+        success: false
+      };
     }
 
     // Element has no unallowed props
     if (!ast.JSXElement.hasAllowedAttrsOnly(node, _common.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
     var 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: function _fix(node, _ref3) {
     var context = _ref3.context,

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

@@ -29,55 +29,60 @@ var ParagraphElements = exports.ParagraphElements = {
         config: config
       }),
       success = _ParagraphElements$_c.success,
+      autoFixable = _ParagraphElements$_c.autoFixable,
       refs = _ParagraphElements$_c.refs;
-    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.
-       */
-      var startLoc = (_refs$siblings$0$loc = refs.siblings[0].loc) === null || _refs$siblings$0$loc === void 0 ? void 0 : _refs$siblings$0$loc.start;
-      var endLoc = (_refs$siblings$loc = refs.siblings[refs.siblings.length - 1].loc) === null || _refs$siblings$loc === void 0 ? void 0 : _refs$siblings$loc.end;
-      var fix = ParagraphElements._fixMultiple(node, {
-        context: context,
-        config: config,
-        refs: refs
-      });
-      context.report(_objectSpread({
-        loc: startLoc && endLoc && {
-          start: startLoc,
-          end: endLoc
-        },
-        node: node.openingElement,
-        messageId: 'preferPrimitivesStackedText'
-      }, config.enableUnsafeAutofix ? {
-        fix: 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.
+         */
+        var startLoc = (_refs$siblings$0$loc = refs.siblings[0].loc) === null || _refs$siblings$0$loc === void 0 ? void 0 : _refs$siblings$0$loc.start;
+        var endLoc = (_refs$siblings$loc = refs.siblings[refs.siblings.length - 1].loc) === null || _refs$siblings$loc === void 0 ? void 0 : _refs$siblings$loc.end;
+        var fix = ParagraphElements._fixMultiple(node, {
+          context: context,
+          config: config,
+          refs: refs
+        });
+        context.report(_objectSpread({
+          loc: startLoc && endLoc && {
+            start: startLoc,
+            end: endLoc
+          },
+          node: node.openingElement,
+          messageId: 'preferPrimitivesStackedText'
+        }, config.enableUnsafeAutofix ? {
           fix: fix
-        }]
-      }));
-    } else {
-      var _fix = ParagraphElements._fixSingle(node, {
-        context: context,
-        config: config
-      });
-      context.report(_objectSpread({
-        node: node,
-        messageId: 'preferPrimitivesText'
-      }, config.enableUnsafeAutofix ? {
-        fix: _fix
-      } : {
-        suggest: [{
-          desc: "Convert to Text",
+        } : {
+          suggest: [{
+            desc: "Convert to Text and Stack",
+            fix: fix
+          }]
+        }));
+      } else {
+        var _fix = ParagraphElements._fixSingle(node, {
+          context: context,
+          config: config
+        });
+        context.report(_objectSpread({
+          node: node.openingElement,
+          messageId: 'preferPrimitivesText'
+        }, config.enableUnsafeAutofix ? {
           fix: _fix
-        }]
-      }));
+        } : {
+          suggest: [{
+            desc: "Convert to Text",
+            fix: _fix
+          }]
+        }));
+      }
+    } else if (success && config.enableUnsafeReport) {
+      context.report({
+        node: node.openingElement,
+        messageId: 'preferPrimitivesText'
+      });
     }
   },
   _check: function _check(node, _ref2) {
@@ -112,7 +117,8 @@ var ParagraphElements = exports.ParagraphElements = {
     // All siblings have to be paragraph elements with no unallowed props
     if (!(0, _eslintCodemodUtils.isNodeOfType)(node.parent, 'JSXElement')) {
       return {
-        success: false,
+        success: true,
+        autoFixable: false,
         refs: {
           siblings: []
         }
@@ -124,7 +130,8 @@ var ParagraphElements = exports.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: siblings
           }
@@ -142,7 +149,8 @@ var ParagraphElements = exports.ParagraphElements = {
       });
       if (!siblingsMatch) {
         return {
-          success: false,
+          success: true,
+          autoFixable: false,
           refs: {
             siblings: siblings
           }
@@ -150,7 +158,8 @@ var ParagraphElements = exports.ParagraphElements = {
       }
     } else if (!ast.JSXElement.hasAllowedAttrsOnly(node, _common.allowedAttrs)) {
       return {
-        success: false,
+        success: true,
+        autoFixable: false,
         refs: {
           siblings: siblings
         }
@@ -161,7 +170,8 @@ var ParagraphElements = exports.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: siblings
         }
@@ -169,6 +179,7 @@ var ParagraphElements = exports.ParagraphElements = {
     }
     return {
       success: true,
+      autoFixable: true,
       refs: {
         siblings: siblings
       }

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

@@ -24,58 +24,82 @@ var SpanElements = exports.SpanElements = {
     }
 
     // Check whether all criteria needed to make a transformation are met
-    if (!SpanElements._check(node, {
-      context: context,
-      config: config
-    })) {
-      return;
-    }
-    var fix = SpanElements._fix(node, {
-      context: context,
-      config: config
-    });
-    context.report(_objectSpread({
-      node: node.openingElement,
-      messageId: 'preferPrimitivesText'
-    }, config.enableUnsafeAutofix ? {
-      fix: fix
-    } : {
-      suggest: [{
-        desc: "Convert to Text",
+    var _SpanElements$_check = SpanElements._check(node, {
+        context: context,
+        config: config
+      }),
+      success = _SpanElements$_check.success,
+      autoFixable = _SpanElements$_check.autoFixable;
+    if (success && autoFixable) {
+      var fix = SpanElements._fix(node, {
+        context: context,
+        config: config
+      });
+      context.report(_objectSpread({
+        node: node.openingElement,
+        messageId: 'preferPrimitivesText'
+      }, config.enableUnsafeAutofix ? {
         fix: fix
-      }]
-    }));
+      } : {
+        suggest: [{
+          desc: "Convert to Text",
+          fix: fix
+        }]
+      }));
+    } else if (success && config.enableUnsafeReport) {
+      context.report({
+        node: node.openingElement,
+        messageId: 'preferPrimitivesText'
+      });
+    }
   },
   _check: function _check(node, _ref2) {
     var context = _ref2.context,
       config = _ref2.config;
     if (!config.patterns.includes('span-elements')) {
-      return false;
+      return {
+        success: false
+      };
     }
     var 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, _common.allowedAttrs)) {
-      return false;
+      return {
+        success: false
+      };
     }
 
     // Only allow elements with strings as children
     if (!(0, _common.hasTextChildrenOnly)(node)) {
-      return false;
+      return {
+        success: false
+      };
+    }
+
+    // Element has no unallowed props
+    if (!ast.JSXElement.hasAllowedAttrsOnly(node, _common.allowedAttrs)) {
+      return {
+        success: true,
+        autoFixable: false
+      };
     }
-    var 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
+    var 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: function _fix(node, _ref3) {
     var context = _ref3.context,

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

@@ -24,53 +24,75 @@ var StrongElements = exports.StrongElements = {
     }
 
     // Check whether all criteria needed to make a transformation are met
-    if (!StrongElements._check(node, {
-      context: context,
-      config: config
-    })) {
-      return;
-    }
-    var fix = StrongElements._fix(node, {
-      context: context,
-      config: config
-    });
-    context.report(_objectSpread({
-      node: node.openingElement,
-      messageId: 'preferPrimitivesText'
-    }, config.enableUnsafeAutofix ? {
-      fix: fix
-    } : {
-      suggest: [{
-        desc: "Convert to Text",
+    var _StrongElements$_chec = StrongElements._check(node, {
+        context: context,
+        config: config
+      }),
+      success = _StrongElements$_chec.success,
+      autoFixable = _StrongElements$_chec.autoFixable;
+    if (success && autoFixable) {
+      var fix = StrongElements._fix(node, {
+        context: context,
+        config: config
+      });
+      context.report(_objectSpread({
+        node: node.openingElement,
+        messageId: 'preferPrimitivesText'
+      }, config.enableUnsafeAutofix ? {
         fix: fix
-      }]
-    }));
+      } : {
+        suggest: [{
+          desc: "Convert to Text",
+          fix: fix
+        }]
+      }));
+    } else if (success && config.enableUnsafeReport) {
+      context.report({
+        node: node.openingElement,
+        messageId: 'preferPrimitivesText'
+      });
+    }
   },
   _check: function _check(node, _ref2) {
     var context = _ref2.context,
       config = _ref2.config;
     if (!config.patterns.includes('strong-elements')) {
-      return false;
+      return {
+        success: false
+      };
     }
     var 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, _common.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
     var 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: function _fix(node, _ref3) {
     var context = _ref3.context,