@atlaskit/codemod-cli 0.27.2 → 0.27.3

package/dist/types/presets/index.d.ts

@@ -8,5 +8,6 @@ import './migrate-to-link/migrate-to-link';
 import './migrate-to-new-buttons/migrate-to-new-buttons';
 import './upgrade-pragmatic-drag-and-drop-to-stable/upgrade-pragmatic-drag-and-drop-to-stable';
 import './remove-dark-theme-vr-options/remove-dark-theme-vr-options';
+import './remove-token-fallbacks/remove-token-fallbacks';
 declare const presets: string[];
 export default presets;

package/dist/types/presets/remove-token-fallbacks/remove-token-fallbacks.d.ts

@@ -0,0 +1,29 @@
+import type { API, FileInfo } from 'jscodeshift';
+import { RemoveTokenFallbackOptions } from './types';
+/**
+ * Transforms the source code of a file by removing fallback values from the @atlaskit/tokens/token functions.
+ * By default removes only the fallbacks that have the same values as the tokens.
+ *
+ * @param {FileInfo} fileInfo - Information about the file to be transformed.
+ * @param {API} api - The jscodeshift API, providing utilities for AST transformations.
+ * @param {RemoveTokenFallbackOptions} options - Options for the transformation, including:
+ *   @param {boolean} [options.verbose] - If true, enables verbose logging.
+ *   @param {boolean} [options.forceUpdate] - If true, removes the fallbacks regardless of the difference between token and fallback. Otherwise removes only the fallbacks that are equal to the token values.
+ *   @param {boolean} [options.addEslintComments] - If true, adds the eslint ignore comment for the rule @atlaskit/design-system/no-unsafe-design-token-usage for the fallbacks that weren't removed.
+ *   @param {boolean} [options.useLegacyColorTheme] - If true, uses the legacy theme for color token mapping.
+ *   @param {string} [options.reportFolder] - Directory path to output transformation reports. Reports will be generated only if this option is provided.
+ *   @param {boolean} [options.dry] - If true, performs a dry run without modifying the files.
+ *
+ * @returns {Promise<string>} A promise that resolves to the transformed source code as a string.
+ */
+export default function transformer(fileInfo: FileInfo, { jscodeshift: j }: API, options: RemoveTokenFallbackOptions): Promise<string>;
+export declare const parser = "tsx";
+/**
+ * Function executed before all transformations to prepare the environment by clearing the report folder.
+ */
+export declare function beforeAll(options: RemoveTokenFallbackOptions): Promise<void>;
+/**
+ * Function executed after all transformations to combine individual file reports into a comprehensive transformation report.
+ * It also applies prettier to the affected files.
+ */
+export declare function afterAll(options: RemoveTokenFallbackOptions): Promise<void>;

package/dist/types/presets/remove-token-fallbacks/types.d.ts

@@ -0,0 +1,39 @@
+import { ASTPath, ImportDeclaration, Options, VariableDeclarator } from 'jscodeshift';
+export interface ReplacementDetail {
+    teamInfo: TeamInfo;
+    filePath: string;
+    lineNumber: number;
+    tokenKey: string;
+    rawFallbackValue: string;
+    resolvedTokenValue: string;
+    resolvedFallbackValue: string;
+    difference?: number;
+}
+export interface TransformationDetails {
+    replaced: ReplacementDetail[];
+    notReplaced: ReplacementDetail[];
+}
+export type TeamInfo = {
+    packageName: string;
+    teamName: string;
+};
+export type RemoveTokenFallbackOptions = Options & {
+    useLegacyColorTheme?: boolean;
+    reportFolder?: string;
+    addEslintComments?: boolean;
+    forceUpdate?: boolean;
+};
+export type WithResolvedDeclarations = {
+    resolvedImportDeclaration?: ASTPath<ImportDeclaration>;
+    resolvedLocalVarDeclaration?: ASTPath<VariableDeclarator>;
+};
+export type FallbackResolveResult = WithResolvedDeclarations & {
+    rawFallbackValue: string;
+    fallbackValue: string | undefined;
+};
+export type WithStart = {
+    start?: number;
+};
+export type TokenProcessingResult = WithResolvedDeclarations & {
+    fallbackRemoved: boolean;
+};

package/dist/types/presets/remove-token-fallbacks/utils/all-tokens.d.ts

@@ -0,0 +1 @@
+export declare function getTokenMap(useLegacyTheme?: boolean): Record<string, string>;

package/dist/types/presets/remove-token-fallbacks/utils/color-utils.d.ts

@@ -0,0 +1,3 @@
+export declare const compareHex: (hex: string, hex2: string) => number;
+export declare function isValidColor(color: string): boolean;
+export declare function colorToHex(color: string): string;

