Clairvoyant

Smart search your codes.

Features

Clairvoyant scans your code and enumerates all tokens and provides access to them.

Tutorial

0. ⬇️ Install Clairvoyant

Show extension side bar within VS Code(Mac:Command+Shift+X, Windows and Linux: Ctrl+Shift+X), type clairvoyant and press Enter and click Install. Restart VS Code when installation is completed.

1. 🔍 Scan your codes

Launch Command Palette(Mac:F1 or Shift+Command+P, Windows and Linux: F1 or Shift+Ctrl+P), Execute Clairvoyant: Scan Current Document or Clairvoyant: Scan Open Documents or Clairvoyant: Scan Workspace command. You can also scan automatically. Specify settings for clairvoyant.autoScanMode ( default: "open documents" ).

2. 🚀 Sight your codes

Launch Command Palette, Execute Clairvoyant: Sight command or click eys icon on status bar. You can access to all tokens.

3. 🔧 Next step

You can change settings by settings.json. And you can apply keyboard shortcuts by keybindings.json.

Enjoy!

Recommended settings

Please check Workbench › Editor: Enable Preview

or

"workbench.editor.enablePreview": true,

in settings.json

If this setting is true or checked, Clairvoyant can display previews efficiently.

Commands

• Clairvoyant: Sight ... : Access to tokens in your codes with menu.
• Clairvoyant: Sight Document ... : Shows Sight menu specific to the current document.
• Clairvoyant: Sight Token ... : Shows Sight menu specific to the current token.
• Clairvoyant: Lunatic Go To File ... : Go To File with lunatic preview.
• Clairvoyant: Scan Current Document : Scan current document
• Clairvoyant: Scan Open Documents : Scan open documents
• Clairvoyant: Scan Workspace : Scan workspace
• Clairvoyant: Go Back : Go cursor position back
• Clairvoyant: Go Forward : Go cursor position forward
• Clairvoyant: Report Statistics : Show statistics data
• Clairvoyant: Report Profile : Show profile data
• Clairvoyant: Reload : Reload this extention
• Clairvoyant: Go Next Token : Go cursor position next that token at cursor position
• Clairvoyant: Go Previous Token : Go cursor position previous that token at cursor position
• Clairvoyant: Toggle highlight : Toggles the highlight of the token at the cursor position

Extension Settings

This extension contributes the following settings by settings.json( Mac: Command+,, Windows / Linux: File -> Preferences -> User Settings ):

• clairvoyant.autoScanMode: auto scan mode
• clairvoyant.maxFiles: max files
• clairvoyant.showStatusBarItems: show status bar items
• clairvoyant.textEditorRevealType: display options when moving the cursor
• clairvoyant.isExcludeStartsWidhDot: exclude path starts widh .
• clairvoyant.excludeDirectories: exclude directories
• clairvoyant.excludeExtentions: exculde file extentions
• clairvoyant.targetProtocols: target dcoument protocols ( You can exclude untitled: or add output:, vscode-userdata: or others. )
• clairvoyant.outputChannelVolume: output volume
• clairvoyant.parserRegExp: parser regular expression ( Clairvoyant: Reload is required when changes. )
• clairvoyant.enablePreviewIntercept: Enable preview intercept
• clairvoyant.gotoHistoryMode: Go to history mode
• clairvoyant.highlightMode: Highlight mode
• clairvoyant.highlightBaseColor: Highlight background colors are automatically generated by rotating the hue by 1 / phi all around based on this color. ( #RRGGBB )
• clairvoyant.highlightAlpha: Highlight background color opacity. ( 0 - 255)
• clairvoyant.activeHighlightAlpha: Active highlight background color opacity. ( 0 - 255)
• clairvoyant.activeHighlightLineAlpha: Active highlight line background color opacity. ( 0 - 255)
• clairvoyant.latestHighlightAlpha: Latest highlight background color opacity. ( 0 - 255)
• clairvoyant.activeHighlightOverviewRulerLane: Overview ruler lane of active highlights
• clairvoyant.latestHighlightOverviewRulerLane: Overview ruler lane of latest highlights
• clairvoyant.highlightOverviewRulerLane: Overview ruler lane of highlights
• clairvoyant.developFileListOnSightRootMenu: Develop file list on sight root menu
• clairvoyant.enableMenuCache: Enable menu cache

Keyboard shortcut Settings

In default, clairvoyant's commands doesn't apply keyboard shortcuts. Althogh, you can apply keyboard shortcuts by keybindings.json ( Mac: Code -> Preferences -> Keyboard Shortcuts, Windows / Linux: File -> Preferences -> Keyboard Shortcuts).

Command name on keybindings.json is diffarent from on Command Pallete. See below table.

Release Notes

see ChangLog on marketplace or github

Support

GitHub Issues

License

Boost Software License