Option to disable inline preview

[ixxie]

Inline previews are handy to give context to content while editing code. However, they obfuscate the flow of the code by injecting characters that aren't really there. This can result in counter-intuitive results, especially when considering automated code formatting tools like Prettier.

Feature suggestions (I'll be happy with the first, the rest are bonus):

• A config option to disable the inline preview.
• Opt-in where the feature is disabled by default.
• Improved hover preview could be complementary, since you currently need to scroll down to see the previews (see picture). Probably changing the order is hard, but shortening the number of lines of the text (last picture) could be an easy mitigation.

---

⬇️ Please upvote this discussion if you want to see this implemented.

[felixhaeberle]

@samuelstroschein what do you think?

[samuelstroschein]

A link in the pop up to the kebab settings (#2249) that allow disabling previews seems OK. Vice-versa when inline decorations are disabled a link in the pop-up to re-enable them.

[felixhaeberle]

Summary: Standard case: It's enabled. If disabled, provide a link to the setting to reenable it.

@samuelstroschein Can we shrink the dot list in size? A lot of people don't see the (also in context window) in-code editing option below the function description, because they won't scroll this window.

[samuelstroschein]

its out of our control how vscode renders JSDoc. Can you put the inline editing above the JSDoc message?

[felixhaeberle]

"settings link" feature can be postponed for #2249 – a single place to edit your settings.

[felixhaeberle]

@ixxie see https://github.com/orgs/opral/discussions/2478#discussioncomment-9303081

[felixhaeberle]

This is now available in v1.41.1 🎉

Disable Inline Annotations

You can disable inline annotations by setting the following property to false in your VS Code settings.json file or by using the command Sherlock: Toggle Inline Annotations. The default value is true.

"sherlock.inlineAnnotations.enabled": false