Custom URL Protocol Handler for Windows by fahad-israr · Pull Request #1 · starfixdev/starfix

fahad-israr · 2020-03-05T03:27:53Z

Added Custom Url Handler Methodology for Windows
Created a Test File
Checked the Output
All in separate Files

maxandersen · 2020-03-05T12:46:42Z

+           shell
+              open
+                 command
+                    (Default) = "C:\Program Files\Ide\ide.exe" "%1"


does it actually have to be an .exe ? can it be a batch script ?

As we were going to deal with an Installed IDE(vscode, eclipse, etc who have an exe file) I've tried with an .exe...I'll have to check about batch script..

well before we reach the ide it would call out to the starfish which would figure out how to turn the action in ide:// to a call to the apropriate ide/tool.

so instead of an opening ide.exe we could trigger starfish.exe and handle the request in Starfish.

yes, correct.

maxandersen · 2020-03-05T12:47:40Z

@@ -0,0 +1,35 @@
+# Creating Custom URL Handlers on Linux:


could you avoid having mixed cases and spaces in the folder/file names ... ?

I've renamed them.

maxandersen · 2020-03-08T07:11:01Z

@@ -0,0 +1,66 @@
+# Support opening files through URL handling in Vscode


Cool you found places in vscode to alter.

Any particular reason you want to modify vscode to support the protocol directly at this stage ?

One of the ideas/values behind starfish is that each IDE (at least for basic operations) should not need to support the protocol directly. Thoughts ?

The reason for this was to understand the functionality of vscode.

I agree that we dont need to modify the code directly for vscode.There can be better solutions.
One of them could be through Extensions using "Extension API" of vscode.

And if we've got any better choice than an extension I can start working on that as well.

Additionally I saw the command line tool of vscode :code.visualstudio.com.

With this we can easily execute vscode commands ,as stated on code.visualstudio.com "Visual Studio Code has a powerful command line interface built-in that lets you control how you launch the editor. You can open files, install extensions, change the display language, and output diagnostics through command-line options (switches)"

Also the mapping of URL to Application (i.e Starfish) can be done as done here: https://github.com/shengyou/vscode-handler

For mapping, we have to execute .reg Files(on Windows) or execute bash install on Linux
We can achieve this easily by automating our app to execute intended codes from command line

Yes, vscode has url extensions too and a nice cli - the downside being it only works for vscode.

That’s why starfish would be its own independent script/executable which we register in the different OS/browsers url handler logic and then can make it work for basically any IDE.

granted. din't realize these were publically limited. but lets use it for now.

Thanks!!

Please do refer to me the resources you may think might be helpful for improved learning.

quarkus.io/guides is a good start.

mind you that most material in quarkus is about using it for services (i.e. microservices) the notion of command mode for use in cli's and batch jobs is coming in 1.4 (a month from now) so to start just doing basic java should be fine.

but don't let that stop you from exploring Quarkus today! :)

That's awesome!! I'd keep exploring Quarkus and start developing with it as soon as possible!!

if you want to do it as part of GSOC you'll make a proposal (https://google.github.io/gsocguides/student/writing-a-proposal) - for now we submit those at https://docs.google.com/forms/d/1ePMj3FRBQ_BNYo9pKSaYI9HE0uv_gTLksJWqSOqYdIw/prefill

The docs need access.I've requested access. Please check it.

Hi max,I've successfully submitted the Google form.
Please review it and give me suggestions to improve it.

hmm - I haven't received any notfication and nothing listed in the results tab - can you double check you pressed submit ? and did you send the pdf to google's gsoc system ?

I am sorry...i forgot to press submit button after prefilling.
You may review my draft now.

fahad-israr · 2020-03-22T14:25:48Z

While working with Quarkus I faced a little bit of difficulty in Installing GraalVM on Ubuntu. So I've made an Installation Guide.Please Check it out,give a review to me on it(so that I can improve it) and do share with others if you think it can be helpful ...https://github.com/fahad-israr/Guide-to-Install-GraalVM-Community-Edition-On-Ubuntu

Update: Additionally, I was able to succefully Build a Native Executable with Quarkus using https://github.com/quarkusio/quarkus-quickstarts/tree/master/getting-started
And Successfully Execute the generated SNAPSHOT-runner using : ./target/getting-started-1.0-SNAPSHOT-runner

fahad-israr · 2020-03-22T20:05:50Z

I am glad to mention here that My PR got accepted and merged at one of the related projects (Vscode Handler) that you suggested as a reference:shengyou/vscode-handler#5 (comment)

maxandersen · 2020-04-20T09:34:46Z

about configuration I would start simple by having a ~/.starfish/config.yaml or similar to add user config to.

what would be great though is that we auto-detect/guess as much as possible and only in truly ambiguous cases do we need user to configure anything.

i.e. to find which IDE to launch I would simply scan PATH or well known locations for possible known ones ..i.e. if code is in the path assume its vscode

similar about launch of the IDE and how to have it pick up the right command - i.e. if /Applications/Eclipse.app exist use open -a /Applications/Eclipse.app %s on OSX etc. or when intellj with its specific port open do a curl to the IDE...

