@atlaskit/eslint-plugin-design-system 13.41.2 → 13.42.0

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

@@ -1,85 +0,0 @@
-import { createLintRule } from '../utils/create-rule';
-import { errorBoundary } from '../utils/error-boundary';
-import { createChecks } from './checks';
-import { createHelpers } from './helpers';
-var rule = createLintRule({
-  meta: {
-    name: 'no-legacy-icons',
-    fixable: 'code',
-    hasSuggestions: true,
-    type: 'problem',
-    docs: {
-      description: 'Enforces no legacy icons are used.',
-      recommended: false,
-      severity: 'warn'
-    },
-    schema: [{
-      type: 'object',
-      properties: {
-        shouldErrorForManualMigration: {
-          type: 'boolean'
-        },
-        shouldErrorForAutoMigration: {
-          type: 'boolean'
-        },
-        shouldUseSafeMigrationMode: {
-          type: 'boolean'
-        },
-        quiet: {
-          type: 'boolean'
-        },
-        shouldUseMigrationPath: {
-          type: 'boolean'
-        }
-      },
-      additionalProperties: false
-    }],
-    messages: {
-      noLegacyIconsAutoMigration: "Auto Migration:\nLegacy icon '{{iconName}}' from '{{importSource}}' detected.\nAutomatic migration is possible.\n\n{{guidance}}\nAtlassians: See https://go.atlassian.com/icon-migration-guide for details.'",
-      noLegacyIconsManualMigration: "Manual Migration:\nLegacy icon '{{iconName}}' from '{{importSource}}' detected.\nAutomatic migration not possible.\n\n{{guidance}}\nAtlassians: See https://go.atlassian.com/icon-migration-guide for details.",
-      cantFindSuitableReplacement: "No suitable replacement found for '{{iconName}}' from '{{importSource}}'{{sizeGuidance}}. Please manually migrate this icon.",
-      cantMigrateReExport: "'{{exportName}}' is a re-export of icon from '{{packageName}}' and cannot be automatically migrated. Please remove this re-export, and migrate any usages to the new icon APIs.",
-      cantMigrateColor: "This icon's `primaryColor` prop is set to {{colorValue}}, which isn't a design token supported in the new Icon API. Please switch to an appropriate `color.icon`, `color.link` or `color.text` token, or currentColor in buttons and menus.",
-      cantMigrateSpreadProps: "This usage of Icon uses spread props in a way that can't be automatically migrated. Please explicitly define the following props after spread in order to auto-migrate: '{{missingProps}}' ",
-      cantMigrateSizeUnknown: "This usage of Icon sets the size via a variable or function that can't be automatically migrated. Please migrate manually to the correct `LEGACY_size` and `spacing` props.",
-      cantMigrateFunctionUnknown: "Icon '{{iconName}}', from entrypoint '{{importSource}}', is passed into a function/component and can't be migrated automatically. Please manually migrate this icon.",
-      cantMigrateIdentifierMapOrArray: "This icon is passed to other components via a map or array, and can't be migrated automatically. Please manually migrate wherever this expression is used to the new API, or use the icon components directly.",
-      cantMigrateIdentifier: "This reference to {{iconName}} from {{iconSource}} can't be migrated automatically to the new components and API. Please manually migrate this and any other references."
-    }
-  },
-  create: function create(context) {
-    var _createHelpers = createHelpers(context),
-      getConfigFlag = _createHelpers.getConfigFlag;
-    var failSilently = getConfigFlag('failSilently', false);
-    var _createChecks = createChecks(context),
-      checkImportDeclarations = _createChecks.checkImportDeclarations,
-      checkVariableDeclarations = _createChecks.checkVariableDeclarations,
-      checkExportDefaultDeclaration = _createChecks.checkExportDefaultDeclaration,
-      checkExportNamedVariables = _createChecks.checkExportNamedVariables,
-      checkArrayOrMap = _createChecks.checkArrayOrMap,
-      checkIconAsProp = _createChecks.checkIconAsProp,
-      checkJSXElement = _createChecks.checkJSXElement,
-      checkCallExpression = _createChecks.checkCallExpression,
-      throwErrors = _createChecks.throwErrors,
-      checkIconReference = _createChecks.checkIconReference;
-    return errorBoundary({
-      // Track imports of relevant components
-      ImportDeclaration: checkImportDeclarations,
-      // Keep track of the relevant variable declarations and renames
-      VariableDeclaration: checkVariableDeclarations,
-      // Case: default re-exports. Can't be auto-migrated
-      ExportDefaultDeclaration: checkExportDefaultDeclaration,
-      ExportNamedDeclaration: checkExportNamedVariables,
-      // Legacy icons found in arrays/objects
-      'ObjectExpression > Property > Identifier, ArrayExpression > Identifier ': checkArrayOrMap,
-      // Legacy icons passed in via props, as JSX identifier (i.e. icon={AddIcon})
-      'JSXOpeningElement > JSXAttribute > JSXExpressionContainer > Identifier': checkIconAsProp,
-      JSXElement: checkJSXElement,
-      // Icons called as an argument of a function (i.e. icon={DefaultIcon(AddIcon)})
-      CallExpression: checkCallExpression,
-      Identifier: checkIconReference,
-      'Program:exit': throwErrors
-    }, failSilently);
-  }
-});
-export default rule;

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

