@atlaskit/eslint-plugin-design-system 10.12.5 → 10.14.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,

package/dist/esm/presets/all.codegen.js

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::ab43b6e1a867d07b9a27eae78d48834a>>
+ * @codegen <<SignedSource::b6947ac630ea512fe3f4e3f44abb6783>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 export default {
@@ -17,12 +17,11 @@ export default {
     '@atlaskit/design-system/no-deprecated-design-token-usage': 'warn',
     '@atlaskit/design-system/no-deprecated-imports': 'error',
     '@atlaskit/design-system/no-direct-use-of-web-platform-drag-and-drop': 'error',
-    '@atlaskit/design-system/no-empty-styled-expression': 'warn',
-    '@atlaskit/design-system/no-exported-css': 'warn',
-    '@atlaskit/design-system/no-exported-keyframes': 'warn',
     '@atlaskit/design-system/no-html-anchor': 'warn',
     '@atlaskit/design-system/no-html-button': 'warn',
-    '@atlaskit/design-system/no-invalid-css-map': 'error',
+    '@atlaskit/design-system/no-invalid-css-map': ['error', {
+      allowedFunctionCalls: [['@atlaskit/tokens', 'token']]
+    }],
     '@atlaskit/design-system/no-keyframes-tagged-template-expression': 'error',
     '@atlaskit/design-system/no-legacy-icons': 'warn',
     '@atlaskit/design-system/no-margin': 'warn',

package/dist/esm/presets/recommended.codegen.js

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::a620cfa5339ecfe9527af26afe5121e4>>
+ * @codegen <<SignedSource::9b6bccf688f4ee18dd0d49dbce48e475>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 export default {
@@ -14,12 +14,11 @@ export default {
     '@atlaskit/design-system/no-deprecated-design-token-usage': 'warn',
     '@atlaskit/design-system/no-deprecated-imports': 'error',
     '@atlaskit/design-system/no-direct-use-of-web-platform-drag-and-drop': 'error',
-    '@atlaskit/design-system/no-empty-styled-expression': 'warn',
-    '@atlaskit/design-system/no-exported-css': 'warn',
-    '@atlaskit/design-system/no-exported-keyframes': 'warn',
     '@atlaskit/design-system/no-html-anchor': 'warn',
     '@atlaskit/design-system/no-html-button': 'warn',
-    '@atlaskit/design-system/no-invalid-css-map': 'error',
+    '@atlaskit/design-system/no-invalid-css-map': ['error', {
+      allowedFunctionCalls: [['@atlaskit/tokens', 'token']]
+    }],
     '@atlaskit/design-system/no-nested-styles': 'error',
     '@atlaskit/design-system/no-unsafe-design-token-usage': 'error',
     '@atlaskit/design-system/no-unsafe-style-overrides': 'warn',

package/dist/esm/rules/no-empty-styled-expression/index.js

@@ -43,8 +43,7 @@ var noEmptyStyledExpressionRule = createLintRule({
     name: 'no-empty-styled-expression',
     docs: {
       description: 'Forbids any styled expression to be used when passing empty arguments to styled.div() (or other JSX elements).',
-      recommended: true,
-      severity: 'warn'
+      removeFromPresets: true // effectively disable this rule here, this is configured by `@atlaskit/ui-styling-standard` instead
     },
     messages: {
       unexpected: 'Found an empty expression, or empty object argument passed to `styled` function call. This unnecessarily causes a major performance penalty - please use a plain JSX element or a React fragment instead (e.g. `<div>Hello</div>` or `<>Hello</>`).'

package/dist/esm/rules/no-exported-css/index.js

@@ -7,8 +7,7 @@ var noExportedCssRule = createLintRule({
     type: 'problem',
     docs: {
       description: 'Forbid exporting `css` function calls. Exporting `css` function calls can result in unexpected behaviour at runtime, and is not statically analysable.',
-      recommended: true,
-      severity: 'warn'
+      removeFromPresets: true // effectively disable this rule here, this is overriden by `@atlaskit/ui-styling-standard` instead
     },
     messages: {
       unexpected: "`css` can't be exported - this will cause unexpected behaviour at runtime. Instead, please move your `css(...)` code to the same file where these styles are being used."

package/dist/esm/rules/no-exported-keyframes/index.js

@@ -7,8 +7,7 @@ var noExportedKeyframesRule = createLintRule({
     type: 'problem',
     docs: {
       description: 'Forbid exporting `keyframes` function calls. Exporting `css` function calls can result in unexpected behaviour at runtime, and is not statically analysable.',
-      recommended: true,
-      severity: 'warn'
+      removeFromPresets: true // effectively disable this rule here, this is overriden by `@atlaskit/ui-styling-standard` instead
     },
     messages: {
       unexpected: "`keyframes` can't be exported - this will cause unexpected behaviour at runtime. Instead, please move your `keyframes(...)` code to the same file where these styles are being used."

package/dist/esm/rules/no-invalid-css-map/index.js

@@ -59,7 +59,10 @@ var noInvalidCssMapRule = createLintRule({
     docs: {
       description: "Checks the validity of a CSS map created through cssMap. This is intended to be used alongside TypeScript's type-checking.",
       recommended: true,
-      severity: 'error'
+      severity: 'error',
+      pluginConfig: {
+        allowedFunctionCalls: [['@atlaskit/tokens', 'token']]
+      }
     },
     messages: {
       mustBeTopLevelScope: 'cssMap must only be used in the top-most scope of the module.',

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

@@ -132,12 +132,12 @@ export var createGuidance = function createGuidance(iconPackage) {
  * @returns True if the color can be migrated, false otherwise
  */
 export var 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/esm/rules/use-heading/config/index.js

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

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

@@ -20,63 +20,93 @@ export var 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 (!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 (!(isNodeOfType(node.parent, 'JSXElement') || 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, 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/esm/rules/use-primitives-text/config/index.js

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