irk-fzf

This is an experimental vs code extension to enable autocompletion support for pyirk. It is heavily based on:

• https://github.com/tatosjb/vscode-fuzzy-search
• https://code.visualstudio.com/api/get-started/your-first-extension.

As a backend it uses fzf - a fuzzy finder tool for the commandline.

Note: This extension originally was named "erk-fzf". If you had installed this extension before 0.2.3 please uninstall it first and delete the keyboard shortcut bound to erk-fzf.search.

Installation

Preparation

• On Windows:
  • Install the vs-code-extension "tatosjb.fuzzy-search". It is shipped with the fzf-executables for all major platforms.
• On Unix-based systems:
  • Install the fuzzy-finder command line utility fzf.
  • Depending on your installation method it might be necessary to manually add the installation path to the PATH environment variable.
  • Make sure that fzf is an executable command: Open a new terminal in vscode and run fzf --version. This should return a version string.
  • If this causes problems you can also install the above mentioned extension.

Install the extension via .vsix file in VS Code

• Download the latest version from the releases section.

• In VS Code or Codium:

  • Go to the Extensions view.
  • Click the ···-menu (Views and More Actions...)
  • Select Install from VSIX...

• Alternatively in your terminal, run the following command:

  • code --install-extension irk-fzf-0.2.3.vsix (replace the version number if there is a newer version available)

Strongly recommended:

• Bind action irk-fzf.search to a keyboard custom keyboard shortcut (e.g. ctrl+shift+space)
  • Add the following snippet to your keyboard shortcut file, e.g. ~/.config/Code/User/keybindings.json:

  {
      "key": "ctrl+shift+space",
      "command": "irk-fzf.search"
  },
  

  • Alternatively you can use the keybinding dialog of VS code.

Usage

Preparation

• Ensure pyirk --version >= 0.9.0 is installed
• Navigate to the directory of your irk package (where irkpackage.toml is located)
• Open VS Code in this directory
  • This is necessary such that vs code can find the autocompletion file
  • This can be achieved in the following ways:
    • a)
      • Open vs code (e.g. via Desktop shortcut)
      • If there is already an open project choose File → Close Folder
      • Open the directory of your irk-package via File → Open Folder
    • b)
      • open a command line and navigate to the directory of your irk-package
      • run code .
• Open a terminal
• Run pyirk --load-mod my_mod.py mm -ac
  • This creates the autocompletion file (.ac_candidates.txt), which is necessary for every irk-package irk-fzf is used for.

Fuzzy Autocompletion

The command irk-fzf.search takes a string as input and performs a fuzzy search .ac_candidates.txt (containing keys, labels and descriptions). The results are ordered according to matching quality. The desired result can be selected via arrow-keys and return.

The initial input string is the whitespace-delimited string left of the cursor. While the dialog window of the extension is open further characters can be entered to refine the result. See the following example:

Development of this Extension

Preparation

• Download and install node.js.
• Run npm install from the root directory of this repo

Test

Inside the editor, open src/extension.ts and press F5. This will compile and run the extension in a new Extension Development Host window.

Run the irk-fzf.search command from the Command Palette (Ctrl+Shift+P) in the new window:

See also vsc-extension-quickstart.md. ing of your choice

Build package

• from the root dir of the extension:
  • npm install
  • npm install -g @vscode/vsce
  • vsce package
    • this creates a file like extension-name.vsix