@@ -1 +0,0 @@
-export var upcomingIcons = [];

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

@@ -1,16 +0,0 @@
-import type { Rule } from 'eslint';
-import { type CallExpression, type ExportDefaultDeclaration, type ExportNamedDeclaration, type Identifier, type ImportDeclaration, type VariableDeclaration } from 'eslint-codemod-utils';
-type ReturnObject = {
-    checkImportDeclarations: (node: ImportDeclaration & Rule.NodeParentExtension) => void;
-    checkVariableDeclarations: (node: VariableDeclaration & Rule.NodeParentExtension) => void;
-    checkExportDefaultDeclaration: (node: ExportDefaultDeclaration & Rule.NodeParentExtension) => void;
-    checkExportNamedVariables: (node: ExportNamedDeclaration & Rule.NodeParentExtension) => void;
-    checkArrayOrMap: (node: Identifier) => void;
-    checkIconAsProp: (node: Identifier) => void;
-    checkIconReference: (node: Identifier & Rule.NodeParentExtension) => void;
-    checkJSXElement: (node: Rule.Node) => void;
-    checkCallExpression: (node: CallExpression & Rule.NodeParentExtension) => void;
-    throwErrors: () => void;
-};
-export declare const createChecks: (context: Rule.RuleContext) => ReturnObject;
-export {};

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

