IMPORTANT UPDATE!



It has been a long time since our last post, and we decided to make some big changes to the original project idea.


First, We tried to "reverse engineer" the “hover preview” plugin (which is a more basic version of what we wanted to develop).
We failed to fully understand it and decided to try and make our plugin from scratch, one little step at a time.

After a long time of trying to start and make the base of our plugin in Sublime Text 3, we learned that the number of explanations available online is limited.
As a result, small tasks like making a popup/window/tab became very difficult and frustrating.

We were back at square one and didn't know what to do next.
We learned that maybe Python is not the right programming language for us, and perhaps it would be more effective to develop in a language we are more familiar with- therefore, not developing for Sublime Text 3 (plugins in Sublime Text 3 must be written in Python). 
So the next thing we did was to try and find other frameworks or text editors for us to develop our plugin.

The first option was to develop a plugin for Visual Studio. 
On one hand, we get to develop in C#, which is the language we are most familiar and comfortable with.
On the other hand, developing a plugin for Visual Studio is very different from our original idea- it is not a text editor, but much more advanced framework.

Then, we came across Visual Studio Code, which is an open-source text editor that sounds and looks a lot like Sublime Text 3.
So, after looking into it, we learned that plugins, or extensions as VS Code calls them, are developed in JavaScript or TypeScript.
After more research we learned that TypeScript is an open-source language and a superset of JavaScript, which adds the option of object-oriented programming (amongst other things).
So, TypeScript is somewhat similar to C#, which we know well, and VS Code is a very similar, more advanced version, of Sublime Text 3.

This led us to change our original plugin platform from Sublime Text to Visual Studio Code and develop in TypeScript!

GOOD LUCK FOR US, again...

Comments

Post a Comment

Popular posts from this blog

Turorial- How to add a new feature

Image
In this Post we will explain how to make and integrate a new feature to our extension. ** ALL VARIABLES EXPLANATIONS ARE AT THE BOTTOM Let's say we want to support text files. The first thing we will need to do is to create a new file- we name it "TextObject". We then import the "utils" and "IPreviewObject" files. We create a new (export deafult) class caled "TextObject" which implements IPreviewObject. Now, we need to implement the interface's 3 functions: 1. validatePotentialUrl- we check if the current potential URL has a ".txt" extension. if so- we update the current URL to the potential URL, and the currentPreviewObject to a textObject. 2. GetHtmlContent- returns an empty string because we dont need a webview panel for this feature. 3. makeMrkdownString- this function will need to create a string that will allow to open a text file in a new tab when clicking on a certain button. To do so, w...
Read more

Little Bug Fix

Image
After the big refactoring and redesigning we made, there are a few more things we have left to do: 1. Currently, once the cursor is on a certain URL, the hover panel will change accordingly. So, if we hover over URLs that the cursor is not on them we will still be presented with the last hover panel that was created. That is a bug and we need to fix it. 2. We need to make a unit testing (we dont know how to do that, so we need to learn a bit more) 3. Try and use other VSCODE extensions to support previewing PDFs and HTML (the web page, not the HTML file). To fix (1) we added a new condition to the "push" call (in the activate finction, in extension.ts). We check if the line the cursor is on is the same as the line we hover over. If so, call the "updateHoverPanel" function (which makes a markdown string for the hover panel according to the current URL format). If not, update the hover panel content (the markdown string) to an empty string. W...
Read more

Publishing First Beta & Refactoring The Code

Image
We figured it was time to publish a first beta of our extension to VSCODE marketplace. We made some little adjustments like renaming some variables, for more readable code, and fixed a few major bugs, and then we published it using this tutorial .  You can find our extension on this link . *A big bug we had was that the last hover panel continude to show when hovering on defferent lines that are not a URL. Our problem was fixed by updating the current URL variable to UNDEFINED and the markdown string to an empty string, like so: Now that we published our first working extension, we wanted to focus more on the code and the design. Firstly, we decided it would be smarter to extract the relevant line and check what is it's format rather then what we made so far- which is to send the whole document to each extraction function. We created a new function called "extractCurrentLine" which does the following: 1. The function receives the document text ...
Read more