A Codemod for the Intuita Registry requires four files:
- index.js (contains the codemod transformation logic)
- test.js (contains test cases to verify the codemod works)
- config.json (contains meta data about the codemod)
- readME.md (describes the codemod and what it does)
Copying and pasting these four files, and then editing each file to tailor to many different codemods is repetitive and time-consuming. The goal of this repository is to create tools to save time and to streamline the process so that Codemod importation can be a smooth and enjoyable experience.
The current template-create script prompts the user for the names of each Codemod, along with information about the engine, language, and owner and creates the templates for each Codemod. The program takes into account similarities and differences commonly shared so that developers can save time and not worry about making these tedious small edits.
Here we run the template-create script. It initially asks for the number of Codemods we create and then other information like the engine, language, and owner.
The confirm to continue(y/n) allows user to make changes if typos were made.
Below we can see that two directories were made. One for the "replace_brackets_with_angle_brackets" Codemod and a second for the "v15_return_format" Codemod. Each Codemod folder has the four files mentioned earlier(index.js, test.js, config.json, and readME.md).
Opening the config.json file in ~/replace_brackets_with_angle_brackets, we can view the information that was filled out by the program using our input.
Imagine you had to import 20 Codemods from a framework or technology, this should save you a lot of copying, pasting, and editing these 4 files!