@@ -1,151 +0,0 @@
-import type { Rule } from 'eslint';
-import { type ImportDeclaration, type JSXAttribute, type Node } from 'eslint-codemod-utils';
-import { type IconMigrationSizeGuidance } from '@atlaskit/icon/migration-map';
-export type IconMigrationError = Rule.ReportDescriptor;
-export type RangeList = {
-    start: number;
-    end: number;
-}[];
-export type ErrorListManual = {
-    [loc: string]: {
-        errors: IconMigrationError[];
-        iconName: string;
-        importSource: string;
-    };
-};
-export type ErrorListAuto = {
-    [loc: string]: IconMigrationError;
-};
-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 Size;
-/**
- * Returns the migration map object for a legacy icon or null if not found
- * @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) => {
-    newIcon?: {
-        name: string;
-        package: string;
-        isMigrationUnsafe?: boolean;
-        shouldForceSmallIcon?: boolean;
-    };
-    additionalIcons?: {
-        name: string;
-        package: string;
-    }[];
-    sizeGuidance: Record<Size, IconMigrationSizeGuidance>;
-} | null;
-export declare const getUpcomingIcons: (iconPackage: string) => {
-    sizeGuidance: Record<Size, IconMigrationSizeGuidance>;
-} | null;
-/**
- * Checks if a new icon can be auto-migrated based on guidance from the migration map
- */
-export declare const canAutoMigrateNewIconBasedOnSize: (guidance?: IconMigrationSizeGuidance) => boolean;
-/**
- * Creates the written guidance for migrating a legacy icon to a new icon
- */
-export declare const createGuidance: (props: {
-    iconPackage: string;
-    insideNewButton?: boolean;
-    size?: Size;
-    shouldUseMigrationPath?: boolean;
-    shouldForceSmallIcon?: boolean;
-}) => string;
-/**
- * Checks if the color can be migrated
- * @param color String representing the color to check
- * @returns True if the color can be migrated, false otherwise
- */
-export declare const canMigrateColor: (color: string) => boolean;
-export declare const locToString: (node: Node) => string;
-export declare const createCantMigrateReExportError: (node: Node, packageName: string, exportName: string, errors: ErrorListManual) => void;
-export declare const createCantMigrateIdentifierMapOrArrayError: (node: Node, packageName: string, exportName: string, errors: ErrorListManual) => void;
-export declare const createCantMigrateIdentifierError: (node: Node, packageName: string, exportName: string, errors: ErrorListManual) => void;
-export declare const createCantFindSuitableReplacementError: (node: Node, importSource: string, iconName: string, errors: ErrorListManual, sizeIssue?: boolean) => void;
-export declare const createCantMigrateFunctionUnknownError: (node: Node, importSource: string, iconName: string, errors: ErrorListManual) => void;
-export declare const createCantMigrateColorError: (node: Node, colorValue: string, errors: ErrorListManual, importSource: string, iconName: string) => void;
-export declare const createCantMigrateSpreadPropsError: (node: Node, missingProps: string[], errors: ErrorListManual, importSource: string, iconName: string) => void;
-export declare const createCantMigrateSizeUnknown: (node: Node, errors: ErrorListManual, importSource: string, iconName: string) => void;
-export declare const createAutoMigrationError: ({ node, importSource, iconName, errors, spacing, insideNewButton, shouldForceSmallIcon, }: {
-    node: Node;
-    importSource: string;
-    iconName: string;
-    errors: ErrorListAuto;
-    spacing?: string;
-    insideNewButton?: boolean;
-    shouldForceSmallIcon?: boolean;
-}) => void;
-export declare const createHelpers: (ctx: Rule.RuleContext) => {
-    /**
-     * Extracts the primaryColor value from a JSXAttribute
-     */
-    getPrimaryColor(attr: JSXAttribute): string | null;
-    getTokenCallValue: (value: any) => string | undefined;
-    getConfigFlag: (key: string, defaultValue: boolean) => boolean;
-};
-export declare const addToListOfRanges: (node: Node, sortedListOfRangesForErrors: RangeList) => void;
-/**
- *
- * @param node Icon JSXelement
- * @param newButtonImports list of new button import specifiers
- * @returns if Icon is inside a new button
- */
-export declare const isInsideNewButton: (node: Rule.Node, newButtonImports: Set<string>) => boolean;
-/**
- *
- * @param node Icon JSXelement
- * @param newButtonImports list of legacy button import specifiers
- * @returns if Icon is inside a legacy button
- */
-export declare const isInsideLegacyButton: (node: Rule.Node, legacyButtonImports: Set<string>) => boolean;
-/**
- *
- * @param node Icon JSXelement
- * @param newButtonImports list of legacy button import specifiers
- * @returns if Icon is inside a legacy button
- */
-export declare const isInsideIconOnlyLegacyButton: (node: Rule.Node, legacyButtonImports: Set<string>) => boolean;
-export declare const getComponentName: (name: string) => string;
-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, iconSizesInfo, legacyIconImports, guidance, migrationIconImports, shouldUseMigrationPath, context, }: {
-    errorsManual: ErrorListManual;
-    errorsAuto: ErrorListAuto;
-    iconSizesInfo: Record<string, {
-        small: string[];
-        usageCount: number;
-    }>;
-    legacyIconImports: LegacyIconImportList;
-    guidance: GuidanceList;
-    migrationIconImports: MigrationIconImportList;
-    shouldUseMigrationPath: boolean;
-    context: Rule.RuleContext;
-}) => void;
-export {};

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

