Skip to content

VSCode extension that uses Webview to diplay Sublime VEX helpcards as in-editor help.

Notifications You must be signed in to change notification settings

majstorovich/Houdini-VEX-Sublime-Help-VSCode

Repository files navigation

Houdini VEX Sublime Help for VSCode

Changelog

  • 0.0.3 - Added Setting for default Help Webview spawn - no need to drag it to reveal text editor
  • 0.0.2 - Removed n millisecond refresh - now refreshes on editor change
  • 0.0.1 - Initial commit - uses n milliseconds to refresh Webview

Description

Houdini VEX Sublime Help is created as a companion extension to VEX ( VSCode Marketplace / GitHub ) and as a in-editor replacement for Houdini Vex Help ( VSCode Marketplace / GitHub ).

It's using VEX helpcards.json from Sublime VEX add-on.

Sidenote: Created as an test/exercise using Your first Extension, Webview API and Houdini Vex Help ( VSCode Marketplace / GitHub ).

Features

  • Grabs text under editor cursor and display VEX help for it
  • Doesn't matter if your cursor is on function name or inside the function (editing arguments)

Installation

Until it's officially uploaded on VSCode Marketplace, you can build it yourself or install prebuild .vsix from releases

HoudiniVEX_vsix_installation

How-to

After installation, press Ctrl + Shift + P and search for Houdini VEX Sublime Help. Keybinding not set by default, use cogwheel to manually set it.

Showcase

HoudiniVEX_Horizontal

HoudiniVEX_Vertical

Settings

Define default spawn position - set desired value in Settings. Search for Houdini

HoudiniVEX_Position_Settings

Restricted Mode

If you think i'm a trustworthy person who won't do any harm to you OR if you've checked the code and didn't find anything suspicious, you can enable this Extension to work in the Restricted Mode.

  1. Go to Settings
  2. Search for extensions.supportUntrustedWorkspaces
  3. Edit in settings.json
  4. Add the missing code at the end of the file and save
"extensions.supportUntrustedWorkspaces": {
        "undefined_publisher.houdinivexsublimehelp": {
            "supported": true,
            "version": "0.0.3"
        },
    }
  1. Profit!

WARNING! Removed in v0.0.2

Extension uses Webview and is constantly updating viewer on a fixed interval. May cause performance issues. Testing needed!

Fixed interval is by default set to 500ms.

You can change that value by going in Settings - Extensions or by searching @ext:undefined_publisher.houdinivexsublimehelp

HoudiniVEX_Settings

About

VSCode extension that uses Webview to diplay Sublime VEX helpcards as in-editor help.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published