Skip to content

Added support for Intuita #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 25, 2023
Merged

Added support for Intuita #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f3a6b5
Update README.md
mohab-sameh Oct 24, 2023
674c047
Create intuita-example.gif
Oct 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -174,6 +176,21 @@ const NamedExportComponent = (props: Props) => <span>foo</span>

## :toolbox: How to use

### Using Intuita

![gif animation showing how to use Intuita to run this codemod](/intuita-example.gif?raw=true)

<div align="center">

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:</p>

<div><a href="https://tinyurl.com/replace-react-fc-typescript" target="_blank"><img src="https://raw.githubusercontent.com/intuita-inc/intuita-docs/master/static/img/misc/1-click-run-codemod-with-intuita-badge.png" alt="Intuita Run Codemod" height="45px"/></a></div>
</div>

> 💡 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

```
Expand All @@ -190,7 +207,9 @@ npx jscodeshift -- -t Path/To/Repo/transform.ts --extensions=tsx --verbose=2 <FO

## :notebook: Notes

- The codemod focuses in replacing the nodes but does not do styling. You might want to run Prettier or your favorite formatting tool after the code has been modified. For example, in the following code
- The codemod focuses on replacing the nodes but does not do styling. If you run the codemod using `jscodeshift` CLI, you might want to run Prettier or your favorite formatting tool after the code has been modified. However, if you run the codemod using intuita, you can safely skip this part as Intuita automatically formats the output with prettier.

### Example:

```tsx
import React from 'react'
Expand Down Expand Up @@ -262,4 +281,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
Binary file added intuita-example.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.