lmichelin/open-github-links-in-ide

Browser extension allowing to open files in your IDE directly from GitHub, available for Chrome and Firefox.

Browser extension to open GitHub file links in your IDE

This browser extension allows you to open files in your IDE directly from GitHub, assuming the repository you are working on is cloned on your computer. When a fragment of a file is displayed, your IDE opens the file and puts the cursor at the desired line.

👉 Google Chrome: https://chrome.google.com/webstore/detail/open-github-in-ide/bmifnnfmccmleigpaolofacllndmfned

👉 Firefox: https://addons.mozilla.org/firefox/addon/open-github-in-ide/

Getting started

Once the extension is installed:

• Click on the extension icon to open the settings popup
• Set the local path where GitHub repositories are cloned on your computer
• Select the IDE you want to use to open GitHub links
• Reload GitHub and start using the extension

Supported IDEs:

• VS Code
• VSCodium
• VS Code Insiders
• PhpStorm
• IntelliJ IDEA
• Any JetBrains editor (using built-in web server)
• WebStorm (not tested yet)
• GoLand
• CLion

WSL with the Ubuntu distribution is also supported on VS Code, VSCodium and VS Code Insiders for Windows.

PhpStorm & IntelliJ IDEA support is native on MacOS, but on Linux and Windows you need to install an url handler (see this answer):

• Linux: https://github.com/sanduhrs/phpstorm-url-handler
• Windows: https://github.com/aik099/PhpStormProtocol

I have not tested WebStorm support yet, feedbacks are welcome!

You can also use the built-in web server of any JetBrains editor (IDEA, WebStorm, PhpStorm, WebStorm, ...) instead of the url handler. For that you need to install the PHP plugin. See here for more information. The built-in web server must be started on port 63342.

To disable JetBrains warning "'file' API is requested. Do you trust unknown host?", you can go to File > Settings > Build, Execution, Deployment > Debugger and Check the Allow unsigned requests in the Built-in Server section.

New features & bugs

Need a feature? Want to report a bug? Feel free to open an issue or a pull request!

Contributing

• Clone the project
• Run yarn to install the dependencies
• Run yarn dev to start the development server
• On Google Chrome:
  • Open chrome://extensions/
  • Enable developer mode
  • Click on Load unpacked
  • Select the dist/chrome folder
• On Firefox:
  • Open about:debugging#/runtime/this-firefox
  • Click on Load Temporary Add-on
  • Select the dist/firefox/manifest.json file
• The extension and the pages using it will be automatically reloaded when you modify the source code

Changelog

Version 1.2.3 - September 23,2023

• Fix bug: icon was not showing in conversations after an update on GitHub side

Version 1.2.2 - November 28,2022

