@atlaskit/eslint-plugin-design-system 10.8.1 → 10.9.0

package/dist/esm/rules/use-tokens-typography/index.js

@@ -1,6 +1,6 @@
 import { createLintRule } from '../utils/create-rule';
+import { errorBoundary } from '../utils/error-boundary';
 import { getConfig, ruleSchema } from './config';
-import { errorBoundary } from './error-boundary';
 import { StyleObject } from './transformers/style-object';
 var create = function create(context) {
   var config = getConfig(context.options[0]);

package/dist/types/rules/consistent-css-prop-usage/types.d.ts

@@ -6,4 +6,5 @@ export type RuleConfig = {
     xcssImportSource: ImportSource;
     excludeReactComponents: boolean;
     autoFix: boolean;
+    shouldAlwaysCheckXcss: boolean;
 };

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

@@ -0,0 +1,13 @@
+import type { Rule } from 'eslint';
+import { type CallExpression, type ExportDefaultDeclaration, type ExportNamedDeclaration, type Identifier, type ImportDeclaration, type VariableDeclaration } from 'eslint-codemod-utils';
+export declare const createChecks: (context: Rule.RuleContext) => {
+    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;
+    checkJSXElement: (node: Rule.Node) => void;
+    checkCallExpression: (node: CallExpression & Rule.NodeParentExtension) => void;
+    throwErrors: () => void;
+};

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

@@ -0,0 +1,82 @@
+import type { Rule } from 'eslint';
+import { type JSXAttribute, type JSXOpeningElement, type Node } from 'eslint-codemod-utils';
+import { type Size } from './migration-map-temp';
+export type iconMigrationError = Rule.ReportDescriptor;
+export type errorsListManual = {
+    [loc: string]: {
+        errors: iconMigrationError[];
+        iconName: string;
+        importSource: string;
+    };
+};
+export type errorsListAuto = {
+    [loc: string]: iconMigrationError;
+};
+export type guidanceList = {
+    [loc: string]: string;
+};
+/**
+ * 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) => {
+    sizeGuidance: {
+        small: string;
+        medium: string;
+        large: string;
+        xlarge: string;
+    };
+    newIcon?: {
+        name: string;
+        type: string;
+        library: string;
+    } | undefined;
+} | null;
+/**
+ * Returns the key of a legacy icon
+ * @param iconPackage The name of the legacy icon package
+ * @returns The unique identifier for the icon (the part after "@atlaskit/icon/glyph")
+ */
+export declare const getIconKey: (iconPackage: string) => string;
+/**
+ * Checks if a new icon can be auto-migrated based on guidance from the migration map
+ */
+export declare const canAutoMigrateNewIconBasedOnSize: (guidance?: string) => boolean;
+/**
+ * Creates the written guidance for migrating a legacy icon to a new icon
+ */
+export declare const createGuidance: (iconPackage: string, size?: Size) => 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: errorsListManual) => void;
+export declare const createCantMigrateIdentifierError: (node: Node, packageName: string, exportName: string, errors: errorsListManual) => void;
+export declare const findUNSAFEProp: (iconAttr: JSXAttribute, button: JSXOpeningElement) => {
+    UNSAFE_size: "small" | "large" | "xlarge" | null;
+    UNSAFE_propName: "UNSAFE_iconAfter_size" | "UNSAFE_iconBefore_size" | "UNSAFE_size" | null;
+};
+export declare const createCantMigrateUnsafeProp: (node: Node, propName: string, value: string, packageName: string, iconName: string, errors: errorsListManual) => void;
+export declare const createCantFindSuitableReplacementError: (node: Node, importSource: string, iconName: string, errors: errorsListManual) => void;
+export declare const createCantMigrateFunctionUnknownError: (node: Node, importSource: string, iconName: string, errors: errorsListManual) => void;
+export declare const createCantMigrateColorError: (node: Node, colorValue: string, errors: errorsListManual, importSource: string, iconName: string) => void;
+export declare const createCantMigrateSpreadPropsError: (node: Node, missingProps: string[], errors: errorsListManual, importSource: string, iconName: string) => void;
+export declare const createCantMigrateSizeUnknown: (node: Node, errors: errorsListManual, importSource: string, iconName: string) => void;
+export declare const createAutoMigrationError: (node: Node, importSource: string, iconName: string, newIcon: {
+    name: string;
+    type: string;
+    library: string;
+}, oldIconName: string, errors: errorsListAuto) => void;
+export declare const getLiteralStringValue: (value: any) => string | undefined;
+export declare const createHelpers: (context: 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;
+};

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

@@ -1,2 +1,3 @@
-declare const rule: import("eslint").Rule.RuleModule;
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
 export default rule;

package/dist/types/rules/no-legacy-icons/migration-map-temp.d.ts

