Adds refactoring annotations to GitHub diff

Latest Version

Version
0.0.26
Update
January 3, 2021
Size
320KiB
Developer
Category
Users
25
Rating
1 ★
Manifest Version
2
Web Store Status
Languages Support
English
See more
Permissions
Tabs
Storage
ActiveTab
Https://github.com/*
Https://api.github.com/*
Https://refdiff.brito.com.br/*
See more

RAID: Refactoring-aware and Intelligent Diffs Extension

Code review is a key practice in modern software development. Currently, this practice is performed using textual diff tools, such as the one provided by GitHub. However, diff results can easily become complex and hard to understand. Refactorings, for example, are not represented at all in diff results. This increases diff understanding because reviewers need to infer themselves that a given group of added and removed lines of code represent, for example, an extract method.

RAID is a tool pipeline that seamlessly enriches GitHub diff results with refactoring information. This pipeline has three key components:

- RefDiff: a tool to detect refactoring operations in commits. In our architecture, we rely on GitHub actions to automatically execute RefDiff after each Pull Request.
- An external server, that collects the list of refactorings produced by RefDiff.
- A Chrome plug-in that seamlessly annotates diff chunks associated to refactorings. As we described, the goal is to easily communicate to developers the reason behind the added/removed lines of code.

Source Code: https://github.com/rodrigo-brito/refactoring-aware-diff

INSTALLATION
- Install Refactoring-Aware Review Chrome Extension
- Include Refactoring-Aware Diff Action in GitHub CI (Available in Github description)
- Submit a new Pull Request to test the extension

An example of Pull Request with extracted refactorings can be viewed here: https://github.com/rodrigo-brito/refactoring-aware-diff/pull/5/commits

BUG REPORTS: https://github.com/rodrigo-brito/refactoring-aware-diff/issues
Read more

Source Manifest.json

{"update_url": "https://clients2.google.com/service/update2/crx", "name": "RAID: Refactoring-aware and Intelligent Diffs", "version": "0.0.26", "manifest_version": 2, "description": "Adds refactoring annotations to GitHub diff", "homepage_url": "https://github.com/rodrigo-brito/refactoring-aware-diff", "icons": { "16": "icons/icon16.png", "48": "icons/icon48.png", "128": "icons/icon128.png" }, "browser_action": { "default_icon": "icons/icon128.png", "default_title": "RAID: Refactoring-aware and Intelligent Diffs", "default_popup": "html/browser_action.html" }, "options_page": "html/options.html", "background": { "scripts": ["js/build/background.js"], "persistent": false }, "content_scripts": [ { "run_at": "document_end", "matches": ["https://github.com/*"], "css": ["css/inject.css", "css/diff2html.min.css", "css/prism.css"], "js": ["js/build/content-script.js"] } ], "permissions": [ "tabs", "storage", "activeTab", "https://github.com/*", "https://api.github.com/*", "https://refdiff.brito.com.br/*" ], "content_security_policy": "script-src 'self' https://apis.google.com https://www.gstatic.com https://*.firebaseio.com https://*.firebaseapp.com https://*.googleapis.com https://www.google-analytics.com; object-src 'self'"}
Read more

How to download and manually install RAID: Refactoring-aware and Intelligent Diffs extension for Chrome

Looking for a way to install RAID: Refactoring-aware and Intelligent Diffs extensions for Chrome, you can search for them in the Chrome Web Store, clicking the "Add to Chrome" button, and following the straightforward process.

However, you may need to install RAID: Refactoring-aware and Intelligent Diffs extensions manually, this article outlines two simple methods to effortlessly install RAID: Refactoring-aware and Intelligent Diffs extensions, whether they come as unpacked folders in compressed formats like .zip or as .crx files.

Method 1: Download RAID: Refactoring-aware and Intelligent Diffs extension and manually install through Drag &Drop

If you ever need to manually install a RAID: Refactoring-aware and Intelligent Diffs extension for Chrome, don't worry, it's a simple process. Just follow these easy steps, and you will have your extension ready to use in no time.

Step 1: Download the RAID: Refactoring-aware and Intelligent Diffs Extension by clicking the "Download CRX" button on the website.

Look for the RAID: Refactoring-aware and Intelligent Diffs extension you wish to install. Go to the website and download the RAID: Refactoring-aware and Intelligent Diffs extension package, which is usually a .CRX file and comes in a zipped file. Here ".crx" file is the format for RAID: Refactoring-aware and Intelligent Diffs extension that contains all the data.

Step 2: Extract &Arrange Files

Once the file is downloaded, extract that file into its own folder. Similarly, give that extension files a permanent home. In other words, keep it in a folder that you don't accidentally delete it because these files will be needed to make that extension work.

Step 3: Go to the Chrome Extensions Page

Open Google Chrome and in the address bar, type chrome://extensions; it will open the Google Chrome extensions page. Make sure that "My extensions" is selected in the sidebar.

Step 4: Drag and Drop the Extension

Now, go to the folder where you extracted the RAID: Refactoring-aware and Intelligent Diffs extension and drag &drop the extension file from there anywhere onto the extension page within Google Chrome.

Step 5: Complete the Installation

Once you drag and drop the extension file, follow the steps that Google Chrome takes you through. Similarly, if the extension file is of .crx file format, you will be required to review the permissions and then add the extension.

Now, you can manage that added extension as you would like to with any other Chrome extension that you added through Chrome Webstore. Its icon will also appear in the Google Chrome Menu on the right side of the address bar once you activate it.

Method 2: Download RAID: Refactoring-aware and Intelligent Diffs extension for Chrome and install in Developer Mode

This is another method to install RAID: Refactoring-aware and Intelligent Diffs extension manually, but the twist is that here, you install by enabling the developer mode option provided in Google Chrome. This mode is commonly used for testing extensions or running unpublished tools.

Step 1: Download the RAID: Refactoring-aware and Intelligent Diffs extension file

Select and download the RAID: Refactoring-aware and Intelligent Diffs extension by clicking the 'Download CRX' button on the website.

Step 2: Extract the downloaded contents

Convert the file to a ZIP file if it is in CRX format then extract the RAID: Refactoring-aware and Intelligent Diffs extension zip file or folder that you downloaded. Make sure you extract it using the same folder name and keep it safely in another folder, so you don't delete it by mistake. The extracted folder will be needed to keep your RAID: Refactoring-aware and Intelligent Diffs extension running.

Step 3: Open Chrome Extension Setting Page

In the address bar of Google Chrome, type chrome://extensions and open the Chrome Extension Page.

Step 4: Enable Developer Mode

After opening the Chrome Extension page, look at the top right side, and you will find the toggle option of "Developer mode."Simply enable that developer mode option.

Step 5: Load the Unpacked Extension

Once you enable the developer mode option, you will see the menu of Load Unpacked, Pack Extensions and Update. From that, select the option "Load unpacked."

Step 6: Select the Extension Folder

Once the pop-up opens upon clicking Load unpacked, select the RAID: Refactoring-aware and Intelligent Diffs extension directory and click on the "Select Folder "button.

Step 7: Confirm and Install

After you select an extension folder of a Google Chrome extension you're installing manually, confirm its installation for the final time and let the installation complete.

Conclusion

Here we've made a step-by-step guide on How to manually install RAID: Refactoring-aware and Intelligent Diffs extension in 2 ways. We hope this guide proves helpful.

Similar Extensions