@atlaskit/eslint-plugin-design-system 10.18.0 → 10.18.1

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

@@ -19,6 +19,22 @@ export type ErrorListAuto = {
 export type GuidanceList = {
     [loc: string]: string;
 };
+export type LegacyIconImportList = {
+    [key: string]: {
+        packageName: string;
+        exported: boolean;
+        importNode: ImportDeclaration;
+        importSpecifier: string;
+    };
+};
+export type MigrationIconImportList = {
+    [key: string]: {
+        packageName: string;
+        exported: boolean;
+        importNode: ImportDeclaration;
+        importSpecifier: string;
+    };
+};
 declare const sizes: readonly ["small", "medium", "large", "xlarge"];
 export type Size = (typeof sizes)[number];
 export declare const isSize: (size: any) => size is "small" | "medium" | "large" | "xlarge";
@@ -47,15 +63,6 @@ export declare const getUpcomingIcons: (iconPackage: string) => {
  * Checks if a new icon can be auto-migrated based on guidance from the migration map
  */
 export declare const canAutoMigrateNewIconBasedOnSize: (guidance?: string) => boolean;
-/**
- *
- * @param iconPackage string
- * @returns object of new icon name and import path
- */
-export declare const getNewIconNameAndImportPath: (iconPackage: string, shouldUseMigrationPath?: boolean) => {
-    iconName?: string;
-    importPath?: string;
-};
 /**
  * Creates the written guidance for migrating a legacy icon to a new icon
  */
@@ -88,7 +95,6 @@ export declare const createAutoMigrationError: ({ node, importSource, iconName,
     shouldAddSpaciousSpacing?: boolean | undefined;
     insideNewButton?: boolean | undefined;
 }) => void;
-export declare const getLiteralStringValue: (value: any) => string | undefined;
 export declare const createHelpers: (context: Rule.RuleContext) => {
     /**
      * Extracts the primaryColor value from a JSXAttribute
@@ -98,7 +104,6 @@ export declare const createHelpers: (context: Rule.RuleContext) => {
     getConfigFlag: (key: string, defaultValue: boolean) => boolean;
 };
 export declare const addToListOfRanges: (node: Node, sortedListOfRangesForErrors: RangeList) => void;
-export declare const isInRangeList: (node: Node, sortedListOfRangesForErrors: RangeList) => boolean;
 /**
  *
  * @param node Icon JSXelement
@@ -113,54 +118,20 @@ export declare const isInsideNewButton: (node: Rule.Node, newButtonImports: Set<
  * @returns if Icon is inside a legacy button
  */
 export declare const isInsideLegacyButton: (node: Rule.Node, legacyButtonImports: Set<string>) => boolean;
-/**
- *
- * Creates a list of fixers to update the icon import path
- * @param metadata Metadata including the import source and spacing
- * @param fixer The original fix function
- * @param legacyImportNode The import declaration node to replace
- * @param shouldUseMigrationPath The eslint rule config, whether to use migration entrypoint or not
- * @param migrationImportNode The migration import declaration node to replace, only present if shouldUseMigrationPath is false
- * @returns A list of fixers to migrate the icon
- */
-export declare const createImportFix: ({ fixer, legacyImportNode, metadata, shouldUseMigrationPath, migrationImportNode, }: {
-    fixer: Rule.RuleFixer;
-    metadata: {
-        importSource: string;
-        spacing: string;
-    };
-    legacyImportNode?: ImportDeclaration | undefined;
-    shouldUseMigrationPath: boolean;
-    migrationImportNode?: ImportDeclaration | undefined;
-}) => Rule.Fix[];
-/**
- * Creates a list of fixers to update the icon props
- * @param node The Icon element to migrate
- * @param metadata Metadata including the import source and spacing
- * @param fixer The original fix function
- * @param legacyImportNode The import declaration node to replace
- * @param shouldUseMigrationPath The eslint rule config, whether to use migration entrypoint or not
- * @param migrationImportNode The migration import declaration node to replace, only present if shouldUseMigrationPath is false
- * @returns A list of fixers to migrate the icon
- */
-export declare const createPropFixes: ({ node, fixer, legacyImportNode, metadata, shouldUseMigrationPath, migrationImportNode, }: {
-    node: Node;
-    fixer: Rule.RuleFixer;
-    metadata: {
-        importSource: string;
-        spacing: string;
-        insideNewButton: string;
-    };
-    legacyImportNode?: ImportDeclaration | undefined;
+export declare const throwManualErrors: ({ errorsManual, errorRanges, guidance, context, isQuietMode, }: {
+    errorsManual: ErrorListManual;
+    errorRanges: RangeList;
+    guidance: GuidanceList;
+    context: Rule.RuleContext;
+    isQuietMode: boolean;
+}) => void;
+export declare const throwAutoErrors: ({ errorsManual, errorsAuto, legacyIconImports, guidance, migrationIconImports, shouldUseMigrationPath, context, }: {
+    errorsManual: ErrorListManual;
+    errorsAuto: ErrorListAuto;
+    legacyIconImports: LegacyIconImportList;
+    guidance: GuidanceList;
+    migrationIconImports: MigrationIconImportList;
     shouldUseMigrationPath: boolean;
-    migrationImportNode?: ImportDeclaration | undefined;
-}) => Rule.Fix[];
-/**
- * Check if the new icon exists in the migration map
- */
-export declare const checkIfNewIconExist: (error: {
-    data?: {
-        importSource?: string;
-    };
-}) => boolean;
+    context: Rule.RuleContext;
+}) => void;
 export {};

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

@@ -19,6 +19,22 @@ export type ErrorListAuto = {
 export type GuidanceList = {
     [loc: string]: string;
 };
+export type LegacyIconImportList = {
+    [key: string]: {
+        packageName: string;
+        exported: boolean;
+        importNode: ImportDeclaration;
+        importSpecifier: string;
+    };
+};
+export type MigrationIconImportList = {
+    [key: string]: {
+        packageName: string;
+        exported: boolean;
+        importNode: ImportDeclaration;
+        importSpecifier: string;
+    };
+};
 declare const sizes: readonly [
     "small",
     "medium",
@@ -52,15 +68,6 @@ export declare const getUpcomingIcons: (iconPackage: string) => {
  * Checks if a new icon can be auto-migrated based on guidance from the migration map
  */
 export declare const canAutoMigrateNewIconBasedOnSize: (guidance?: string) => boolean;
-/**
- *
- * @param iconPackage string
- * @returns object of new icon name and import path
- */
-export declare const getNewIconNameAndImportPath: (iconPackage: string, shouldUseMigrationPath?: boolean) => {
-    iconName?: string;
-    importPath?: string;
-};
 /**
  * Creates the written guidance for migrating a legacy icon to a new icon
  */
@@ -93,7 +100,6 @@ export declare const createAutoMigrationError: ({ node, importSource, iconName,
     shouldAddSpaciousSpacing?: boolean | undefined;
     insideNewButton?: boolean | undefined;
 }) => void;
-export declare const getLiteralStringValue: (value: any) => string | undefined;
 export declare const createHelpers: (context: Rule.RuleContext) => {
     /**
      * Extracts the primaryColor value from a JSXAttribute
@@ -103,7 +109,6 @@ export declare const createHelpers: (context: Rule.RuleContext) => {
     getConfigFlag: (key: string, defaultValue: boolean) => boolean;
 };
 export declare const addToListOfRanges: (node: Node, sortedListOfRangesForErrors: RangeList) => void;
-export declare const isInRangeList: (node: Node, sortedListOfRangesForErrors: RangeList) => boolean;
 /**
  *
  * @param node Icon JSXelement
@@ -118,54 +123,20 @@ export declare const isInsideNewButton: (node: Rule.Node, newButtonImports: Set<
  * @returns if Icon is inside a legacy button
  */
 export declare const isInsideLegacyButton: (node: Rule.Node, legacyButtonImports: Set<string>) => boolean;
-/**
- *
- * Creates a list of fixers to update the icon import path
- * @param metadata Metadata including the import source and spacing
- * @param fixer The original fix function
- * @param legacyImportNode The import declaration node to replace
- * @param shouldUseMigrationPath The eslint rule config, whether to use migration entrypoint or not
- * @param migrationImportNode The migration import declaration node to replace, only present if shouldUseMigrationPath is false
- * @returns A list of fixers to migrate the icon
- */
-export declare const createImportFix: ({ fixer, legacyImportNode, metadata, shouldUseMigrationPath, migrationImportNode, }: {
-    fixer: Rule.RuleFixer;
-    metadata: {
-        importSource: string;
-        spacing: string;
-    };
-    legacyImportNode?: ImportDeclaration | undefined;
-    shouldUseMigrationPath: boolean;
-    migrationImportNode?: ImportDeclaration | undefined;
-}) => Rule.Fix[];
-/**
- * Creates a list of fixers to update the icon props
- * @param node The Icon element to migrate
- * @param metadata Metadata including the import source and spacing
- * @param fixer The original fix function
- * @param legacyImportNode The import declaration node to replace
- * @param shouldUseMigrationPath The eslint rule config, whether to use migration entrypoint or not
- * @param migrationImportNode The migration import declaration node to replace, only present if shouldUseMigrationPath is false
- * @returns A list of fixers to migrate the icon
- */
-export declare const createPropFixes: ({ node, fixer, legacyImportNode, metadata, shouldUseMigrationPath, migrationImportNode, }: {
-    node: Node;
-    fixer: Rule.RuleFixer;
-    metadata: {
-        importSource: string;
-        spacing: string;
-        insideNewButton: string;
-    };
-    legacyImportNode?: ImportDeclaration | undefined;
+export declare const throwManualErrors: ({ errorsManual, errorRanges, guidance, context, isQuietMode, }: {
+    errorsManual: ErrorListManual;
+    errorRanges: RangeList;
+    guidance: GuidanceList;
+    context: Rule.RuleContext;
+    isQuietMode: boolean;
+}) => void;
+export declare const throwAutoErrors: ({ errorsManual, errorsAuto, legacyIconImports, guidance, migrationIconImports, shouldUseMigrationPath, context, }: {
+    errorsManual: ErrorListManual;
+    errorsAuto: ErrorListAuto;
+    legacyIconImports: LegacyIconImportList;
+    guidance: GuidanceList;
+    migrationIconImports: MigrationIconImportList;
     shouldUseMigrationPath: boolean;
-    migrationImportNode?: ImportDeclaration | undefined;
-}) => Rule.Fix[];
-/**
- * Check if the new icon exists in the migration map
- */
-export declare const checkIfNewIconExist: (error: {
-    data?: {
-        importSource?: string;
-    };
-}) => boolean;
+    context: Rule.RuleContext;
+}) => void;
 export {};

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": "10.18.0",
+	"version": "10.18.1",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
 	"publishConfig": {
@@ -64,7 +64,7 @@
 		"@types/eslint": "^8.56.6",
 		"@types/esquery": "^1.5.3",
 		"@types/estraverse": "^5.1.7",
-		"eslint": "^8.49.0",
+		"eslint": "^8.57.0",
 		"jscodeshift": "^0.13.0",
 		"outdent": "^0.5.0",
 		"react": "^16.8.0",