@@ -0,0 +1,22 @@
+export declare const outcomeDescriptionMap: {
+    [key: string]: string;
+};
+export 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";
+declare const migrationMap: {
+    [lib: string]: {
+        sizeGuidance: {
+            small: string;
+            medium: string;
+            large: string;
+            xlarge: string;
+        };
+        newIcon?: {
+            name: string;
+            type: string;
+            library: string;
+        };
+    };
+};
+export default migrationMap;

package/dist/{types-ts4.5/rules/use-tokens-typography → types/rules/utils}/error-boundary.d.ts

@@ -1,4 +1,7 @@
-import { type RuleConfig } from './config';
+type RuleConfig = {
+    failSilently?: boolean;
+    shouldEnforceFallbacks?: boolean;
+};
 /**
  * ESLint rules should NEVER throw exceptions, because that breaks the VSCode ESLint server
  * (and probably the IntelliJ one too), which causes linting to fail in a file.
@@ -9,3 +12,4 @@ import { type RuleConfig } from './config';
 export declare const errorBoundary: (func: () => void, { config }: {
     config: RuleConfig;
 }) => void;
+export {};

package/dist/types-ts4.5/rules/consistent-css-prop-usage/types.d.ts

@@ -6,4 +6,5 @@ export type RuleConfig = {
     xcssImportSource: ImportSource;
     excludeReactComponents: boolean;
     autoFix: boolean;
+    shouldAlwaysCheckXcss: boolean;
 };

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

@@ -0,0 +1,13 @@
+import type { Rule } from 'eslint';
+import { type CallExpression, type ExportDefaultDeclaration, type ExportNamedDeclaration, type Identifier, type ImportDeclaration, type VariableDeclaration } from 'eslint-codemod-utils';
+export declare const createChecks: (context: Rule.RuleContext) => {
+    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;
+    checkJSXElement: (node: Rule.Node) => void;
+    checkCallExpression: (node: CallExpression & Rule.NodeParentExtension) => void;
+    throwErrors: () => void;
+};

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

@@ -0,0 +1,82 @@
+import type { Rule } from 'eslint';
+import { type JSXAttribute, type JSXOpeningElement, type Node } from 'eslint-codemod-utils';
+import { type Size } from './migration-map-temp';
+export type iconMigrationError = Rule.ReportDescriptor;
+export type errorsListManual = {
+    [loc: string]: {
+        errors: iconMigrationError[];
+        iconName: string;
+        importSource: string;
+    };
+};
+export type errorsListAuto = {
+    [loc: string]: iconMigrationError;
+};
+export type guidanceList = {
+    [loc: string]: string;
+};
+/**
+ * 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) => {
+    sizeGuidance: {
+        small: string;
+        medium: string;
+        large: string;
+        xlarge: string;
+    };
+    newIcon?: {
+        name: string;
+        type: string;
+        library: string;
+    } | undefined;
+} | null;
+/**
+ * Returns the key of a legacy icon
+ * @param iconPackage The name of the legacy icon package
+ * @returns The unique identifier for the icon (the part after "@atlaskit/icon/glyph")
+ */
+export declare const getIconKey: (iconPackage: string) => string;
+/**
+ * Checks if a new icon can be auto-migrated based on guidance from the migration map
+ */
+export declare const canAutoMigrateNewIconBasedOnSize: (guidance?: string) => boolean;
+/**
+ * Creates the written guidance for migrating a legacy icon to a new icon
+ */
+export declare const createGuidance: (iconPackage: string, size?: Size) => 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: errorsListManual) => void;
+export declare const createCantMigrateIdentifierError: (node: Node, packageName: string, exportName: string, errors: errorsListManual) => void;
+export declare const findUNSAFEProp: (iconAttr: JSXAttribute, button: JSXOpeningElement) => {
+    UNSAFE_size: "small" | "large" | "xlarge" | null;
+    UNSAFE_propName: "UNSAFE_iconAfter_size" | "UNSAFE_iconBefore_size" | "UNSAFE_size" | null;
+};
+export declare const createCantMigrateUnsafeProp: (node: Node, propName: string, value: string, packageName: string, iconName: string, errors: errorsListManual) => void;
+export declare const createCantFindSuitableReplacementError: (node: Node, importSource: string, iconName: string, errors: errorsListManual) => void;
+export declare const createCantMigrateFunctionUnknownError: (node: Node, importSource: string, iconName: string, errors: errorsListManual) => void;
+export declare const createCantMigrateColorError: (node: Node, colorValue: string, errors: errorsListManual, importSource: string, iconName: string) => void;
+export declare const createCantMigrateSpreadPropsError: (node: Node, missingProps: string[], errors: errorsListManual, importSource: string, iconName: string) => void;
+export declare const createCantMigrateSizeUnknown: (node: Node, errors: errorsListManual, importSource: string, iconName: string) => void;
+export declare const createAutoMigrationError: (node: Node, importSource: string, iconName: string, newIcon: {
+    name: string;
+    type: string;
+    library: string;
+}, oldIconName: string, errors: errorsListAuto) => void;
+export declare const getLiteralStringValue: (value: any) => string | undefined;
+export declare const createHelpers: (context: 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;
+};

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

@@ -1,2 +1,3 @@
-declare const rule: import("eslint").Rule.RuleModule;
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
 export default rule;

package/dist/types-ts4.5/rules/no-legacy-icons/migration-map-temp.d.ts

@@ -0,0 +1,27 @@
+export declare const outcomeDescriptionMap: {
+    [key: string]: string;
+};
+export 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";
+declare const migrationMap: {
+    [lib: string]: {
+        sizeGuidance: {
+            small: string;
+            medium: string;
+            large: string;
+            xlarge: string;
+        };
+        newIcon?: {
+            name: string;
+            type: string;
+            library: string;
+        };
+    };
+};
+export default migrationMap;

package/dist/types-ts4.5/rules/{ensure-design-token-usage → utils}/error-boundary.d.ts

@@ -1,4 +1,7 @@
-import { type RuleConfig } from './types';
+type RuleConfig = {
+    failSilently?: boolean;
+    shouldEnforceFallbacks?: boolean;
+};
 /**
  * ESLint rules should NEVER throw exceptions, because that breaks the VSCode ESLint server
  * (and probably the IntelliJ one too), which causes linting to fail in a file.
@@ -9,3 +12,4 @@ import { type RuleConfig } from './types';
 export declare const errorBoundary: (func: () => void, { config }: {
     config: RuleConfig;
 }) => 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.8.1",
+	"version": "10.9.0",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
 	"publishConfig": {

package/dist/cjs/rules/use-tokens-typography/error-boundary.js

@@ -1,24 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.errorBoundary = void 0;
-/**
- * ESLint rules should NEVER throw exceptions, because that breaks the VSCode ESLint server
- * (and probably the IntelliJ one too), which causes linting to fail in a file.
- *
- * It also breaks CI, which was the reason this error boundary was added. It's a final
- * catch all.
- */
-var errorBoundary = exports.errorBoundary = function errorBoundary(func, _ref) {
-  var config = _ref.config;
-  try {
-    func();
-  } catch (err) {
-    if (!config.failSilently) {
-      // eslint-disable-next-line no-console
-      console.warn(err);
-    }
-  }
-};

package/dist/es2019/rules/use-tokens-typography/error-boundary.js

@@ -1,19 +0,0 @@
-/**
- * ESLint rules should NEVER throw exceptions, because that breaks the VSCode ESLint server
- * (and probably the IntelliJ one too), which causes linting to fail in a file.
- *
- * It also breaks CI, which was the reason this error boundary was added. It's a final
- * catch all.
- */
-export const errorBoundary = (func, {
-  config
-}) => {
-  try {
-    func();
-  } catch (err) {
-    if (!config.failSilently) {
-      // eslint-disable-next-line no-console
-      console.warn(err);
-    }
-  }
-};

package/dist/esm/rules/use-tokens-typography/error-boundary.js

@@ -1,18 +0,0 @@
-/**
- * ESLint rules should NEVER throw exceptions, because that breaks the VSCode ESLint server
- * (and probably the IntelliJ one too), which causes linting to fail in a file.
- *
- * It also breaks CI, which was the reason this error boundary was added. It's a final
- * catch all.
- */
-export var errorBoundary = function errorBoundary(func, _ref) {
-  var config = _ref.config;
-  try {
-    func();
-  } catch (err) {
-    if (!config.failSilently) {
-      // eslint-disable-next-line no-console
-      console.warn(err);
-    }
-  }
-};

package/dist/types/rules/ensure-design-token-usage/error-boundary.d.ts

@@ -1,11 +0,0 @@
-import { type RuleConfig } from './types';
-/**
- * ESLint rules should NEVER throw exceptions, because that breaks the VSCode ESLint server
- * (and probably the IntelliJ one too), which causes linting to fail in a file.
- *
- * It also breaks CI, which was the reason this error boundary was added. It's a final
- * catch all.
- */
-export declare const errorBoundary: (func: () => void, { config }: {
-    config: RuleConfig;
-}) => void;

package/dist/types/rules/use-tokens-typography/error-boundary.d.ts

@@ -1,11 +0,0 @@
-import { type RuleConfig } from './config';
-/**
- * ESLint rules should NEVER throw exceptions, because that breaks the VSCode ESLint server
- * (and probably the IntelliJ one too), which causes linting to fail in a file.
- *
- * It also breaks CI, which was the reason this error boundary was added. It's a final
- * catch all.
- */
-export declare const errorBoundary: (func: () => void, { config }: {
-    config: RuleConfig;
-}) => void;