@@ -1,2 +0,0 @@
-declare const rule: import('eslint').Rule.RuleModule;
-export default rule;

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

@@ -1 +0,0 @@
-export declare const upcomingIcons: string[];

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

@@ -1,16 +0,0 @@
-import type { Rule } from 'eslint';
-import { type CallExpression, type ExportDefaultDeclaration, type ExportNamedDeclaration, type Identifier, type ImportDeclaration, type VariableDeclaration } from 'eslint-codemod-utils';
-type ReturnObject = {
-    checkImportDeclarations: (node: ImportDeclaration & Rule.NodeParentExtension) => void;
-    checkVariableDeclarations: (node: VariableDeclaration & Rule.NodeParentExtension) => void;
-    checkExportDefaultDeclaration: (node: ExportDefaultDeclaration & Rule.NodeParentExtension) => void;
-    checkExportNamedVariables: (node: ExportNamedDeclaration & Rule.NodeParentExtension) => void;
-    checkArrayOrMap: (node: Identifier) => void;
-    checkIconAsProp: (node: Identifier) => void;
-    checkIconReference: (node: Identifier & Rule.NodeParentExtension) => void;
-    checkJSXElement: (node: Rule.Node) => void;
-    checkCallExpression: (node: CallExpression & Rule.NodeParentExtension) => void;
-    throwErrors: () => void;
-};
-export declare const createChecks: (context: Rule.RuleContext) => ReturnObject;
-export {};

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