package/dist/types/presets/remove-token-fallbacks/utils/get-team-info.d.ts

@@ -0,0 +1,8 @@
+import type { TeamInfo } from '../types';
+/**
+ * Looks for the closest package.json and gets team and package information from it.
+ *
+ * @param {string} filePath
+ * @returns {Promise<AtlassianTeamInfo>}
+ */
+export declare const getTeamInfo: (filePath: string) => Promise<TeamInfo>;

package/dist/types/presets/remove-token-fallbacks/utils/normalize-values.d.ts

@@ -0,0 +1,8 @@
+export declare function normalizeValues(tokenKey: string, tokenValue: string | undefined, fallbackValue: string | undefined): {
+    difference?: number;
+    isAcceptableDifference?: boolean;
+    tokenLogValue: string;
+    fallbackLogValue: string;
+    normalizedTokenValue: string | undefined;
+    normalizedFallbackValue: string | undefined;
+};

package/dist/types/presets/remove-token-fallbacks/utils/remove-unused-imports.d.ts

@@ -0,0 +1,2 @@
+import { ASTPath, ImportDeclaration, JSCodeshift } from 'jscodeshift';
+export declare function removeUnusedImports(importDeclarations: ASTPath<ImportDeclaration>[], j: JSCodeshift): void;

package/dist/types/presets/remove-token-fallbacks/utils/remove-unused-variables.d.ts

@@ -0,0 +1,2 @@
+import { ASTPath, JSCodeshift, VariableDeclarator } from 'jscodeshift';
+export declare function removeUnusedVariables(variableDeclarations: ASTPath<VariableDeclarator>[], j: JSCodeshift): void;

package/dist/types/presets/remove-token-fallbacks/utils/reporter.d.ts

@@ -0,0 +1,4 @@
+import { TransformationDetails } from '../types';
+export declare function clearFolder(reportFolder: string): Promise<void>;
+export declare function combineReports(reportFolder: string): Promise<void>;
+export declare function writeReports(details: TransformationDetails, reportFolder: string): Promise<void>;

package/dist/types/presets/remove-token-fallbacks/utils/token-processor.d.ts

@@ -0,0 +1,30 @@
+import type { ASTPath, CallExpression, Collection, FileInfo, JSCodeshift } from 'jscodeshift';
+import { RemoveTokenFallbackOptions, TeamInfo, TokenProcessingResult, TransformationDetails } from '../types';
+export declare class TokenProcessor {
+    private j;
+    private options;
+    private fileInfo;
+    private source;
+    private rootDir;
+    private details;
+    private logMessages;
+    private possibleExtensions;
+    private tokenMap;
+    private teamInfo;
+    constructor(j: JSCodeshift, options: RemoveTokenFallbackOptions, fileInfo: FileInfo, source: Collection<any>, rootDir: string, details: TransformationDetails, tokenMap: Record<string, string>, teamInfo: TeamInfo);
+    processAndLogSingleToken(callPath: ASTPath<CallExpression>): Promise<TokenProcessingResult>;
+    private logVerbose;
+    private log;
+    private logError;
+    private processSingleToken;
+    private getTokenKey;
+    private getFallbackValue;
+    private processFallbackAsStringLiteral;
+    private processFallbackAsIdentifier;
+    private processFallbackAsMemberExpression;
+    private processFallbackAsTemplateLiteral;
+    private tryResolveModulePath;
+    private tryResolveLocalPath;
+    private resolveValueFromImport;
+    private createImportFilter;
+}

package/dist/types/presets/remove-token-fallbacks/utils/update-comments.d.ts

@@ -0,0 +1,2 @@
+import type { ASTPath, CallExpression, JSCodeshift } from 'jscodeshift';
+export declare function addOrUpdateEslintIgnoreComment(j: JSCodeshift, tokenValue: string, fallbackValue: string | undefined, callPath: ASTPath<CallExpression>): void;

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

@@ -8,5 +8,6 @@ import './migrate-to-link/migrate-to-link';
 import './migrate-to-new-buttons/migrate-to-new-buttons';
 import './upgrade-pragmatic-drag-and-drop-to-stable/upgrade-pragmatic-drag-and-drop-to-stable';
 import './remove-dark-theme-vr-options/remove-dark-theme-vr-options';
+import './remove-token-fallbacks/remove-token-fallbacks';
 declare const presets: string[];
 export default presets;

package/dist/types-ts4.5/presets/remove-token-fallbacks/remove-token-fallbacks.d.ts

