Skip to content

Add support for SassDoc previews on hover, in suggestions, and signature helper - #156

Closed
wkillerud wants to merge 10 commits into
mrmlnc:masterfrom
wkillerud:feat/sassdoc
Closed

Add support for SassDoc previews on hover, in suggestions, and signature helper#156
wkillerud wants to merge 10 commits into
mrmlnc:masterfrom
wkillerud:feat/sassdoc

Conversation

@wkillerud

@wkillerud wkillerud commented Apr 12, 2022

Copy link
Copy Markdown

Hello, and thanks for your work building this plugin!

I wanted to run a suggested solution for #56 by you (the one about previewing SassDoc). It may be a bit naive performance-wise, but it seems to be working alright on my own machine. Basically it runs a SassDoc parse-command on the source file for a symbol, runs through the result to match the correct docs with the symbol, and builds up the preview.

I considered using StorageService to keep the result from sassdoc.parse, but at least in my case it's very helpful to always have up-to-date documentation (I maintain a design system built with Sass, among other things, and would love to preview docs I write).

  • There may be a clever way to invalidate the cache, but I'm new to VS Code extension development so I don't know which events to look for.
  • Maybe we could have a setting to opt in/out of sassdoc, since it adds a potentially useless parsing?

Hope we can work together to land this feature. Here's a preview:

Edit 26/06/22: I've refined this feature further, but it builds on some foundational changes in the parser and scanner. I've published my fork as a separate extension, naturally giving credit for its origin. If you're interested in coordinating the two repos, feel free to reach out :)

GIF showing the result of a hover over a mixing with SassDoc

VS Code has started disabling certain features unless the workspace
is trusted. By default with the previous runner, VS Code would start
in this un-trusting mode, which broke Vue behavior.

This new version of the runner adds the proper flags automatically
so the workspace is trusted.

See https://code.visualstudio.com/api/working-with-extensions/testing-extension#migrating-from-vscode
To be used by other features
@wkillerud

Copy link
Copy Markdown
Author

Looks like Mergify removed strict mode in favor of queue. e9ff4a7 should have the updated config, but the check will keep failing until the change hits the main branch.

@wkillerud wkillerud changed the title Proof of Concept: add support for SassDoc in hover Add support for SassDoc previews on hover, in suggestions, and signature helper May 14, 2022
@wkillerud wkillerud closed this Sep 28, 2024
@wkillerud
wkillerud deleted the feat/sassdoc branch September 28, 2024 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant