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

package/dist/esm/rules/use-latest-xcss-syntax-typography/linters/index.js

@@ -1 +1,2 @@
-export { BannedProperty } from './banned-property';
+export { RestrictedProperty } from './restricted-property';
+export { WrappedTokenValue } from './wrapped-token-value';

package/dist/esm/rules/use-latest-xcss-syntax-typography/linters/{banned-property/index.js → restricted-property.js}

@@ -4,10 +4,14 @@ function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len
 /* eslint-disable @repo/internal/react/require-jsdoc */
 
 import { isNodeOfType } from 'eslint-codemod-utils';
-export var BannedProperty = {
+export var RestrictedProperty = {
   lint: function lint(node, _ref) {
-    var context = _ref.context;
-    if (BannedProperty._check(node)) {
+    var context = _ref.context,
+      config = _ref.config;
+    if (RestrictedProperty._check(node, {
+      context: context,
+      config: config
+    })) {
       var property = 'fontSize, lineHeight, fontWeight or letterSpacing';
       if (isNodeOfType(node, 'Identifier')) {
         property = node.name;
@@ -16,14 +20,19 @@ export var BannedProperty = {
       }
       context.report({
         node: node,
-        messageId: 'noUnsafeTypographyProperties',
+        messageId: property === 'fontWeight' ? 'noRestrictedTypographyPropertiesHeading' : 'noRestrictedTypographyProperties',
         data: {
           property: property
         }
       });
     }
   },
-  _check: function _check(node) {
+  _check: function _check(node, _ref2) {
+    var config = _ref2.config;
+    if (!config.patterns.includes('restricted-property')) {
+      return false;
+    }
+
     // Prevent font weight being used in combination with heading tokens
     if (isNodeOfType(node, 'Identifier') && node.name === 'fontWeight' || isNodeOfType(node, 'Literal') && node.value === 'fontWeight') {
       if (isNodeOfType(node.parent.parent, 'ObjectExpression')) {
@@ -31,11 +40,22 @@ export var BannedProperty = {
           _step;
         try {
           for (_iterator.s(); !(_step = _iterator.n()).done;) {
+            var _property$value$value;
             var property = _step.value;
-            if (isNodeOfType(property, 'Property') && isNodeOfType(property.value, 'CallExpression') && isNodeOfType(property.value.callee, 'Identifier') && isNodeOfType(property.value.arguments[0], 'Literal')) {
-              if (property.value.callee.name === 'token' && typeof property.value.arguments[0].value === 'string' && property.value.arguments[0].value.includes('font.heading')) {
-                return true;
-              }
+            // Only looking for heading token on `font` property
+            var isFontProperty = isNodeOfType(property, 'Property') && (isNodeOfType(property.key, 'Literal') && property.key.value === 'font' || isNodeOfType(property.key, 'Identifier') && property.key.name === 'font');
+            if (!isFontProperty) {
+              continue;
+            }
+
+            // Checking for heading token string, for example xcss({ font: 'font.heading.medium' })
+            if (isNodeOfType(property.value, 'Literal') && typeof property.value.value === 'string' && (_property$value$value = property.value.value) !== null && _property$value$value !== void 0 && _property$value$value.startsWith('font.heading')) {
+              return true;
+            }
+
+            // Checking for wrapped heading token, for example xcss({ font: token('font.heading.medium') })
+            if (isNodeOfType(property.value, 'CallExpression') && isNodeOfType(property.value.callee, 'Identifier') && property.value.callee.name === 'token' && isNodeOfType(property.value.arguments[0], 'Literal') && typeof property.value.arguments[0].value === 'string' && property.value.arguments[0].value.startsWith('font.heading')) {
+              return true;
             }
           }
         } catch (err) {

package/dist/esm/rules/use-latest-xcss-syntax-typography/linters/wrapped-token-value.js

@@ -0,0 +1,44 @@
+/* eslint-disable @repo/internal/react/require-jsdoc */
+
+import { isNodeOfType } from 'eslint-codemod-utils';
+var messageId = 'noWrappedTokenTypographyValues';
+export var WrappedTokenValue = {
+  lint: function lint(node, _ref) {
+    var context = _ref.context,
+      config = _ref.config;
+    if (WrappedTokenValue._check(node, {
+      context: context,
+      config: config
+    })) {
+      context.report({
+        node: node,
+        messageId: messageId,
+        fix: WrappedTokenValue._fix(node)
+      });
+    }
+  },
+  _check: function _check(node, _ref2) {
+    var config = _ref2.config;
+    if (!config.patterns.includes('wrapped-token-value')) {
+      return false;
+    }
+    if (isNodeOfType(node.parent, 'Property') && isNodeOfType(node.parent.value, 'CallExpression') && isNodeOfType(node.parent.value.callee, 'Identifier') && node.parent.value.callee.name === 'token' && node.parent.value.arguments.length >= 1) {
+      return true;
+    }
+    return false;
+  },
+  _fix: function _fix(node) {
+    return function (fixer) {
+      var wrappedTokenFix;
+      if (isNodeOfType(node.parent, 'Property') && isNodeOfType(node.parent.value, 'CallExpression') && node.parent.value.arguments.length >= 1) {
+        var firstArg = node.parent.value.arguments[0];
+        if (isNodeOfType(firstArg, 'Literal') && typeof firstArg.value === 'string') {
+          wrappedTokenFix = fixer.replaceText(node.parent.value, "'".concat(firstArg.value, "'"));
+        }
+      }
+      return [wrappedTokenFix].filter(function (fix) {
+        return Boolean(fix);
+      }); // Some of the transformers can return arrays with undefined, so filter them out
+    };
+  }
+};

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/rules/use-latest-xcss-syntax-typography/config/index.d.ts

@@ -1,4 +1,7 @@
+type Pattern = 'restricted-property' | 'wrapped-token-value';
 export interface RuleConfig {
     failSilently: boolean;
+    patterns: Pattern[];
 }
 export declare const getConfig: (overrides: Partial<RuleConfig>) => RuleConfig;
+export {};

package/dist/types/rules/use-latest-xcss-syntax-typography/linters/common.d.ts

@@ -0,0 +1,6 @@
+import type { Rule } from 'eslint';
+import { type RuleConfig } from '../config';
+export type MetaData = {
+    context: Rule.RuleContext;
+    config: RuleConfig;
+};

package/dist/types/rules/use-latest-xcss-syntax-typography/linters/index.d.ts

@@ -1 +1,2 @@
-export { BannedProperty } from './banned-property';
+export { RestrictedProperty } from './restricted-property';
+export { WrappedTokenValue } from './wrapped-token-value';

package/dist/types/rules/use-latest-xcss-syntax-typography/linters/restricted-property.d.ts

@@ -0,0 +1,6 @@
+import type { Rule } from 'eslint';
+import { type MetaData } from './common';
+export declare const RestrictedProperty: {
+    lint(node: Rule.Node, { context, config }: MetaData): void;
+    _check(node: Rule.Node, { config }: MetaData): boolean;
+};

package/dist/types/rules/use-latest-xcss-syntax-typography/linters/wrapped-token-value.d.ts

@@ -0,0 +1,7 @@
+import type { Rule } from 'eslint';
+import { type MetaData } from './common';
+export declare const WrappedTokenValue: {
+    lint(node: Rule.Node, { context, config }: MetaData): void;
+    _check(node: Rule.Node, { config }: MetaData): boolean;
+    _fix(node: Rule.Node): Rule.ReportFixer;
+};

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/dist/types-ts4.5/rules/use-latest-xcss-syntax-typography/config/index.d.ts

@@ -1,4 +1,7 @@
+type Pattern = 'restricted-property' | 'wrapped-token-value';
 export interface RuleConfig {
     failSilently: boolean;
+    patterns: Pattern[];
 }
 export declare const getConfig: (overrides: Partial<RuleConfig>) => RuleConfig;
+export {};

package/dist/types-ts4.5/rules/use-latest-xcss-syntax-typography/linters/common.d.ts

@@ -0,0 +1,6 @@
+import type { Rule } from 'eslint';
+import { type RuleConfig } from '../config';
+export type MetaData = {
+    context: Rule.RuleContext;
+    config: RuleConfig;
+};

package/dist/types-ts4.5/rules/use-latest-xcss-syntax-typography/linters/index.d.ts

@@ -1 +1,2 @@
-export { BannedProperty } from './banned-property';
+export { RestrictedProperty } from './restricted-property';
+export { WrappedTokenValue } from './wrapped-token-value';

package/dist/types-ts4.5/rules/use-latest-xcss-syntax-typography/linters/restricted-property.d.ts

@@ -0,0 +1,6 @@
+import type { Rule } from 'eslint';
+import { type MetaData } from './common';
+export declare const RestrictedProperty: {
+    lint(node: Rule.Node, { context, config }: MetaData): void;
+    _check(node: Rule.Node, { config }: MetaData): boolean;
+};

package/dist/types-ts4.5/rules/use-latest-xcss-syntax-typography/linters/wrapped-token-value.d.ts

@@ -0,0 +1,7 @@
+import type { Rule } from 'eslint';
+import { type MetaData } from './common';
+export declare const WrappedTokenValue: {
+    lint(node: Rule.Node, { context, config }: MetaData): void;
+    _check(node: Rule.Node, { config }: MetaData): boolean;
+    _fix(node: Rule.Node): Rule.ReportFixer;
+};

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.17.3",
+	"version": "10.18.1",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
 	"publishConfig": {
@@ -9,10 +9,6 @@
 	},
 	"atlassian": {
 		"team": "Design System Team",
-		"releaseModel": "continuous",
-		"productPushConsumption": [
-			"jira"
-		],
 		"website": {
 			"name": "ESLint plugin",
 			"category": "Tooling"
@@ -68,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",

package/dist/es2019/rules/use-latest-xcss-syntax-typography/linters/banned-property/index.js

@@ -1,40 +0,0 @@
-/* eslint-disable @repo/internal/react/require-jsdoc */
-
-import { isNodeOfType } from 'eslint-codemod-utils';
-export const BannedProperty = {
-  lint(node, {
-    context
-  }) {
-    if (BannedProperty._check(node)) {
-      let property = 'fontSize, lineHeight, fontWeight or letterSpacing';
-      if (isNodeOfType(node, 'Identifier')) {
-        property = node.name;
-      } else if (isNodeOfType(node, 'Literal')) {
-        property = String(node.value);
-      }
-      context.report({
-        node,
-        messageId: 'noUnsafeTypographyProperties',
-        data: {
-          property
-        }
-      });
-    }
-  },
-  _check(node) {
-    // Prevent font weight being used in combination with heading tokens
-    if (isNodeOfType(node, 'Identifier') && node.name === 'fontWeight' || isNodeOfType(node, 'Literal') && node.value === 'fontWeight') {
-      if (isNodeOfType(node.parent.parent, 'ObjectExpression')) {
-        for (const property of node.parent.parent.properties) {
-          if (isNodeOfType(property, 'Property') && isNodeOfType(property.value, 'CallExpression') && isNodeOfType(property.value.callee, 'Identifier') && isNodeOfType(property.value.arguments[0], 'Literal')) {
-            if (property.value.callee.name === 'token' && typeof property.value.arguments[0].value === 'string' && property.value.arguments[0].value.includes('font.heading')) {
-              return true;
-            }
-          }
-        }
-      }
-      return false;
-    }
-    return true;
-  }
-};

package/dist/types/rules/use-latest-xcss-syntax-typography/linters/banned-property/index.d.ts

@@ -1,7 +0,0 @@
-import type { Rule } from 'eslint';
-export declare const BannedProperty: {
-    lint(node: Rule.Node, { context }: {
-        context: Rule.RuleContext;
-    }): void;
-    _check(node: Rule.Node): boolean;
-};

package/dist/types-ts4.5/rules/use-latest-xcss-syntax-typography/linters/banned-property/index.d.ts

@@ -1,7 +0,0 @@
-import type { Rule } from 'eslint';
-export declare const BannedProperty: {
-    lint(node: Rule.Node, { context }: {
-        context: Rule.RuleContext;
-    }): void;
-    _check(node: Rule.Node): boolean;
-};