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

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

@@ -16,53 +16,75 @@ export var 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, 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/esm/rules/use-primitives-text/transformers/paragraph-elements.js

@@ -21,55 +21,60 @@ export var 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) {
@@ -104,7 +109,8 @@ export var 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: []
         }
@@ -116,7 +122,8 @@ export var 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
           }
@@ -134,7 +141,8 @@ export var ParagraphElements = {
       });
       if (!siblingsMatch) {
         return {
-          success: false,
+          success: true,
+          autoFixable: false,
           refs: {
             siblings: siblings
           }
@@ -142,7 +150,8 @@ export var ParagraphElements = {
       }
     } else if (!ast.JSXElement.hasAllowedAttrsOnly(node, allowedAttrs)) {
       return {
-        success: false,
+        success: true,
+        autoFixable: false,
         refs: {
           siblings: siblings
         }
@@ -153,7 +162,8 @@ export var 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
         }
@@ -161,6 +171,7 @@ export var ParagraphElements = {
     }
     return {
       success: true,
+      autoFixable: true,
       refs: {
         siblings: siblings
       }

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

@@ -16,58 +16,82 @@ export var 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, 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
+      };
     }
-    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/esm/rules/use-primitives-text/transformers/strong-elements.js

@@ -16,53 +16,75 @@ export var 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, 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/types/index.codegen.d.ts

@@ -14,12 +14,11 @@ export declare const configs: {
             '@atlaskit/design-system/no-deprecated-design-token-usage': string;
             '@atlaskit/design-system/no-deprecated-imports': string;
             '@atlaskit/design-system/no-direct-use-of-web-platform-drag-and-drop': string;
-            '@atlaskit/design-system/no-empty-styled-expression': string;
-            '@atlaskit/design-system/no-exported-css': string;
-            '@atlaskit/design-system/no-exported-keyframes': string;
             '@atlaskit/design-system/no-html-anchor': string;
             '@atlaskit/design-system/no-html-button': string;
-            '@atlaskit/design-system/no-invalid-css-map': string;
+            '@atlaskit/design-system/no-invalid-css-map': (string | {
+                allowedFunctionCalls: string[][];
+            })[];
             '@atlaskit/design-system/no-keyframes-tagged-template-expression': string;
             '@atlaskit/design-system/no-legacy-icons': string;
             '@atlaskit/design-system/no-margin': string;
@@ -57,12 +56,11 @@ export declare const configs: {
             '@atlaskit/design-system/no-deprecated-design-token-usage': string;
             '@atlaskit/design-system/no-deprecated-imports': string;
             '@atlaskit/design-system/no-direct-use-of-web-platform-drag-and-drop': string;
-            '@atlaskit/design-system/no-empty-styled-expression': string;
-            '@atlaskit/design-system/no-exported-css': string;
-            '@atlaskit/design-system/no-exported-keyframes': string;
             '@atlaskit/design-system/no-html-anchor': string;
             '@atlaskit/design-system/no-html-button': string;
-            '@atlaskit/design-system/no-invalid-css-map': string;
+            '@atlaskit/design-system/no-invalid-css-map': (string | {
+                allowedFunctionCalls: string[][];
+            })[];
             '@atlaskit/design-system/no-nested-styles': string;
             '@atlaskit/design-system/no-unsafe-design-token-usage': string;
             '@atlaskit/design-system/no-unsafe-style-overrides': 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::ab43b6e1a867d07b9a27eae78d48834a>>
+ * @codegen <<SignedSource::b6947ac630ea512fe3f4e3f44abb6783>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 declare const _default: {
@@ -17,12 +17,11 @@ declare const _default: {
         '@atlaskit/design-system/no-deprecated-design-token-usage': string;
         '@atlaskit/design-system/no-deprecated-imports': string;
         '@atlaskit/design-system/no-direct-use-of-web-platform-drag-and-drop': string;
-        '@atlaskit/design-system/no-empty-styled-expression': string;
-        '@atlaskit/design-system/no-exported-css': string;
-        '@atlaskit/design-system/no-exported-keyframes': string;
         '@atlaskit/design-system/no-html-anchor': string;
         '@atlaskit/design-system/no-html-button': string;
-        '@atlaskit/design-system/no-invalid-css-map': string;
+        '@atlaskit/design-system/no-invalid-css-map': (string | {
+            allowedFunctionCalls: string[][];
+        })[];
         '@atlaskit/design-system/no-keyframes-tagged-template-expression': string;
         '@atlaskit/design-system/no-legacy-icons': string;
         '@atlaskit/design-system/no-margin': 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::a620cfa5339ecfe9527af26afe5121e4>>
+ * @codegen <<SignedSource::9b6bccf688f4ee18dd0d49dbce48e475>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 declare const _default: {
@@ -14,12 +14,11 @@ declare const _default: {
         '@atlaskit/design-system/no-deprecated-design-token-usage': string;
         '@atlaskit/design-system/no-deprecated-imports': string;
         '@atlaskit/design-system/no-direct-use-of-web-platform-drag-and-drop': string;
-        '@atlaskit/design-system/no-empty-styled-expression': string;
-        '@atlaskit/design-system/no-exported-css': string;
-        '@atlaskit/design-system/no-exported-keyframes': string;
         '@atlaskit/design-system/no-html-anchor': string;
         '@atlaskit/design-system/no-html-button': string;
-        '@atlaskit/design-system/no-invalid-css-map': string;
+        '@atlaskit/design-system/no-invalid-css-map': (string | {
+            allowedFunctionCalls: string[][];
+        })[];
         '@atlaskit/design-system/no-nested-styles': string;
         '@atlaskit/design-system/no-unsafe-design-token-usage': string;
         '@atlaskit/design-system/no-unsafe-style-overrides': string;

package/dist/types/rules/ensure-design-token-usage/rule-meta.d.ts

@@ -1,3 +1,44 @@
-import type { LintRuleMeta } from '@atlaskit/eslint-utils/create-rule';
-declare const ruleMeta: LintRuleMeta;
+import { type Domains } from './types';
+declare const ruleMeta: {
+    readonly name: "ensure-design-token-usage";
+    readonly hasSuggestions: true;
+    readonly schema: {
+        readonly type: "array";
+        readonly items: {
+            readonly type: "object";
+            readonly properties: {
+                readonly applyImport: {
+                    readonly type: "boolean";
+                };
+                readonly shouldEnforceFallbacks: {
+                    readonly type: "boolean";
+                };
+                readonly domains: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly enum: Domains;
+                    };
+                };
+                readonly exceptions: {
+                    readonly type: "array";
+                };
+            };
+        };
+    };
+    readonly type: "problem";
+    readonly fixable: "code";
+    readonly docs: {
+        readonly description: "Enforces usage of design tokens rather than hard-coded values.";
+        readonly recommended: true;
+        readonly severity: "error";
+    };
+    readonly messages: {
+        readonly noRawRadiusValues: "The use of shape tokens is preferred over the direct application of border properties.\n\n@meta <<{{payload}}>>";
+        readonly noRawSpacingValues: "The use of spacing primitives or tokens is preferred over the direct application of spacing properties.\n\n@meta <<{{payload}}>>";
+        readonly autofixesPossible: "Automated corrections available for spacing values. Apply autofix to replace values with appropriate tokens";
+        readonly noCalcUsage: "The use of space tokens is preferred over using the CSS calc function. If using a value that is not aligned to the spacing scale, consider aligning to the scale and using tokens instead.";
+        readonly hardCodedColor: "Colors can be sourced from the global theme using the token function.";
+        readonly legacyElevation: "Elevations can be sourced from the global theme using the token function made of both a background and shadow. Use \"card\" for card elevations, and \"overlay\" for anything else that should appear elevated.";
+    };
+};
 export default ruleMeta;

package/dist/types/rules/no-legacy-icons/helpers.d.ts

@@ -27,7 +27,19 @@ export declare const isSize: (size: any) => size is "small" | "medium" | "large"
  * @param iconPackage The name of the legacy icon package
  * @returns The migration map object for the legacy icon or null if not found
  */
-export declare const getMigrationMapObject: (iconPackage: string) => any;
+export declare const getMigrationMapObject: (iconPackage: string) => {
+    newIcon?: {
+        name: string;
+        type: string;
+        package: string;
+    } | undefined;
+    additionalIcons?: {
+        name: string;
+        type: string;
+        package: string;
+    }[] | undefined;
+    sizeGuidance: Record<import("@atlaskit/icon").Size, IconMigrationSizeGuidance>;
+} | null;
 export declare const getUpcomingIcons: (iconPackage: string) => {
     sizeGuidance: Record<Size, IconMigrationSizeGuidance>;
 } | null;

package/dist/types/rules/use-heading/config/index.d.ts

@@ -2,7 +2,8 @@ type Pattern = 'native-elements';
 export interface RuleConfig {
     failSilently: boolean;
     patterns: Pattern[];
-    enableUnsafeAutofix: false;
+    enableUnsafeAutofix: boolean;
+    enableUnsafeReport: boolean;
 }
 export declare const getConfig: (overrides: Partial<RuleConfig>) => RuleConfig;
 export {};

package/dist/types/rules/use-heading/transformers/native-elements.d.ts

@@ -10,9 +10,13 @@ interface ValidHeadingElement extends JSXElement {
         };
     } & JSXOpeningElement;
 }
+type CheckResult = {
+    success: boolean;
+    autoFixable?: boolean;
+};
 export declare const NativeElements: {
     lint(node: Rule.Node, { context, config }: MetaData): void;
-    _check(node: Rule.Node, { config }: MetaData): node is ValidHeadingElement;
+    _check(node: Rule.Node, { config }: MetaData): CheckResult;
     _fix(node: ValidHeadingElement, { context }: MetaData): Rule.ReportFixer;
 };
 export {};