Fix h3 tag closed with h2, code whitespace preservation

no-stack-dub-sack / apexdox-vs-code

A lightweight VS Code extension that makes documenting your Salesforce Apex files an easy, integrated experience.

Other

49 stars 7 forks source link

Fix h3 tag closed with h2, code whitespace preservation #46

Closed no-stack-dub-sack closed 2 years ago

no-stack-dub-sack commented 2 years ago

builds on the work started in #45 by @dschach

Fixes h2/h2 tag mismatch issue.
Fixes issue where whitespace / newlines in code examples found in user-provided homepages and other supplementary HTML pages was not being correctly preserved.
Updates snapshots to reflect latest changes
Adds new test to cover functionality that is fixed with this PR (code examples in supplementary content)

no-stack-dub-sack commented 2 years ago

@dschach see: https://github.com/no-stack-dub-sack/apexdox-vs-code/releases/tag/v1.4.1 and https://marketplace.visualstudio.com/items?itemName=PeterWeinberg.apexdox-vs-code

version 1.4.1 has been released!

Please let me know when you can if the issue you experienced with code on the homepage has been fixed (I believe the extension should update automatically next time you close/open vscode, but feel free to update manually and confirm that you're running 1.4.1).

In this PR, I also added tests to make sure that our fix correctly addresses this issue, so unless there are any cross platform compatibility issues I believe this should do the trick.

Thanks again for the fix here!

dschach commented 2 years ago

Super! Thanks for working on this! I will fire up VSCode as soon as I can, and will see if I can remove the
tags from my pre code - it will let me remove a lot of pre-commit stuff from husky and lint-staged!

dschach commented 2 years ago

And auto-update to 1.4.1 confirmed. And no need for extra scripts. Well done us!!!

Let's connect and look at other improvements. I'm working on an Apex-specific code highlighter and I'd appreciate your feedback. It could be good to highlight different parts of the page with different languages - happy to explain at some point. But let's get the testing framework updated to something supported... once I can get tests to run on my machine :) Have an awesome day!

no-stack-dub-sack commented 2 years ago

Great! Glad this has fixed the issue for you.

And yes, I agree that eventually we should update to the currently supported test package for vscode extensions and maybe update a few other vscode deps. While I'm setup to run the tests on my machine, I did notice that the postinstall script is failing to install vscode type defs and this is probably related to running on the old test framework. If the postinstall fails, I don't think anyone forking the repo fresh and trying to install deps will be able to run the tests (which sounds exactly like what you're experiencing). So this def would be a good future endeavor so work on the extension can continue (both for other contributors, and myself if I ever end up on a new machine).

As far as your apex highlighter, feel free to keep me in the loop on that. I'd be happy to provide feedback.

Thanks again for your help on this one!