of course if you did such scan on my laptop you would basically find all in existence so here it might make sense to ask the user what he prefer and give option to "remember" the choice.

fahad-israr · 2020-04-20T10:31:29Z

about configuration I would start simple by having a ~/.starfish/config.yaml or similar to add user config to.

what would be great though is that we auto-detect/guess as much as possible and only in truly ambiguous cases do we need user to configure anything.

i.e. to find which IDE to launch I would simply scan PATH or well known locations for possible known ones ..i.e. if code is in the path assume its vscode

similar about launch of the IDE and how to have it pick up the right command - i.e. if /Applications/Eclipse.app exist use open -a /Applications/Eclipse.app %s on OSX etc. or when intellj with its specific port open do a curl to the IDE...

of course if you did such scan on my laptop you would basically find all in existence so here it might make sense to ask the user what he prefer and give option to "remember" the choice.

I like this Idea.

fahad-israr · 2020-04-21T22:32:34Z

Configuration File Added and Tested

Hi @maxandersen

I've added a configuration file that currently allows user to:

Specify destination directory on local files system
Choose which IDE to launch

I've used .properties file(see the file here )instead of YAML.

Is it fine to use .properties file instead of YAML or are there any advantages of using YAML ?

Files to see for changes:

Waiting for your thoughts :)

fahad-israr · 2020-04-22T22:25:53Z

Capability to scan installed packages added

Scans all the installed packages
Currently, prints them on console

Example screenshot:

maxandersen · 2020-04-25T08:34:16Z

Main reason to use yaml is its cleaner to read/write nested config, i.e.:

editors:
   code: 
      open-file-arg: {file}{#if line}:{line}{/if}{#if column}:{column}{/if}
   eclipse:
      path: open -a ~/java-latest-released/Eclipse.app
      open-file-arg: {file}

you'll want to make sure to use something like fastjackson which can help retain comments.

about package scans thats cool - not sure if it can help much; but yes - in general we'll probably want different strategies dependent on OS and setup. I would start by scanning for well known executable in the path as that is independent of if the tools/ide was installed via package or something else.

About changing preferences then yeah, I would just update the config for the user.

fahad-israr · 2020-04-25T08:39:25Z

@maxandersen
Thanks!!
I'll go ahead.
I'll introduce YAML instead of .properties and I'll try to work with identifying the installed IDE's and Terminal based user interaction to choose the IDE.

fahad-israr · 2020-04-28T13:22:21Z

Hi @maxandersen

- I've introduced a file starfish-config.yml that holds the configurations for Starfish

- I've used Simple YAML as a dependency and thus added a jar file for it: simpleyaml.jar

- The jar file must be included in `classpath` for compiling or running.

- To compile `javac -cp '.:simpleyaml.jar' starfish.java`

- To run `java -cp '.:simpleyaml.jar' starfish`

fahad-israr · 2020-04-30T22:06:27Z

Hi @maxandersen

I have added more features

Now as the user click `open In IDE` in browser the terminal Launches and asks

- If he wants to use previous configuration(stored in YML File)

- If he says `yes` then the configuration is loaded from YAML File

- If he says `no` then the user is asked to enter configuration by choosing the `IDE` from list and enter `cloning path`.

- The Entered Configuration is also updated in YAML File (starfish-config.yml)

Screenshots below demonstrate both cases:

- When user wants to use the previous configuration stored in YML file:

- When the user wants to change the configuration

maxandersen · 2020-05-04T10:20:17Z

i like there are way to configure it but I don't think that should happen in the browser extension when clicking on launch - at that time in all cases except the first time you should already have this configured and thus showing the terminal and asking the questions are not a good flow.

I think this configuration should be done only if no config present - after that just use the configured settings.

fahad-israr · 2020-05-04T14:17:22Z

yeah asking every time is not a good flow.
I'll make changes.
I was thinking of what if user wants to change the config later.
Is it fine to ask him to manually change the YAML or can there be a better solution?
One I can think is we give an option to configure options in the extension menu.
Clicking on the edit config would launch terminal and allow the user to change config.
Waiting for your thoughts :)

maxandersen · 2020-05-04T22:35:42Z

remember starfish is just as much a command line tool - not just called via the browser extension.

thus having i.e. starfish edit-config command or similar would be just fine and/or have it available in the extension settings or similar as you suggeted.

fahad-israr · 2020-05-06T02:49:55Z

Yes , starfish is a command line tool and so starfish edit-config seems to be good idea.
User can then launch up this via Browser extension or even via Terminal directly.

fahad-israr · 2020-05-08T20:43:33Z

- When the user opens up the starfish app first time he is asked to enter configuration

- Next time onwards starfish directly uses the configuration from config file.

fahad-israr · 2020-05-08T22:32:30Z

command line support added for starfish and starfish config editor

- When the user enters `starfish https://username/repository.git`

- When the user enters `starfish config` then configuration editor launches

maxandersen · 2021-06-17T08:30:44Z

