@atlaskit/eslint-plugin-design-system 8.17.0 → 8.18.1

package/dist/types/rules/use-primitives/transformers/index.d.ts

@@ -1,2 +1,3 @@
 export { cssToXcssTransformer, supportedStylesMap, spaceTokenMap, } from './css-to-xcss';
 export { jsxElementToBoxTransformer } from './jsx-element-to-box';
+export { styledComponentToPrimitive } from './styled-component-to-primitive';

package/dist/types/rules/use-primitives/transformers/styled-component-to-primitive.d.ts

@@ -0,0 +1,13 @@
+import type { Rule } from 'eslint';
+import { JSXOpeningElement, VariableDeclarator } from 'eslint-codemod-utils';
+type StylesRef = VariableDeclarator & Rule.NodeParentExtension;
+type JSXRef = JSXOpeningElement & Rule.NodeParentExtension;
+/**
+ * All required validation steps have been taken care of before this
+ * transformer is called, so it just goes ahead providing all necessary fixes
+ */
+export declare const styledComponentToPrimitive: ({ stylesRef, jsxRef, }: {
+    stylesRef: StylesRef;
+    jsxRef: JSXRef;
+}, context: Rule.RuleContext) => (fixer: Rule.RuleFixer) => Rule.Fix[];
+export {};

package/dist/types/rules/use-primitives/utils/convert-ast-object-expression-to-js-object.d.ts

