Media
5 items
Description
Overlays the refactorings detected by the RefactoringMiner GitHub Action directly onto GitHub PR and commit diffs. Refactoring-Aware-Commit-Review visualizes refactoring information directly on GitHub, on both commit pages and pull request diffs. It highlights the refactorings RefactoringMiner detects in changes written in Java, Kotlin, JavaScript, TypeScript, and Python, including cross-language refactorings (Java to Kotlin), and lets you jump between the left and right side of related changes (including moves within the same file or different files). It was built to make inspecting source-code changes easier and to help developers review refactorings. HOW IT GETS ITS DATA • On pull request "Files changed" and "changes" diffs, it reuses the analysis already published by the RefactoringMiner GitHub Action (when the repository runs it), with no waiting. • On commit pages, it analyzes the commit on the fly through a hosted RefactoringMiner service. SUPPORTED PAGES • github.com/<user>/<project>/commit/<id> • github.com/<user>/<project>/pull/<id>/commits/<id> • github.com/<user>/<project>/pull/<id>/files • github.com/<user>/<project>/pull/<id>/changes USER GUIDE • Open any of the pages above in Chrome. The overlay runs automatically (on commit pages the analysis may take a few seconds). • A collapsible "Refactorings" panel appears at the bottom-left, listing every refactoring found in the diff, or telling you none were found. It is a stand-in for the action's PR comment, and the only listing available on commit pages. • Click a row in the panel, or click a changed line that is part of a refactoring, and the whole refactoring blinks on BOTH sides of the diff (its before and after), so you immediately see the counterpart. If part of it is scrolled off screen, a peeking bar pins it to the top or bottom edge of the screen; click the bar to jump to it. • Hover a highlighted line to see the refactoring's type and description. FIRST-TIME OPTIONS (commit pages only) Right-click the extension icon at the top right of the browser, choose "Options", and set the RefactoringMiner service URL, the analysis timeout (waiting time), and, for private repositories only, a GitHub token. Public repositories need no setup. WHAT'S NEW IN 3.2.x • Focus navigator pill: New UI to help navigating refactorings where the left and right diff are far from each other, or in different files. • Click-to-activate: Users can select whether the extension is automatically triggered, or by clicking on the extension icon. WHAT'S NEW IN 3.1.0 • Change and preview highlighting colors in Options page. WHAT'S NEW IN 3.0.0 This version is a ground-up rework of the Refactoring-Aware-Commit-Review extension: • Light and dark mode. The overlay now follows GitHub's own theme. It reads GitHub's Primer color variables, so every panel, highlight, and pinned line matches whichever mode you use. The previous version used fixed, light-only colors that clashed with GitHub's dark mode. • Off-screen lines pinned to the screen edges. The old line-to-line connection mechanism, which drew arrows across the diff to link the two ends of a refactoring, has been replaced. When you select a refactoring and its counterpart scrolls out of view, that line of code is pinned as a compact bar at the top or bottom edge of the screen, and clicking the bar takes you straight to it. Both ends of a change stay reachable no matter how far apart they are in a large diff. • Revamped UI. The refactoring list is now a single collapsible "Refactorings" panel in the bottom-left corner. Selecting a refactoring makes it blink in place on both the before and after sides, instead of relying on static colors and a color legend. The result is cleaner, less cluttered, and easier to scan. • Works on pull requests too, not just commits, reusing the RefactoringMiner GitHub Action's published analysis when it is available. • Runs automatically. There is no need to click the icon to start; the overlay activates as soon as a supported page loads. ACKNOWLEDGMENTS AND CREDITS The refactoring information is produced by RefactoringMiner (https://github.com/tsantalis/RefactoringMiner). The hosted analysis service and the original Refactoring-Aware-Commit-Review project were funded by the Natural Sciences and Engineering Research Council of Canada (NSERC) and the Department of Computer Science and Software Engineering of Concordia University. QUESTIONS AND RECOMMENDATIONS The project is currently maintained by Parsa Hejazi (Undergrad Concordia University) and Victor Veloso (Ph.D. Concordia University) Please send us an email at: victorgvbh@gmail.com or tsantalis@gmail.com or seyedphejazi@gmail.com.