diff --git a/README.md b/README.md index 2514138..185644a 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ A codemod using [jscodeshift](https://github.com/facebook/jscodeshift) to remove (It's recommended to run your favorite formatting tool after the codemod :wink: ) +> 💡 Running the codemod [with Intuita](#using-intuita) will automatically format your code with prettier. + ## :man_teacher: Motivation IF you use React and Typescript, you might have come across this [GitHub PR in Create React App's repo](https://github.com/facebook/create-react-app/pull/8177) about removing `React.FC` from their base template of a Typescript project. @@ -174,6 +176,21 @@ const NamedExportComponent = (props: Props) => foo ## :toolbox: How to use +### Using Intuita + +![gif animation showing how to use Intuita to run this codemod](/intuita-example.gif?raw=true) + +
+ + To run the codemod with the Intuita VS Code extension, [install Intuita VS Code extension](https://marketplace.visualstudio.com/items?itemName=Intuita.intuita-vscode-extension) and run the codemod:

+ +
Intuita Run Codemod
+
+ +> 💡 To learn more about running codemods using Intuita, check the usage guide [here](https://docs.intuita.io/docs/vs-code-extension/advanced-usage). + +### Using `jscodeshift` + Run the following command ``` @@ -190,7 +207,9 @@ npx jscodeshift -- -t Path/To/Repo/transform.ts --extensions=tsx --verbose=2 -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! diff --git a/intuita-example.gif b/intuita-example.gif new file mode 100644 index 0000000..1b94310 Binary files /dev/null and b/intuita-example.gif differ