github-actions[bot]
commented
1 year ago CLA Assistant Lite bot: Thank you for your submission, we really appreciate it. We ask that you sign our Contributor License Agreement before we can accept your contribution.
-->If you are contributing on behalf of your employer: you must fill out our Corporate Contributor License Agreement which can be found here, and send the signed forms to autolispext.contributor.agreements@autodesk.com.
-->If you are contributing on behalf of yourself: you must agree to our Individual Contributor License Agreement which can be found here, and either send the signed forms to autolispext.contributor.agreements@autodesk.com, or reply below with a comment containing the following text:
I have read the CLA Document and I hereby sign the CLA
Josh seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You can retrigger this bot by commenting recheck in this Pull Request
JD-Howard
Sen-real
Objective
I originally expected to finally address the long standing issues with AutoCompletion, but one of the prerequisites for that is providing "details" about the suggestions. So, I finished a markdown enhanced HoverProvider and the completion updates will have to be in another PR; probably for the best since this wound up having a lot of maintenance updates too.
Abstractions
The presentation layer is self contained and works for native AutoLisp/DclTiles/DclAttribute identifiers if they exist in
webHelpAbstration.jsonor defined by the users code. This uses previous developments to get definitions from other files, but if it is used and not defined in the current file, then it does require the user to have an@Globalcomment to be applicable; examples of pass & fail situations provided in the video. Also note, we are a bit behind on the latest VSCode versions, the newer releases have HTML capabilities and we are restricted to Markdown right now. I don't think this is an issue, but I never got the localvscode://filePath:line#links working. So, kind of wondering if they would using newer references. For the time being, I just added a "source" to the popup to give a clue about the origin.Uses previous developments for generating/parsing user provided documentation to enhance user defined function presentation.
There is 1 new localization, but I didn't put all the placeholders in i18n files.
Generally not married to the current presentation, but it will "do for now" until
webHelpAbstraction.jsongets updated. There is a test that will regenerate all the baseline MDs given a specific boolean flag. It is the obligation of whoever tinkers with the presentation code to regenerate them, manually review the outputs for "expected" results and include them in a PR to keep the tests passing. I left a similar note next to the variable.Markdown generation does account for argument index emphasis. This will be useful for a future signature provider.
This addition makes me consider deleting the context menu "open web help" functionality in the future.
Split the original web help file into a Library & Object files. Very little changed even if it all looks like new code. Its safe to say the Library was the only thing that changed in any meaningful way.
WebStorm was used for a lot of the major refactoring.
Tests performed
The "new" content in this has ~95% code coverage, but would like to do some further testing on "User Defined" representations through mocks at some point.
All existing tests are still passing, but note that I did break a number of them during some cleanup. When your looking at test changes that aren't specifically in
providers.hoverProvider.test.tsjust keep in mind:Screen shot
It is kind of hard to see my mouse in this, but I am in fact hovering over the various things that you see pop up and they often highlight the atom shortly after.
https://user-images.githubusercontent.com/51800232/188553502-db1ae887-53f2-453d-b0ff-0db86fc0d86c.mp4