• Add support for CLion (#39)

Version 1.2.1 - August 18,2022

• Add support for GoLand (#32)

Version 1.2.0 - August 11,2022

• Add support for VS Code + WSL (Ubuntu) on Windows
• Migrate to manifest V3 on Chrome
• Fix bug: icon was not showing in file tree after an update on GitHub side
• Fix bug: icon was not showing in the "files changed" tab after clicking on it, a page reload was required (#35)

Version 1.1.14 - June 8, 2022

• Fix bug: icon was not showing in discussions after an update on GitHub side

Version 1.1.13 - November 22, 2021

• Fix bug: extension was crashing on pull requests containing resolved conversations

Version 1.1.12 - October 4, 2021

• Fix bug: icon was not showing on line numbers after an update on GitHub side

Version 1.1.11 - April 18, 2021

• Add permission required on Firefox to use JetBrains built-in web server (#20)

Version 1.1.10 - April 5, 2021

• Fix an issue with JetBrains editors (#17)

Version 1.1.9 - March 20, 2021

• Update VSCodium icon

Version 1.1.8 - March 14, 2021

• Fix bug: all line numbers were hidden when cursor was over a "Suggested changes" section in the "files changed" tab

Version 1.1.7 - March 7, 2021

• Fix file header selector
• Show editor icon on file block lines in conversation tab
• Add support for JetBrains editors using built-in web server (#16)

Version 1.1.6 - September 27, 2020

• Add support for VSCodium (#11)

Version 1.1.5 - June 29, 2020

• Make extension compatible with new GitHub design

Version 1.1.4 - October 23, 2019

• Add IntelliJ IDEA support

Version 1.1.3 - July 21, 2019

• Add Firefox support 🎉
• Set the extension icon according to the selected IDE

Version 1.1.2 - July 1, 2019

• Fix blurry icons on Retina screens

Version 1.1.1 - June 20, 2019

• Use popup instead of options page

Version 1.1.0 - June 16, 2019

• Show editor icon instead of line number when hovering over a line in file blocks
• Add options to select where to show the icon in GitHub
• Add option to show debug messages in console
• Fix some bugs

Version 1.0.3 - June 15, 2019

• Add PhpStorm support

Version 1.0.2 - June 14, 2019

• Add missing VS Code Insiders icon

Version 1.0.1 - June 14, 2019

• Add VS Code Insiders support
• Add CSS theme for options page
• Open options page automatically after install

Version 1.0.0 - June 6, 2019

• First release!
• Add VS Code support

open-github-links-in-ide's Issues

How could I find the application schema

I was trying to figure out how do you find those application schema like "idea://open?file="

And I tried to find the corresponding one for android studio, how could I do that?

Vivaldi / Chrome Path Does Not Exist

Hey @lmichelin, THANK you for an addition like this because the "open" in Visual Studio button has given me issues for such a long time.

However, with every attempt to open a file / folder in VSCode was met with the same error. As an example, I cloned, unzipped your directory, and then moved it all around including taking it to the "home" part of my C: drive - ~\users<user> - while still trying to open it with your open-in-ide function...is there something I am missing?

Regardless, merry Christmas and thanks again!

Opening files using JetBrains built-in web server doesn't work on Firefox

Currently, opening files using JetBrains built-in web server does not work on Firefox.

As suggested in #20, I tried to add a permission for *://localhost/* in manifest.json, but although the request is sent to the editor, it's still not working.

JetBrains shows this warning message and nothing happens after clicking on 'Yes':

With Chrome, the message is slightly different (host is recognized as github.com) and it works after clicking on 'Yes':

Fix when file name is too long

When a file name is omitted by "..." due to the path being so long, the file is not opened in Intellij ide.

GitHub Enterprise support

Would it be possible to support GitHub Enterprise installations?

Thanks!

Support enterprise using a wildcard using site access in plugin

Github Enterprise servers generally use the format github.*.com . If this can be added to the site access list in the plugin then it should work the same as in public Github. This would be very helpful if it could be added.

Plugin doesn't work with webstorm

OS: macOS Big Sur11.2.3
Navigator: Chrome 89.0.4389.90
IDE: WebStorm 2020.3.3

The syntax webstorm://open?file=/absolute/path/to_file.html:10 doesn't work.
On the other hand the syntax webstorm://open?file=/absolute/path/to_file&line=10works fine 🙂

Open files from a location other than the default set as a github clone

I am often viewing my local repositories created in a different location than the one I use to clone github repositories, would it be possible to create some way of defining a second local path for that repository or defining specific paths for a particular repository?

code insiders logo

I use code insiders and the logo does not appear !

Ugly icons on Mac

Icons are not Retina ready ;)

Feature Request: Clone & Open

It would be great if there's an option to clone and open repos. This project does that, but this one is a lot better, well maintained and has more features already. I've filed some feature request there, but it's difficult to get things moving.

I can try to implement this, but this is a significant change, so it requires your input first (PS: it'd be great if you can do this)

[Chrome|Clion] "scheme does not have a registered handler" error

Hi,

I love this Chrome extension with so many of my favorite IDEs!

A quick question to Clion support in Chrome. When I select "IntelliJ IDEA", it works well to open the local file in my IntelliJ. But when switching to "Clion", the Chrome debug console reported the following error messages, any ideas?

Failed to launch 'clion://open?file=...' because the scheme does not have a registered handler.

I'm pretty sure the Local path where GitHub repositories is well set, and the local file to open exists.

Env

OS: MacOS 12.6.1
Chip: Apple M1 Max
Chrome version: 108.0.5359.98
IDE version (Clion/IntelliJ): 2022.3

Show icons when viewing a file/source

When viewing a file instead of in a PR show the icons for both the file and lines.

i.e. https://github.com/lmichelin/open-github-links-in-ide/blob/master/src/inject.ts

Don't recall if this was working before Github's somewhat recent UI updates or not. This would be very useful when people share links to code in Github code that you can then open it locally just like you would in a PR.

Icon no longer shows on discussions page

Seems like the icons no longer show on the discussion page for review comments/suggestions. Seems the title attribute is no longer on the <a> element. There also doesn't seem to be any way to know the full path of the file without this. GitHub will sometimes truncate the innerText by applying an ellipsis (...) at the start of the file name if it's too long.

reload required for every github page to display Webstorm icon

To repro:

1. open a PR
2. click Review Changes button
3. mouse over any line: the [+] icon appears to add a comment, but no webstorm icon
4. reload the page
5. webstorm icons appear

Reloading is required whenever a page is navigated to that should show the icon.

I've already added a personal github token as well.

Mac OS X v 12.4
Chrome Version 103.0.5060.114 (Official Build) (x86_64)