Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tangoman75/ide-url-handler

Open project files directly in your favorite IDE, right from your browser, with just a click. This extension makes jumping to specific lines in your code a breeze. Supported across a range of popular IDEs, and easy to install.
https://github.com/tangoman75/ide-url-handler

atom emacs phpstorm pycharm sublime-text

Last synced: 1 day ago
JSON representation

Host: GitHub
URL: https://github.com/tangoman75/ide-url-handler
Owner: TangoMan75
License: gpl-3.0
Created: 2021-07-02T14:23:06.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-06-04T11:29:25.000Z (8 months ago)
Last Synced: 2024-06-04T12:51:48.455Z (8 months ago)
Topics: atom, emacs, phpstorm, pycharm, sublime-text
Language: Shell
Homepage:
Size: 97.7 KB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        ![GH language](https://img.shields.io/github/languages/top/TangoMan75/ide-url-handler)

[![GH release](https://img.shields.io/github/v/release/TangoMan75/ide-url-handler)](https://github.com/TangoMan75/ide-url-handler/releases)

[![GH license](https://img.shields.io/github/license/TangoMan75/ide-url-handler)]((https://github.com/TangoMan75/ide-url-handler/blob/master/LICENSE))

[![GH stars](https://img.shields.io/github/stars/TangoMan75/ide-url-handler)](https://github.com/TangoMan75/ide-url-handler/stargazers)

[![Bash CI](https://github.com/TangoMan75/ide-url-handler/workflows/bash_unit%20CI/badge.svg)](https://github.com/TangoMan75/ide-url-handler/actions/workflows/bash_unit.yml)

[![ShellCheck CI](https://github.com/TangoMan75/ide-url-handler/workflows/ShellCheck%20CI/badge.svg)](https://github.com/TangoMan75/ide-url-handler/actions/workflows/shellcheck.yml)

![Visitors](https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2FTangoMan75%2Fide-url-handler&labelColor=%23697689&countColor=%2337d67a&style=flat)

IDE URL Handler

===============

This package installs launchers to open files in **Atom**, **Emacs**, **Nano**, **PhpStorm**, **Pycharm**, **Sublime Text**, **Vim**, **Visual Studio Code** and **WebStorm** at the defined line number, the associated desktop file conforms to the _Desktop Entry Specification_ for use in _Gnome_ and _KDE desktop_ environments.

![screenshot](./doc/images/screenshot.png)

⏳ TL;DR

--------

Execute one of the following command in your terminal to install:

```sh

sudo sh -c "`wget -q https://raw.githubusercontent.com/TangoMan75/ide-url-handler/master/install.sh -O -` install"

```

or if you have `curl` installed:

```sh

sudo sh -c "`curl -fsSL https://raw.githubusercontent.com/TangoMan75/ide-url-handler/master/install.sh` install"

```

🎯 Features

-----------

It can be used to open files at the specified line from within the browser by placing a link of the following kind in the markup:

```php

Open with PhpStorm";

// Alternate Syntax to match PhpStorm 8 for the Macintosh

print "Open with PhpStorm";

?>

```

How to test from the command line :

```bash

$ xdg-open "atom://open?url=file:///etc/os-release&line=3"

$ xdg-open "code://open?url=file:///etc/os-release&line=3"

$ xdg-open "emacs://open?url=file:///etc/os-release&line=3"

$ xdg-open "nano://open?url=file:///etc/os-release&line=3"

$ xdg-open "phpstorm://open?url=file:///etc/os-release&line=3"

$ xdg-open "pycharm-community://open?url=file:///etc/os-release&line=3"

$ xdg-open "pycharm://open?url=file:///etc/os-release&line=3"

$ xdg-open "subl://open?url=file:///etc/os-release&line=3"

$ xdg-open "vim://open?url=file:///etc/os-release&line=3"

$ xdg-open "webstorm://open?url=file:///etc/os-release&line=3"

```

or

```bash

$ atom-url-handler "atom://open?url=file:///etc/os-release&line=3"

$ code-url-handler "code://open?url=file:///etc/os-release&line=3"

$ emacs-url-handler "emacs://open?url=file:///etc/os-release&line=3"

$ nano-url-handler "nano://open?url=file:///etc/os-release&line=3"

$ phpstorm-url-handler "phpstorm://open?url=file:///etc/os-release&line=3"

$ pycharm-community-url-handler "pycharm-community://open?url=file:///etc/os-release&line=3"

$ pycharm-url-handler "pycharm://open?url=file:///etc/os-release&line=3"

$ subl-url-handler "subl://open?url=file:///etc/os-release&line=3"

$ vim-url-handler "vim://open?url=file:///etc/os-release&line=3"

$ webstorm-url-handler "webstorm://open?url=file:///etc/os-release&line=3"

```

This alternative syntax matches the format used by PhpStorm 8 for the Macintosh for cross-platform compatibility.

```bash

$ atom-url-handler "atom://open?file:///etc/os-release&line=3"

$ code-url-handler "code://open?file:///etc/os-release&line=3"

$ emacs-url-handler "emacs://open?file:///etc/os-release&line=3"

$ nano-url-handler "nano://open?file:///etc/os-release&line=3"

$ phpstorm-url-handler "phpstorm://open?file:///etc/os-release&line=3"

$ pycharm-url-handler "pycharm://open?file:///etc/os-release&line=3"

$ pycharm-community-url-handler "pycharm-community://open?file:///etc/os-release&line=3"

$ subl-url-handler "subl://open?file:///etc/os-release&line=3"

$ vim-url-handler "vim://open?file:///etc/os-release&line=3"

$ webstorm-url-handler "webstorm://open?file:///etc/os-release&line=3"

```

🚀 Installation

---------------

### ⚡ Simply enter following command in your terminal

```bash

$ sudo sh install.sh install

```

🔥 Usage

--------

Run `sh install.sh` to print help

```bash

$ sh install.sh

```

Available commands are: `install` `uninstall` `install_atom` `install_code` `install_emacs` `install_nano` `install_phpstorm` `install_pycharm_community` `install_pycharm` `install_subl` `install_vim` and `help`

🤖 Commands

-----------

### ⚡ Install all URL Handlers

```bash

$ sudo sh install.sh install

```

### ⚡ Uninstall all URL Handlers

```bash

$ sudo sh install.sh uninstall

```

### ⚡ Install Atom URL Handler

```bash

$ sudo sh install.sh install_atom

```

### ⚡ Install Visual Studio Code URL Handler

```bash

$ sudo sh install.sh install_code

```

### ⚡ Install Emacs URL Handler

```bash

$ sudo sh install.sh install_emacs

```

### ⚡ Install Nano URL Handler

```bash

$ sudo sh install.sh install_nano

```

### ⚡ Install PHPStorm URL Handler

```bash

$ sudo sh install.sh install_phpstorm

```

### ⚡ Install Pycharm URL Handler

```bash

$ sudo sh install.sh install_pycharm

```

### ⚡ Install Pycharm Community URL Handler

```bash

$ sudo sh install.sh install_pycharm_community

```

### ⚡ Install Sublime Text URL Handler

```bash

$ sudo sh install.sh install_subl

```

### ⚡ Install Vim URL Handler

```bash

$ sudo sh install.sh install_vim

```

### ⚡ Print this help (default)

```bash

$ sh install.sh help

```

📑 Sources

----------

- [https://developer.happyr.com/open-files-in-phpstorm-from-you-symfony-application](https://developer.happyr.com/open-files-in-phpstorm-from-you-symfony-application)

- [https://github.com/sanduhrs/phpstorm-url-handler](https://github.com/sanduhrs/phpstorm-url-handler)

- [https://symfony.com/doc/current/reference/configuration/framework.html#ide](https://symfony.com/doc/current/reference/configuration/framework.html#ide)

- [https://stackoverflow.com/questions/14676981/sublime-text-url-handler-for-ubuntu](https://stackoverflow.com/questions/14676981/sublime-text-url-handler-for-ubuntu)

💻 Dependencies

---------------

**IDE URL Handler** requires the following dependencies:

- cat

- awk

- sed

- Docker (optional)

- Shellcheck (optional)

📑 IDEs

-------

Here's a list of pages where you can download popular IDEs for your system :

- [Download Atom](https://atom.io/)

- [Download Emacs](https://www.gnu.org/software/emacs/)

- [Download Nano](https://www.nano-editor.org/download.php)

- [Download PhpStorm](https://www.jetbrains.com/phpstorm/download/)

- [Download Pycharm](https://www.jetbrains.com/pycharm/download/)

- [Download Sublime Text](https://www.sublimetext.com/3)

- [Download Vim](https://www.vim.org/download.php)

- [Download Visual Studio Code](https://code.visualstudio.com/download)

- [Download WebStorm](https://www.jetbrains.com/webstorm/download/)

🤝 Contributing

---------------

Thank you for your interest in contributing to **IDE URL Handler**.

Please review the [code of conduct](./CODE_OF_CONDUCT.md) and [contribution guidelines](./CONTRIBUTING.md) before starting to work on any features.

If you want to open an issue, please check first if it was not [reported already](https://github.com/TangoMan75/ide-url-handler/issues) before creating a new one.

📜 License

----------

Copyrights (c) 2021 "Matthias Morin" <[email protected]>

Copyrights (c) 2017 "Stefan Auditor" <[email protected]>

[![License](https://img.shields.io/badge/Licence-GPL3-green.svg)](LICENSE)

Distributed under the GPL3 license.

If you like **IDE URL Handler** please star, follow or tweet about it:

[![GitHub stars](https://img.shields.io/github/stars/TangoMan75/ide-url-handler?style=social)](https://github.com/TangoMan75/ide-url-handler/stargazers)

[![GitHub followers](https://img.shields.io/github/followers/TangoMan75?style=social)](https://github.com/TangoMan75)

[![Twitter](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2FTangoMan75%2Fide-url-handler)](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2FTangoMan75%2Fide-url-handler)

... And check my other cool projects.

🙏 Acknowledgements

-------------------

- This script is a fork of **Stefan Auditor** [phpstorm-url-handler](https://github.com/sanduhrs/phpstorm-url-handler)

- [bash_unit](https://github.com/pgrange/bash_unit): bash unit testing enterprise edition framework (used for CI/CD)

- [shellcheck](https://github.com/koalaman/shellcheck): a static analysis tool for shell scripts (used for CI/CD)