diff --git a/apps/docs/docs.json b/apps/docs/docs.json index 0873918b4..fe6c23031 100644 --- a/apps/docs/docs.json +++ b/apps/docs/docs.json @@ -29,7 +29,11 @@ }, { "group": "Codemod Platform", - "pages": ["codemod-studio", "codemod-registry/introduction"] + "pages": [ + "scanner", + "codemod-studio", + "codemod-registry/introduction" + ] }, { "group": "Legacy Guides", diff --git a/apps/docs/images/analyzer/migration-analyzer.mp4 b/apps/docs/images/analyzer/migration-analyzer.mp4 new file mode 100644 index 000000000..20b922045 Binary files /dev/null and b/apps/docs/images/analyzer/migration-analyzer.mp4 differ diff --git a/apps/docs/images/analyzer/migration-opportunities.png b/apps/docs/images/analyzer/migration-opportunities.png new file mode 100644 index 000000000..5bbffe4fa Binary files /dev/null and b/apps/docs/images/analyzer/migration-opportunities.png differ diff --git a/apps/docs/scanner.mdx b/apps/docs/scanner.mdx new file mode 100644 index 000000000..d7e8d136f --- /dev/null +++ b/apps/docs/scanner.mdx @@ -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. + + + +## Using the Migration Analyzer + + + + Connect your GitHub in the [Codemod app](https://app.codemod.com). + + + The rust analyzer swiftly scans your codebase and streams opportunities as they are found. + + + Choose the top migration opportunities and add them to our waitlist. We'll notify you as soon as automated migration recipes are available. + + + + + ![migration analyzer](/images/analyzer/migration-opportunities.png) + + +## 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. \ No newline at end of file