Preview Collapsed Section (fail) & Making An Open Source

After successful progress last time, we decided to try and expand our extension to support another feature that adds the option to display the contents of a collapsed text (another idea that resulted from the previous meeting with our workshop lecturer).

We thought that it could be very useful to have that option, especially when all you want is to quickly check something.

Since the hover receives Markdown string, we can display the content as text and not as a code display. So, we started looking for creating a new window or another view option.

We discovered that in visual studio code we can’t create new UI elements (learned this from this StackOverflow question).

Also, we saw that once you over the line of the collapsed text, by right-click >Peek > Peek Call Hierarchy, it shows the “Call Hierarchy”.

Example:

We thought about implementing the CallHierarchyProvider (a vscode interface), but we realized that it missed the goal and it would be easier to use the ‘peek’ option or just unfold the content.

 So, due to visual studio code limitations, and for other people to try and expand our extension, we decided to open source our project (and maybe in the future those limitations will no longer be, so some of our ideas will be realizable).  

 For start, we created a repository on GitHub and customize its settings and content (we used this guide).
Than, for our repository to be open source, we licensed it so that others are free to use:

We added a README file that describe our project in more details (features supported, extension settings and more)
And finally, our first open source project is ready for visitors. 

Our next step is try to support preview of css files. 
We know that the css files must be at the same root file of the Html, so we need to find out how to get  the selected css file path according to the current html file location. 
Furthermore, we need to figure out how can we display it (its not an html file so a `webview` display doesn't help here).

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