@@ -1,156 +0,0 @@
-import type { Rule } from 'eslint';
-import { type ImportDeclaration, type JSXAttribute, type Node } from 'eslint-codemod-utils';
-import { type IconMigrationSizeGuidance } from '@atlaskit/icon/migration-map';
-export type IconMigrationError = Rule.ReportDescriptor;
-export type RangeList = {
-    start: number;
-    end: number;
-}[];
-export type ErrorListManual = {
-    [loc: string]: {
-        errors: IconMigrationError[];
-        iconName: string;
-        importSource: string;
-    };
-};
-export type ErrorListAuto = {
-    [loc: string]: IconMigrationError;
-};
-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 Size;
-/**
- * Returns the migration map object for a legacy icon or null if not found
- * @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) => {
-    newIcon?: {
-        name: string;
-        package: string;
-        isMigrationUnsafe?: boolean;
-        shouldForceSmallIcon?: boolean;
-    };
-    additionalIcons?: {
-        name: string;
-        package: string;
-    }[];
-    sizeGuidance: Record<Size, IconMigrationSizeGuidance>;
-} | null;
-export declare const getUpcomingIcons: (iconPackage: string) => {
-    sizeGuidance: Record<Size, IconMigrationSizeGuidance>;
-} | null;
-/**
- * Checks if a new icon can be auto-migrated based on guidance from the migration map
- */
-export declare const canAutoMigrateNewIconBasedOnSize: (guidance?: IconMigrationSizeGuidance) => boolean;
-/**
- * Creates the written guidance for migrating a legacy icon to a new icon
- */
-export declare const createGuidance: (props: {
-    iconPackage: string;
-    insideNewButton?: boolean;
-    size?: Size;
-    shouldUseMigrationPath?: boolean;
-    shouldForceSmallIcon?: boolean;
-}) => string;
-/**
- * Checks if the color can be migrated
- * @param color String representing the color to check
- * @returns True if the color can be migrated, false otherwise
- */
-export declare const canMigrateColor: (color: string) => boolean;
-export declare const locToString: (node: Node) => string;
-export declare const createCantMigrateReExportError: (node: Node, packageName: string, exportName: string, errors: ErrorListManual) => void;
-export declare const createCantMigrateIdentifierMapOrArrayError: (node: Node, packageName: string, exportName: string, errors: ErrorListManual) => void;
-export declare const createCantMigrateIdentifierError: (node: Node, packageName: string, exportName: string, errors: ErrorListManual) => void;
-export declare const createCantFindSuitableReplacementError: (node: Node, importSource: string, iconName: string, errors: ErrorListManual, sizeIssue?: boolean) => void;
-export declare const createCantMigrateFunctionUnknownError: (node: Node, importSource: string, iconName: string, errors: ErrorListManual) => void;
-export declare const createCantMigrateColorError: (node: Node, colorValue: string, errors: ErrorListManual, importSource: string, iconName: string) => void;
-export declare const createCantMigrateSpreadPropsError: (node: Node, missingProps: string[], errors: ErrorListManual, importSource: string, iconName: string) => void;
-export declare const createCantMigrateSizeUnknown: (node: Node, errors: ErrorListManual, importSource: string, iconName: string) => void;
-export declare const createAutoMigrationError: ({ node, importSource, iconName, errors, spacing, insideNewButton, shouldForceSmallIcon, }: {
-    node: Node;
-    importSource: string;
-    iconName: string;
-    errors: ErrorListAuto;
-    spacing?: string;
-    insideNewButton?: boolean;
-    shouldForceSmallIcon?: boolean;
-}) => void;
-export declare const createHelpers: (ctx: Rule.RuleContext) => {
-    /**
-     * Extracts the primaryColor value from a JSXAttribute
-     */
-    getPrimaryColor(attr: JSXAttribute): string | null;
-    getTokenCallValue: (value: any) => string | undefined;
-    getConfigFlag: (key: string, defaultValue: boolean) => boolean;
-};
-export declare const addToListOfRanges: (node: Node, sortedListOfRangesForErrors: RangeList) => void;
-/**
- *
- * @param node Icon JSXelement
- * @param newButtonImports list of new button import specifiers
- * @returns if Icon is inside a new button
- */
-export declare const isInsideNewButton: (node: Rule.Node, newButtonImports: Set<string>) => boolean;
-/**
- *
- * @param node Icon JSXelement
- * @param newButtonImports list of legacy button import specifiers
- * @returns if Icon is inside a legacy button
- */
-export declare const isInsideLegacyButton: (node: Rule.Node, legacyButtonImports: Set<string>) => boolean;
-/**
- *
- * @param node Icon JSXelement
- * @param newButtonImports list of legacy button import specifiers
- * @returns if Icon is inside a legacy button
- */
-export declare const isInsideIconOnlyLegacyButton: (node: Rule.Node, legacyButtonImports: Set<string>) => boolean;
-export declare const getComponentName: (name: string) => string;
-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, iconSizesInfo, legacyIconImports, guidance, migrationIconImports, shouldUseMigrationPath, context, }: {
-    errorsManual: ErrorListManual;
-    errorsAuto: ErrorListAuto;
-    iconSizesInfo: Record<string, {
-        small: string[];
-        usageCount: number;
-    }>;
-    legacyIconImports: LegacyIconImportList;
-    guidance: GuidanceList;
-    migrationIconImports: MigrationIconImportList;
-    shouldUseMigrationPath: boolean;
-    context: Rule.RuleContext;
-}) => void;
-export {};

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

@@ -1,2 +0,0 @@
-declare const rule: import('eslint').Rule.RuleModule;
-export default rule;

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

@@ -1 +0,0 @@
-export declare const upcomingIcons: string[];