@@ -0,0 +1,29 @@
+import type { API, FileInfo } from 'jscodeshift';
+import { RemoveTokenFallbackOptions } from './types';
+/**
+ * Transforms the source code of a file by removing fallback values from the @atlaskit/tokens/token functions.
+ * By default removes only the fallbacks that have the same values as the tokens.
+ *
+ * @param {FileInfo} fileInfo - Information about the file to be transformed.
+ * @param {API} api - The jscodeshift API, providing utilities for AST transformations.
+ * @param {RemoveTokenFallbackOptions} options - Options for the transformation, including:
+ *   @param {boolean} [options.verbose] - If true, enables verbose logging.
+ *   @param {boolean} [options.forceUpdate] - If true, removes the fallbacks regardless of the difference between token and fallback. Otherwise removes only the fallbacks that are equal to the token values.
+ *   @param {boolean} [options.addEslintComments] - If true, adds the eslint ignore comment for the rule @atlaskit/design-system/no-unsafe-design-token-usage for the fallbacks that weren't removed.
+ *   @param {boolean} [options.useLegacyColorTheme] - If true, uses the legacy theme for color token mapping.
+ *   @param {string} [options.reportFolder] - Directory path to output transformation reports. Reports will be generated only if this option is provided.
+ *   @param {boolean} [options.dry] - If true, performs a dry run without modifying the files.
+ *
+ * @returns {Promise<string>} A promise that resolves to the transformed source code as a string.
+ */
+export default function transformer(fileInfo: FileInfo, { jscodeshift: j }: API, options: RemoveTokenFallbackOptions): Promise<string>;
+export declare const parser = "tsx";
+/**
+ * Function executed before all transformations to prepare the environment by clearing the report folder.
+ */
+export declare function beforeAll(options: RemoveTokenFallbackOptions): Promise<void>;
+/**
+ * Function executed after all transformations to combine individual file reports into a comprehensive transformation report.
+ * It also applies prettier to the affected files.
+ */
+export declare function afterAll(options: RemoveTokenFallbackOptions): Promise<void>;

package/dist/types-ts4.5/presets/remove-token-fallbacks/types.d.ts

@@ -0,0 +1,39 @@
+import { ASTPath, ImportDeclaration, Options, VariableDeclarator } from 'jscodeshift';
+export interface ReplacementDetail {
+    teamInfo: TeamInfo;
+    filePath: string;
+    lineNumber: number;
+    tokenKey: string;
+    rawFallbackValue: string;
+    resolvedTokenValue: string;
+    resolvedFallbackValue: string;
+    difference?: number;
+}
+export interface TransformationDetails {
+    replaced: ReplacementDetail[];
+    notReplaced: ReplacementDetail[];
+}
+export type TeamInfo = {
+    packageName: string;
+    teamName: string;
+};
+export type RemoveTokenFallbackOptions = Options & {
+    useLegacyColorTheme?: boolean;
+    reportFolder?: string;
+    addEslintComments?: boolean;
+    forceUpdate?: boolean;
+};
+export type WithResolvedDeclarations = {
+    resolvedImportDeclaration?: ASTPath<ImportDeclaration>;
+    resolvedLocalVarDeclaration?: ASTPath<VariableDeclarator>;
+};
+export type FallbackResolveResult = WithResolvedDeclarations & {
+    rawFallbackValue: string;
+    fallbackValue: string | undefined;
+};
+export type WithStart = {
+    start?: number;
+};
+export type TokenProcessingResult = WithResolvedDeclarations & {
+    fallbackRemoved: boolean;
+};

package/dist/types-ts4.5/presets/remove-token-fallbacks/utils/all-tokens.d.ts

@@ -0,0 +1 @@
+export declare function getTokenMap(useLegacyTheme?: boolean): Record<string, string>;

package/dist/types-ts4.5/presets/remove-token-fallbacks/utils/color-utils.d.ts

@@ -0,0 +1,3 @@
+export declare const compareHex: (hex: string, hex2: string) => number;
+export declare function isValidColor(color: string): boolean;
+export declare function colorToHex(color: string): string;

package/dist/types-ts4.5/presets/remove-token-fallbacks/utils/get-team-info.d.ts

@@ -0,0 +1,8 @@
+import type { TeamInfo } from '../types';
+/**
+ * Looks for the closest package.json and gets team and package information from it.
+ *
+ * @param {string} filePath
+ * @returns {Promise<AtlassianTeamInfo>}
+ */
+export declare const getTeamInfo: (filePath: string) => Promise<TeamInfo>;

package/dist/types-ts4.5/presets/remove-token-fallbacks/utils/normalize-values.d.ts

@@ -0,0 +1,8 @@
+export declare function normalizeValues(tokenKey: string, tokenValue: string | undefined, fallbackValue: string | undefined): {
+    difference?: number;
+    isAcceptableDifference?: boolean;
+    tokenLogValue: string;
+    fallbackLogValue: string;
+    normalizedTokenValue: string | undefined;
+    normalizedFallbackValue: string | undefined;
+};

