Merge pull request #76 from MrcJkb/74-fix-mandatory-telescope

fix(hoogle): don't setup hoogle local when telescope is missing

Author: mrcjkb

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.4.3] - 2022-12-06
+### Fixed
+- Error message shown if hoogle is installed, but telescope is missing
+
 ## [1.4.2] - 2022-11-19
 ### Fixed
 - Bug causing hls to always use default settings

flake.lock

@@ -103,7 +103,10 @@
         in
         {
           formatting = pre-commit-check-for system;
-          inherit (checkPkgs) haskell-tools-test;
+          inherit (checkPkgs)
+            haskell-tools-test
+            haskell-tools-test-no-telescope
+            haskell-tools-test-no-telescope-with-hoogle;
         });
     };
 }

flake.nix

@@ -25,7 +25,7 @@ function M.require_or_err(modname, plugin_name)
   return M.if_available(modname, function(mod)
     return mod
   end, function()
-    error('haskell-tools: This plugin requires the ' .. plugin_name .. ' plugin.')
+    vim.notify_once('haskell-tools: This plugin requires the ' .. plugin_name .. ' plugin.', vim.log.levels.ERROR)
   end)
 end
 

lua/haskell-tools/deps.lua

@@ -66,7 +66,7 @@ local function setup_telescope_search()
 end
 
 function M.setup()
-  if M.has_hoogle() then
+  if M.has_hoogle() and deps.has_telescope() then
     setup_telescope_search()
   end
 end

lua/haskell-tools/hoogle/local.lua

@@ -1,10 +1,11 @@
 { packer-nvim, plenary-nvim, nvim-lspconfig, telescope-nvim }:
 final: prev:
 with final.lib;
+with final.lib.strings;
 with final.stdenv;
 
 let
-  mkPlenaryTest = { nvim ? final.neovim, name }: mkDerivation {
+  mkPlenaryTest = { name, nvim ? final.neovim, withTelescope ? true, extraPkgs ? [ ] }: mkDerivation {
     inherit name;
 
     phases = [
@@ -17,22 +18,23 @@ let
     buildInputs = with final; [
       nvim
       makeWrapper
-    ];
+    ] ++ extraPkgs;
 
     buildPhase = ''
       mkdir -p $out
       mkdir -p $out/.config/nvim/site/pack/packer/start
       ln -s ${packer-nvim} $out/.config/nvim/site/pack/packer/start/packer.nvim
       ln -s ${plenary-nvim} $out/.config/nvim/site/pack/packer/start/plenary.nvim
       ln -s ${nvim-lspconfig} $out/.config/nvim/site/pack/packer/start/nvim-lspconfig
-      ln -s ${telescope-nvim} $out/.config/nvim/site/pack/packer/start/telescope.nvim
+      ${optionalString withTelescope "ln -s ${telescope-nvim} $out/.config/nvim/site/pack/packer/start/telescope.nvim"}
       ln -s ${./..} $out/.config/nvim/site/pack/packer/start/${name}
     '';
 
     checkPhase = ''
       export NVIM_DATA_MINIMAL=$(realpath $out/.config/nvim)
       export HOME=$(realpath .)
       cd ${./..}
+      # TODO: split test directories by environment
       nvim --headless --noplugin -u ${../tests/minimal.lua} -c "PlenaryBustedDirectory tests {minimal_init = '${../tests/minimal.lua}'}"
     '';
   };
@@ -42,4 +44,8 @@ in
 
   haskell-tools-test = mkPlenaryTest { name = "haskell-tools.nvim"; };
 
+  haskell-tools-test-no-telescope = mkPlenaryTest { name = "haskell-tools.nvim"; withTelescope = false; };
+
+  haskell-tools-test-no-telescope-with-hoogle = mkPlenaryTest { name = "haskell-tools.nvim"; withTelescope = false; extraPkgs = [ final.pkgs.haskellPackages.hoogle ]; };
+
 }

nix/test-overlay.nix

@@ -51,7 +51,6 @@ packer.startup(function(use)
     requires = {
       'neovim/nvim-lspconfig',
       'nvim-lua/plenary.nvim',
-      'nvim-telescope/telescope.nvim',
     },
     config = function()
       -- Paste setup here

tests/minimal.lua

@@ -1,5 +1,8 @@
 local ht = require('haskell-tools')
+local stub = require('luassert.stub')
 describe('Can call setup with default configs.', function()
+  local notify_once = stub(vim, 'notify_once')
+  local notify = stub(vim, 'notify')
   ht.setup()
   it('Public API is available after setup.', function()
     assert(ht.config ~= nil)
@@ -9,4 +12,8 @@ describe('Can call setup with default configs.', function()
     assert(ht.project ~= nil)
     assert(ht.tags ~= nil)
   end)
+  it('No notifications at startup.', function()
+    assert.stub(notify_once).was_not_called()
+    assert.stub(notify).was_not_called()
+  end)
 end)