@@ -6,4 +6,4 @@ export type CSSPropStyleObject = {
 /**
  * Note: Not recursive. Only handles top level key/value pairs
  */
-export declare const convertASTObjectExpressionToJSObject: (styles: ObjectExpression & Partial<Rule.NodeParentExtension>) => CSSPropStyleObject;
+export declare const convertASTObjectExpressionToJSObject: (styles: ObjectExpression & Partial<Rule.NodeParentExtension>) => CSSPropStyleObject | false;

package/dist/types/rules/use-primitives/utils/find-valid-jsx-usage-to-transform.d.ts

@@ -0,0 +1,7 @@
+import type { Rule, Scope } from 'eslint';
+import { JSXOpeningElement } from 'eslint-codemod-utils';
+/**
+ * Given a component name finds its JSX usages and performs some
+ * additional validations to ensure transformation can be done correctly
+ */
+export declare const findValidJsxUsageToTransform: (componentName: string, scope: Scope.Scope) => (JSXOpeningElement & Rule.NodeParentExtension) | undefined;

package/dist/types/rules/use-primitives/utils/find-valid-styled-component-call.d.ts

@@ -0,0 +1,7 @@
+import type { Rule } from 'eslint';
+import { type VariableDeclarator } from 'eslint-codemod-utils';
+/**
+ * returns a variable reference if preconditions are favourable for
+ * the transformation to proceed, undefined otherwise.
+ */
+export declare const findValidStyledComponentCall: (node: Rule.Node) => (VariableDeclarator & Rule.NodeParentExtension) | undefined;

package/dist/types/rules/use-primitives/utils/index.d.ts

@@ -1,11 +1,14 @@
 export { containsOnlySupportedAttrs } from './contains-only-supported-attrs';
 export { convertASTObjectExpressionToJSObject } from './convert-ast-object-expression-to-js-object';
+export { findValidJsxUsageToTransform } from './find-valid-jsx-usage-to-transform';
+export { findValidStyledComponentCall } from './find-valid-styled-component-call';
 export { getAttributeValueIdentifier } from './get-attribute-value-identifier';
 export { getFunctionArgumentAtPos } from './get-function-argument-at-pos';
 export { getJSXAttributeByName } from './get-jsx-attribute-by-name';
 export { getVariableDefinitionValue } from './get-variable-definition-value';
 export { getVariableUsagesCount } from './get-variable-usage-count';
 export { isFunctionNamed } from './is-function-named';
+export { isValidCssPropertiesToTransform } from './is-valid-css-properties-to-transform';
 export { isValidTagName } from './is-valid-tag-name';
 export { updateJSXAttributeByName } from './update-jsx-attribute-by-name';
 export { updateJSXElementName } from './update-jsx-element-name';

package/dist/types/rules/use-primitives/utils/is-valid-css-properties-to-transform.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+import { SimpleCallExpression } from 'eslint-codemod-utils';
+export declare const isValidCssPropertiesToTransform: (node: SimpleCallExpression & Rule.NodeParentExtension) => boolean;

package/dist/types/rules/use-primitives/utils/is-valid-tag-name.d.ts

@@ -1,2 +1,3 @@
 import { JSXElement } from 'eslint-codemod-utils';
+export declare const validPrimitiveElements: Set<string>;
 export declare const isValidTagName: (node: JSXElement) => boolean;

package/dist/types/rules/use-primitives/utils/update-jsx-element-name.d.ts

@@ -1,3 +1,3 @@
 import type { Rule } from 'eslint';
 import { JSXElement } from 'eslint-codemod-utils';
-export declare const updateJSXElementName: (node: JSXElement, newName: string, fixer: Rule.RuleFixer) => (Rule.Fix | null)[];
+export declare const updateJSXElementName: (node: JSXElement, newName: string, fixer: Rule.RuleFixer) => (Rule.Fix | undefined)[];

package/dist/types/rules/utils/get-import-name.d.ts

@@ -0,0 +1,2 @@
+import type { Scope } from 'eslint';
+export declare const getImportName: (scope: Scope.Scope, packageName: string, componentName: string) => string | null;

package/dist/types-ts4.5/index.codegen.d.ts

@@ -19,6 +19,7 @@ export declare const configs: {
             '@atlaskit/design-system/no-unsupported-drag-and-drop-libraries': string;
             '@atlaskit/design-system/prefer-primitives': string;
             '@atlaskit/design-system/use-drawer-label': string;
+            '@atlaskit/design-system/use-heading-level-in-spotlight-card': string;
             '@atlaskit/design-system/use-href-in-link-item': string;
             '@atlaskit/design-system/use-primitives': string;
             '@atlaskit/design-system/use-visually-hidden': string;
@@ -38,6 +39,7 @@ export declare const configs: {
             '@atlaskit/design-system/no-unsafe-design-token-usage': string;
             '@atlaskit/design-system/no-unsupported-drag-and-drop-libraries': string;
             '@atlaskit/design-system/use-drawer-label': string;
+            '@atlaskit/design-system/use-heading-level-in-spotlight-card': string;
             '@atlaskit/design-system/use-href-in-link-item': string;
             '@atlaskit/design-system/use-visually-hidden': string;
         };

package/dist/types-ts4.5/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::594898d8c5dc8b9a5610d62e7f300a53>>
+ * @codegen <<SignedSource::37a857efd0971ab26170d5f1f526279b>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 declare const _default: {
@@ -22,6 +22,7 @@ declare const _default: {
         '@atlaskit/design-system/no-unsupported-drag-and-drop-libraries': string;
         '@atlaskit/design-system/prefer-primitives': string;
         '@atlaskit/design-system/use-drawer-label': string;
+        '@atlaskit/design-system/use-heading-level-in-spotlight-card': string;
         '@atlaskit/design-system/use-href-in-link-item': string;
         '@atlaskit/design-system/use-primitives': string;
         '@atlaskit/design-system/use-visually-hidden': string;

package/dist/types-ts4.5/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::240c678d4f10d97618541f35d79e1c71>>
+ * @codegen <<SignedSource::b3bce8efb2db1fed84370af608ca0d4c>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 declare const _default: {
@@ -17,6 +17,7 @@ declare const _default: {
         '@atlaskit/design-system/no-unsafe-design-token-usage': string;
         '@atlaskit/design-system/no-unsupported-drag-and-drop-libraries': string;
         '@atlaskit/design-system/use-drawer-label': string;
+        '@atlaskit/design-system/use-heading-level-in-spotlight-card': string;
         '@atlaskit/design-system/use-href-in-link-item': string;
         '@atlaskit/design-system/use-visually-hidden': string;
     };

package/dist/types-ts4.5/rules/index.codegen.d.ts

@@ -23,6 +23,7 @@ declare const _default: {
     'no-unsupported-drag-and-drop-libraries': import("eslint").Rule.RuleModule;
     'prefer-primitives': import("eslint").Rule.RuleModule;
     'use-drawer-label': import("eslint").Rule.RuleModule;
+    'use-heading-level-in-spotlight-card': import("eslint").Rule.RuleModule;
     'use-href-in-link-item': import("eslint").Rule.RuleModule;
     'use-primitives': import("eslint").Rule.RuleModule;
     'use-visually-hidden': import("eslint").Rule.RuleModule;

package/dist/types-ts4.5/rules/use-heading-level-in-spotlight-card/index.d.ts

@@ -0,0 +1,4 @@
+import type { Rule } from 'eslint';
+export declare const headingLevelRequiredSuggestionText = "Add a `headingLevel` that is of a contextually relevant level.";
+declare const rule: Rule.RuleModule;
+export default rule;

package/dist/types-ts4.5/rules/use-href-in-link-item/utils.d.ts

@@ -1,6 +1,5 @@
 import type { Rule, Scope } from 'eslint';
 import { ImportDeclaration, JSXAttribute } from 'eslint-codemod-utils';
-export declare const getLinkItemImportName: (scope: Scope.Scope) => string | null;
 export declare const hrefHasInvalidValue: (scope: Scope.Scope, href: JSXAttribute | undefined) => boolean;
 export declare const hasImportOfName: (node: ImportDeclaration, name: string) => boolean;
 export declare const insertButtonItemDefaultImport: (fixer: Rule.RuleFixer, node: ImportDeclaration) => Rule.Fix;

package/dist/types-ts4.5/rules/use-primitives/transformers/css-to-xcss.d.ts

@@ -1,6 +1,7 @@
 import type { Rule } from 'eslint';
-import { JSXElement } from 'eslint-codemod-utils';
+import { JSXElement, ObjectExpression } from 'eslint-codemod-utils';
 export declare const cssToXcssTransformer: (node: JSXElement, context: Rule.RuleContext, fixer: Rule.RuleFixer) => (Rule.Fix | undefined)[];
+export declare const styledObjectToXcssTokens: (styles: ObjectExpression & Partial<Rule.NodeParentExtension>, fixer: Rule.RuleFixer) => (Rule.Fix | undefined)[];
 export declare const spaceTokenMap: {
     [key: string]: string;
 };

package/dist/types-ts4.5/rules/use-primitives/transformers/index.d.ts

@@ -1,2 +1,3 @@
 export { cssToXcssTransformer, supportedStylesMap, spaceTokenMap, } from './css-to-xcss';
 export { jsxElementToBoxTransformer } from './jsx-element-to-box';
+export { styledComponentToPrimitive } from './styled-component-to-primitive';

package/dist/types-ts4.5/rules/use-primitives/transformers/styled-component-to-primitive.d.ts

@@ -0,0 +1,13 @@
+import type { Rule } from 'eslint';
+import { JSXOpeningElement, VariableDeclarator } from 'eslint-codemod-utils';
+type StylesRef = VariableDeclarator & Rule.NodeParentExtension;
+type JSXRef = JSXOpeningElement & Rule.NodeParentExtension;
+/**
+ * All required validation steps have been taken care of before this
+ * transformer is called, so it just goes ahead providing all necessary fixes
+ */
+export declare const styledComponentToPrimitive: ({ stylesRef, jsxRef, }: {
+    stylesRef: StylesRef;
+    jsxRef: JSXRef;
+}, context: Rule.RuleContext) => (fixer: Rule.RuleFixer) => Rule.Fix[];
+export {};

package/dist/types-ts4.5/rules/use-primitives/utils/convert-ast-object-expression-to-js-object.d.ts

@@ -6,4 +6,4 @@ export type CSSPropStyleObject = {
 /**
  * Note: Not recursive. Only handles top level key/value pairs
  */
-export declare const convertASTObjectExpressionToJSObject: (styles: ObjectExpression & Partial<Rule.NodeParentExtension>) => CSSPropStyleObject;
+export declare const convertASTObjectExpressionToJSObject: (styles: ObjectExpression & Partial<Rule.NodeParentExtension>) => CSSPropStyleObject | false;

package/dist/types-ts4.5/rules/use-primitives/utils/find-valid-jsx-usage-to-transform.d.ts

@@ -0,0 +1,7 @@
+import type { Rule, Scope } from 'eslint';
+import { JSXOpeningElement } from 'eslint-codemod-utils';
+/**
+ * Given a component name finds its JSX usages and performs some
+ * additional validations to ensure transformation can be done correctly
+ */
+export declare const findValidJsxUsageToTransform: (componentName: string, scope: Scope.Scope) => (JSXOpeningElement & Rule.NodeParentExtension) | undefined;

package/dist/types-ts4.5/rules/use-primitives/utils/find-valid-styled-component-call.d.ts

@@ -0,0 +1,7 @@
+import type { Rule } from 'eslint';
+import { type VariableDeclarator } from 'eslint-codemod-utils';
+/**
+ * returns a variable reference if preconditions are favourable for
+ * the transformation to proceed, undefined otherwise.
+ */
+export declare const findValidStyledComponentCall: (node: Rule.Node) => (VariableDeclarator & Rule.NodeParentExtension) | undefined;

package/dist/types-ts4.5/rules/use-primitives/utils/index.d.ts

@@ -1,11 +1,14 @@
 export { containsOnlySupportedAttrs } from './contains-only-supported-attrs';
 export { convertASTObjectExpressionToJSObject } from './convert-ast-object-expression-to-js-object';
+export { findValidJsxUsageToTransform } from './find-valid-jsx-usage-to-transform';
+export { findValidStyledComponentCall } from './find-valid-styled-component-call';
 export { getAttributeValueIdentifier } from './get-attribute-value-identifier';
 export { getFunctionArgumentAtPos } from './get-function-argument-at-pos';
 export { getJSXAttributeByName } from './get-jsx-attribute-by-name';
 export { getVariableDefinitionValue } from './get-variable-definition-value';
 export { getVariableUsagesCount } from './get-variable-usage-count';
 export { isFunctionNamed } from './is-function-named';
+export { isValidCssPropertiesToTransform } from './is-valid-css-properties-to-transform';
 export { isValidTagName } from './is-valid-tag-name';
 export { updateJSXAttributeByName } from './update-jsx-attribute-by-name';
 export { updateJSXElementName } from './update-jsx-element-name';

package/dist/types-ts4.5/rules/use-primitives/utils/is-valid-css-properties-to-transform.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+import { SimpleCallExpression } from 'eslint-codemod-utils';
+export declare const isValidCssPropertiesToTransform: (node: SimpleCallExpression & Rule.NodeParentExtension) => boolean;

package/dist/types-ts4.5/rules/use-primitives/utils/is-valid-tag-name.d.ts

@@ -1,2 +1,3 @@
 import { JSXElement } from 'eslint-codemod-utils';
+export declare const validPrimitiveElements: Set<string>;
 export declare const isValidTagName: (node: JSXElement) => boolean;

package/dist/types-ts4.5/rules/use-primitives/utils/update-jsx-element-name.d.ts

@@ -1,3 +1,3 @@
 import type { Rule } from 'eslint';
 import { JSXElement } from 'eslint-codemod-utils';
-export declare const updateJSXElementName: (node: JSXElement, newName: string, fixer: Rule.RuleFixer) => (Rule.Fix | null)[];
+export declare const updateJSXElementName: (node: JSXElement, newName: string, fixer: Rule.RuleFixer) => (Rule.Fix | undefined)[];

package/dist/types-ts4.5/rules/utils/get-import-name.d.ts

@@ -0,0 +1,2 @@
+import type { Scope } from 'eslint';
+export declare const getImportName: (scope: Scope.Scope, packageName: string, componentName: string) => string | null;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@atlaskit/eslint-plugin-design-system",
   "description": "The essential plugin for use with the Atlassian Design System.",
-  "version": "8.17.0",
+  "version": "8.18.1",
   "author": "Atlassian Pty Ltd",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"