package/dist/types-ts4.5/presets/remove-token-fallbacks/utils/remove-unused-imports.d.ts

@@ -0,0 +1,2 @@
+import { ASTPath, ImportDeclaration, JSCodeshift } from 'jscodeshift';
+export declare function removeUnusedImports(importDeclarations: ASTPath<ImportDeclaration>[], j: JSCodeshift): void;

package/dist/types-ts4.5/presets/remove-token-fallbacks/utils/remove-unused-variables.d.ts

@@ -0,0 +1,2 @@
+import { ASTPath, JSCodeshift, VariableDeclarator } from 'jscodeshift';
+export declare function removeUnusedVariables(variableDeclarations: ASTPath<VariableDeclarator>[], j: JSCodeshift): void;

package/dist/types-ts4.5/presets/remove-token-fallbacks/utils/reporter.d.ts

@@ -0,0 +1,4 @@
+import { TransformationDetails } from '../types';
+export declare function clearFolder(reportFolder: string): Promise<void>;
+export declare function combineReports(reportFolder: string): Promise<void>;
+export declare function writeReports(details: TransformationDetails, reportFolder: string): Promise<void>;

package/dist/types-ts4.5/presets/remove-token-fallbacks/utils/token-processor.d.ts

@@ -0,0 +1,30 @@
+import type { ASTPath, CallExpression, Collection, FileInfo, JSCodeshift } from 'jscodeshift';
+import { RemoveTokenFallbackOptions, TeamInfo, TokenProcessingResult, TransformationDetails } from '../types';
+export declare class TokenProcessor {
+    private j;
+    private options;
+    private fileInfo;
+    private source;
+    private rootDir;
+    private details;
+    private logMessages;
+    private possibleExtensions;
+    private tokenMap;
+    private teamInfo;
+    constructor(j: JSCodeshift, options: RemoveTokenFallbackOptions, fileInfo: FileInfo, source: Collection<any>, rootDir: string, details: TransformationDetails, tokenMap: Record<string, string>, teamInfo: TeamInfo);
+    processAndLogSingleToken(callPath: ASTPath<CallExpression>): Promise<TokenProcessingResult>;
+    private logVerbose;
+    private log;
+    private logError;
+    private processSingleToken;
+    private getTokenKey;
+    private getFallbackValue;
+    private processFallbackAsStringLiteral;
+    private processFallbackAsIdentifier;
+    private processFallbackAsMemberExpression;
+    private processFallbackAsTemplateLiteral;
+    private tryResolveModulePath;
+    private tryResolveLocalPath;
+    private resolveValueFromImport;
+    private createImportFilter;
+}

package/dist/types-ts4.5/presets/remove-token-fallbacks/utils/update-comments.d.ts

@@ -0,0 +1,2 @@
+import type { ASTPath, CallExpression, JSCodeshift } from 'jscodeshift';
+export declare function addOrUpdateEslintIgnoreComment(j: JSCodeshift, tokenValue: string, fallbackValue: string | undefined, callPath: ASTPath<CallExpression>): void;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/codemod-cli",
-	"version": "0.27.2",
+	"version": "0.27.3",
 	"description": "A cli for distributing codemods for atlassian-frontend components and services",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -39,22 +39,27 @@
 	"bin": "./bin/codemod-cli.js",
 	"dependencies": {
 		"@atlaskit/codemod-utils": "^4.2.0",
-		"@atlaskit/tokens": "^3.2.0",
+		"@atlaskit/tokens": "^4.0.0",
 		"@babel/runtime": "^7.0.0",
 		"@codeshift/utils": "^0.2.4",
 		"@hypermod/utils": "^0.4.2",
+		"@manypkg/find-root": "^1.1.0",
 		"@types/jscodeshift": "^0.11.0",
 		"chalk": "^4.1.2",
+		"color-diff": "^1.2.0",
 		"enquirer": "^2.3.4",
 		"glob": "9.0.0",
 		"jscodeshift": "^0.13.0",
 		"meow": "^8.1.1",
 		"projector-spawn": "^1.0.1",
+		"read-pkg-up": "^7.0.1",
 		"semver": "^7.5.2",
-		"simple-git": "^3.16.0"
+		"simple-git": "^3.16.0",
+		"uuid": "^3.1.0"
 	},
 	"devDependencies": {
 		"@af/formatting": "*",
+		"@types/color-diff": "^1.2.1",
 		"prettier": "^3.2.5",
 		"ts-node": "^10.9.1",
 		"typescript": "~5.4.2"