Updating Doom Emacs.

.emacs.d/modules/tools/lookup/README.org

@@ -10,6 +10,7 @@
 - [[#prerequisites][Prerequisites]]
   - [[#macos][MacOS]]
   - [[#arch-linux][Arch Linux]]
+  - [[#nixos][NixOS]]
 - [[#features][Features]]
   - [[#jump-to-definition][Jump to definition]]
   - [[#find-references][Find references]]
@@ -24,33 +25,51 @@
   - [[#commands][Commands]]
 
 * Description
-Integrates with code navigation and documentation tools to help you quickly look
-up definitions, references and documentation.
+This module adds code navigation and documentation lookup tools to help you
+quickly look up definitions, references, documentation, dictionary definitions
+or synonyms.
 
 + Jump-to-definition and find-references implementations that just work.
 + Powerful xref integration for languages that support it.
-+ Documentation lookup for a variety of online sources (like devdocs.io,
-  stackoverflow or youtube).
++ Search online providers like devdocs.io, stackoverflow, google, duckduckgo or
+  youtube (duckduckgo and google have live suggestions).
 + Integration with Dash.app docsets.
++ Support for online (and offline) dictionaries and thesauruses.
 
 ** Module Flags
++ ~+dictionary~ Enable word definition and thesaurus lookup functionality.
+  + ~+offline~ Install and prefer offline dictionary/thesaurus.
 + ~+docsets~ Enable integration with Dash.app docsets.
+  + ~+xwidget~ Enable integration with [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Embedded-WebKit-Widgets.html][Embedded Webkit Widgets]].
 
 ** Plugins
 + [[https://github.com/jacktasia/dumb-jump][dumb-jump]]
 + [[https://github.com/alexmurray/ivy-xref][ivy-xref]] or [[https://github.com/brotzeit/helm-xref][helm-xref]]
-+ [[https://github.com/nathankot/counsel-dash][counsel-dash]] or [[https://github.com/areina/helm-dash][helm-dash]]
++ [[https://github.com/tkf/emacs-request][request]]
++ =+docsets=
+  + [[https://github.com/dash-docs-el/dash-docs][dash-docs]]
+  + [[https://github.com/nathankot/counsel-dash][counsel-dash]] or [[https://github.com/areina/helm-dash][helm-dash]]
++ =+dictionary=
+  + if macOS
+    + [[https://github.com/xuchunyang/osx-dictionary.el][osx-dictionary]]* (on macOS)
+  + else
+    + [[https://github.com/abo-abo/define-word][define-word]]
+    + [[https://github.com/maxchaos/emacs-powerthesaurus][powerthesaurus]]
+    + =+offline=
+      + [[https://github.com/gromnitsky/wordnut][wordnut]]
+      + [[https://github.com/hpdeifel/synosaurus][synosaurus]]
 
 * Prerequisites
 This module has several soft dependencies:
 
-+ ~the_silver_searcher~ or ~ripgrep~ (recommended) as a last-resort fallback for
-  jump-to-definition/find-references.
-+ ~sqlite3~ for Dash docset support.
++ ~ripgrep~ as a last-resort fallback for jump-to-definition/find-references.
++ ~sqlite3~ for Dash docset support (if you have =+docsets= enabled)
++ ~wordnet~ for offline dictionary and thesaurus support (if you have
+  =+dictionary +offline= enabled).
 
 ** MacOS
 #+BEGIN_SRC sh
-brew install the_silver_searcher ripgrep
+brew install ripgrep wordnet
 
 # An older version of sqlite is included in MacOS. If it causes you problems (and
 # folks have reported it will), install it through homebrew:
@@ -62,7 +81,17 @@ export PATH="/usr/local/opt/sqlite/bin:$PATH"
 
 ** Arch Linux
 #+BEGIN_SRC sh
-sudo pacman -S sqlite the_silver_searcher ripgrep
+sudo pacman -S sqlite ripgrep
+yay -S wordnet-cli
+#+END_SRC
+
+** NixOS
+#+BEGIN_SRC nix
+environment.systemPackages = with pkgs; [
+  ripgrep
+  sqlite
+  wordnet
+];
 #+END_SRC
 
 * Features
@@ -77,7 +106,7 @@ following sources before giving up:
    ~:lookup~ setting (see "Configuration" section).
 2. Any available xref backends.
 3. ~dumb-jump~ (a text search with aides to reduce false positives).
-3. An ordinary project-wide text search with ripgrep or the_silver_searcher.
+3. An ordinary project-wide text search with ripgrep.
 5. If ~evil-mode~ is active, use ~evil-goto-definition~, which preforms a simple
    text search within the current buffer.
 
@@ -93,7 +122,7 @@ will try:
 1. Whatever ~:references~ function is registered for the current buffer with the
    ~:lookup~ setting (see "Configuration" section).
 2. Any available xref backends.
-3. An ordinary project-wide text search with ripgrep or the_silver_searcher.
+3. An ordinary project-wide text search with ripgrep.
 
 If there are multiple results, you will be prompted to select one.