closing as we merged the work here last year.

fahad-israr added 15 commits March 5, 2020 08:01

Windows url Handlers

325883f

Created Custom Windows URL Handler Process

71e357d

Rename Windows Url handler.adoc to Windows Url handler.md

8770c7b

Update Windows Url handler.md

f2c9f6b

Windows Url handlers

d07c9a7

Create Testing Windows URL Handler.cs

7f82e9e

Create README.md

1d5def1

Update Testing Windows URL Handler.cs

7d05f99

Update README.md

f9f9c40

Create Output.md

f7016d8

Update README.md

4e34894

Comprehensive Directory Names

9352095

Linux Url handlers

6df7e3b

Update README.md

899ec6e

Update README.md

a7604e7

maxandersen reviewed Mar 5, 2020

View reviewed changes

fahad-israr added 4 commits March 5, 2020 23:45

Directory Nomenclature resolved

11df2fe

Update README.md

b06d223

Vscode URL Handling support

49378e5

Support opening files through url Handling

fddae82

maxandersen reviewed Mar 8, 2020

View reviewed changes

fahad-israr added 5 commits March 10, 2020 22:47

Create ide-handler.desktop

76eea4b

Create ide-handler

117f2ec

Create install

7f23c3e

Update README.md

226db7b

Update ide-handler.desktop

20ab277

URL handler for Linux developed with Quarkus

7567ec2

Configuration File added for destination directory and ide

b060a9e

scanning installed packages

3e62636

fahad-israr force-pushed the master branch from 50b36e3 to 3e62636 Compare April 22, 2020 22:19

Introduced YML File for configuration instead of .properties file

8ce08d2

fahad-israr added 2 commits April 28, 2020 19:54

Native executable binary updated

ba460c4

@user configurable and @config sync with YML config file

1840033

fahad-israr added 4 commits May 8, 2020 14:09

Generated URL schemed to ide://https://github.com/user/repo

fcb6ba6

Linux Installed Updated

edb85c2

Merge https://github.com/maxandersen/starfish

7843fdd

Work Flow improved

3bf7e1c

Added Command line config suuport

9244b0b

fahad-israr added 2 commits June 11, 2020 04:30

Update ide-handler

38f535f

Windows Installer Added

63d54fb

maxandersen closed this Jun 17, 2021

varad64 mentioned this pull request Jan 27, 2023

Build failing on Windows #104

Open

		@@ -0,0 +1,66 @@
		# Support opening files through URL handling in Vscode

Conversation

fahad-israr commented Mar 5, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fahad-israr commented Mar 22, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fahad-israr commented Mar 22, 2020

Uh oh!

maxandersen commented Apr 20, 2020

Uh oh!

fahad-israr commented Apr 20, 2020

Uh oh!

fahad-israr commented Apr 21, 2020

Configuration File Added and Tested

I've used .properties file(see the file here )instead of YAML.

Is it fine to use .properties file instead of YAML or are there any advantages of using YAML ?

Waiting for your thoughts :)

Uh oh!

fahad-israr commented Apr 22, 2020

Capability to scan installed packages added

Example screenshot:

Uh oh!

maxandersen commented Apr 25, 2020

Uh oh!

fahad-israr commented Apr 25, 2020

Uh oh!

fahad-israr commented Apr 28, 2020

Hi @maxandersen

- I've introduced a file starfish-config.yml that holds the configurations for Starfish

- I've used Simple YAML as a dependency and thus added a jar file for it: simpleyaml.jar

- The jar file must be included in classpath for compiling or running.

- To compile javac -cp '.:simpleyaml.jar' starfish.java

- To run java -cp '.:simpleyaml.jar' starfish

Uh oh!

fahad-israr commented Apr 30, 2020

Hi @maxandersen

Now as the user click open In IDE in browser the terminal Launches and asks

- If he wants to use previous configuration(stored in YML File)

- If he says yes then the configuration is loaded from YAML File

- If he says no then the user is asked to enter configuration by choosing the IDE from list and enter cloning path.

- The Entered Configuration is also updated in YAML File (starfish-config.yml)

Screenshots below demonstrate both cases:

- When user wants to use the previous configuration stored in YML file:

- When the user wants to change the configuration

Uh oh!

fahad-israr commented Mar 5, 2020 •

edited

Loading

fahad-israr commented Mar 22, 2020 •

edited

Loading

- The jar file must be included in `classpath` for compiling or running.

- To compile `javac -cp '.:simpleyaml.jar' starfish.java`

- To run `java -cp '.:simpleyaml.jar' starfish`

Now as the user click `open In IDE` in browser the terminal Launches and asks

- If he says `yes` then the configuration is loaded from YAML File

- If he says `no` then the user is asked to enter configuration by choosing the `IDE` from list and enter `cloning path`.

fahad-israr commented May 4, 2020 •

edited

Loading

fahad-israr commented May 6, 2020 •

edited

Loading

- When the user enters `starfish https://username/repository.git`

- When the user enters `starfish config` then configuration editor launches