take-me1010 / vscode-hovering-dictionary

Hovering-Dictionary is a VSCode extension for looking up words your mouse cursor is indicating.

VSCode-Hovering-Dictionary

Hovering-Dictionary is a VSCode extension for looking up words your mouse cursor is indicating.

This extension is inspired by Mouse Dictionary (MIT License, wtetsu, 2018).

日本語の説明 (For Japanese) → https://qiita.com/take_me/items/3b102e7569af8791f926

Features

Fast looking up words with case sensitivity

(Note that this demonstration was held after importing 英辞郎(EIJIRO) dictionary data, see #importing-dictionaries. Many expressions such as "on one's own" are NOT included in the default dictionary.)

Mouse Dictionary provides a very fast and flexible way to refer to a dictionary. By partially using the code in this Chrome extension, I realize its similar function in VSCode!

• Fast reference: It usually takes only less than 1 ms to obtain the reference to the words your mouse indicates.
• Case-sensitive search: camelCase -> camel case, snake_case -> snake case, etc...
• Expandability: You can import many other dictionary data if you want.

You can toggle the visibility of the hover by simply clicking the right side button or the command hovering-dictionary.toggle-hover-visibility. I recommend registering this command hovering-dictionary.toggle-hover-visibility as a short-cut key.

Importing dictionaries

This extension includes the default dictionary provided in ejdict-hand (Public Domain). In addition, you can import any dictionary formats you could import in Mouse Dictionary.

You can import the dictionaries via the command hovering-dictionary.import-dictionary.

This page which shows much information about some kinds of available dictionary files is also helpful.

development

git clone https://github.com/Take-Me1010/vscode-hovering-dictionary.git
cd vscode-hovering-dictionary
yarn        # or npm i
code .
# debug this extension by F5 key.

How to work?

This extension uses Level as a database in the background. The dictionary data is registered and kept in the storage directory the VSCode allows; e.g. C:\Users\hoge\AppData\Roaming\Code\User\globalStorage\take-me1010.hovering-dictionary if you are a Windows user.

vscode-hovering-dictionary's Issues

tasks for uix improvements

for more user-friendly ui/ux, we need to:

• show the loading progress in detail when registering a dict file.
• add some system to toggle whether the hover is shown or not.
  • done by bf4740f
• investigate the time and the memory usage when looking up words and try other DBs like LMDB.
• support on PDF file (may be difficult)

[Critical] cannot use and raise some error in mutil window situation