Welcome To Our Blog


Hello!


This is our computer science final project blog.
This is where we keep ourselves updated on every working process.
Our project is to develop a plugin\package for Sublime Text 3 (an expansion of the existing "hover preview" package).

Firstly, we needed to research about sublime because we never worked with that kind of text editor before.
There are a lot of videos and documentation in the internet about sublime text and the popular packages you can install on it.


The first issue we encountered was the lack of package developing tutorials online.
We found a few basic ones like:

http://docs.sublimetext.info/en/latest/extensibility/plugins.html

https://cnpagency.com/blog/creating-sublime-text-3-plugins-part-1/

So, after we each installed sublime text 3, played with it a little and learned what we can from the information available online, it was time to look at the source code of popular packages and try to reverse engineer them (we needed to find the source code on GitHub because it opens the original files as a hexa-decimal text file when open on sublime text).
It turned out a lot more difficult then we thought, because we never coded in Python before, and the sublime text standard package language is Python.

So, we are now facing two main issues:

1.       How do we develop a good and usable sublime text 3 package?
2.       Learn advanced tools Python

The next things we are going to try is:

1.       Work with the sublime text 3 console and the file status (printing text according to the file name, content etc.)
2.       Do something if the mouse is hovering over specific words.
3.       Show a link to click on if the mouse is hovering on specific word and open the link in a new browser window.
4.       Debug popular packages using console logs to understand how their code works.

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