Skip to content

update(docs): add migration analyzer doc #1511

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.

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 1 commit into from
Apr 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 5 additions & 1 deletion apps/docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,11 @@
},
{
"group": "Codemod Platform",
"pages": ["codemod-studio", "codemod-registry/introduction"]
"pages": [
"scanner",
"codemod-studio",
"codemod-registry/introduction"
]
},
{
"group": "Legacy Guides",
Expand Down
Binary file added apps/docs/images/analyzer/migration-analyzer.mp4
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 44 additions & 0 deletions apps/docs/scanner.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: 'Migration Scanner'
icon: 'magnifying-glass'
---

The Migration Analyzer provides valuable unique insights into migration opportunities, such as dependency upgrades, security improvements, internationalization, and more.

The Migration Analyzer scans your repositories to provide industry benchmarks, counts files using specific dependencies, and highlights vulnerabilities in both direct and transitive dependencies, empowering you to identify high-impact opportunities with confidence.

<video
autoPlay
muted
loop
playsInline
className="w-full aspect-video"
src="/images/analyzer/migration-analyzer.mp4"
></video>

## Using the Migration Analyzer

<Steps>
<Step title="Connect repo">
Connect your GitHub in the [Codemod app](https://app.codemod.com).
</Step>
<Step title="Run the opportunity analyzer">
The rust analyzer swiftly scans your codebase and streams opportunities as they are found.
</Step>
<Step title="Review and select migrations">
Choose the top migration opportunities and add them to our waitlist. We'll notify you as soon as automated migration recipes are available.
</Step>
</Steps>

<Frame>
![migration analyzer](/images/analyzer/migration-opportunities.png)
</Frame>

## Key Features

- **Later Versions Adoption (LVA)**: A metric that helps you compare your project with those who are using the same or more modern version of a given package. This is a proxy of how far you are behind others when it comes to each dependency.
- **Usage Insights**: Find out how many files import a specific package, helping you estimate the effort required for migration. Our Rust-powered ast-grep codemods provide insights you won't get from other tools. This gives you a sense of the required effort and number of files to change.
- **Security Impact**: Highlight migrations that address different categories of vulnerabilities, enhancing your project's security and compliance posture.
- **Direct vs. Indirect Dependencies**: Identify whether dependencies are direct or indirect. For indirect dependencies, see how many steps they are from your main project. The analyzer flags indirect dependencies used directly in your code—a practice best avoided.
- **Monorepo Support**: Trace dependencies back to their specific packages within a monorepo, giving you clearer insight into your project's structure.
- **Current vs. Suggested Versions**: See how many versions behind your dependencies are and get recommendations for updates.
Loading