@wise/wds-codemods 0.0.1-experimental-db88b03 → 0.0.1-experimental-795f13a

package/README.md

@@ -224,22 +224,25 @@ export default transformer;
 ### Adding a New Transform
 
 1. Create a new `.ts` file in `src/transforms/your-transform-name/`.
-2. Export a `packageRequirements` array defining required dependencies.
+2. Create `config.json` file in the same directory and set an object defining required dependencies as well as the type of the codemod.
 3. Export a default function following the jscodeshift transformer signature.
-4. Use helper utilities from `src/transforms/helpers/` for common operations.
+4. Use helper utilities from `src/helpers/` for common operations.
 5. Write unit tests for your transform using the `createTestTransform` utility.
 6. Build the project to compile your transform.
 7. Run the codemod runner and select your new transform.
 
 ### Package Requirements
 
-Each transform should export a `packageRequirements` array that specifies which packages and versions are required:
+Each transform should have `prerequisites` defined in `config.json` that specifies which packages and versions are
+required:
 
-```ts
-export const packageRequirements = [
-  { name: '@wise/components', version: '>=2.0.0' },
-  { name: '@wise/icons', version: '>=1.0.0' },
-];
+```json
+{
+  "prerequisites": {
+    "@wise/components": ">=2.0.0",
+    "@wise/icons": "^1.0.0"
+  }
+}
 ```
 
 The system will automatically validate these requirements before running the transform, supporting:
@@ -251,7 +254,7 @@ The system will automatically validate these requirements before running the tra
 
 ### Helper Utilities
 
-The codemod provides several helper utilities in `src/transforms/helpers/`:
+The codemod provides several helper utilities in `src/helpers/`:
 
 - **`hasImport`** - Check for and manipulate import statements
 - **`processIconChildren`** - Handle icon component transformations
@@ -260,7 +263,8 @@ The codemod provides several helper utilities in `src/transforms/helpers/`:
 - **JSX Element Utils** - Utilities for manipulating JSX elements and attributes
 - **JSX Reporting Utils** - Standardised reporting for common manual review scenarios
 
-Additional utilities are available in `src/utils/` for common operations like file handling, AST manipulation, and reporting. As this project evolves, we encourage contributors to add new utilities that can benefit the broader codemod ecosystem.
+Additional utilities are available in `src/controller/utils/` for common operations like file handling, AST
+manipulation, and reporting. As this project evolves, we encourage contributors to add new utilities that can benefit the broader codemod ecosystem.
 
 #### Writing Unit Tests for Transforms
 
@@ -269,7 +273,7 @@ It is important that all codemod transforms have corresponding unit tests to ens
 **Basic test setup:**
 
 ```ts
-import { createTestTransform } from '../../helpers/createTestTransform';
+import { createTestTransform } from '../../../helpers/createTestTransform';
 import transform from '../my-transform';
 
 const testTransform = createTestTransform(transform, [