feat: add please.look_up_target (closes #65)

Author: marcuscaisey

README.md

@@ -7,6 +7,7 @@ please.nvim is a plugin which allows you interact with your Please repository fr
   * Display history of previous commands and run any of them again with `please.history()`.
   * Set the profile to use with `please.set_profile()`.
   * Jump from a source file to its build target definition with `please.jump_to_target()`.
+  * Look up a build target by its label with `please.look_up_target()`.
   * Yank a target's label with `please.yank()`.
   * `please` configured as the `filetype` for `BUILD`, `BUILD.plz`, `*.build`, and `*.build_defs`
     files.

doc/please.txt

@@ -117,6 +117,7 @@ command to get you started.
     vim.keymap.set('n', '<leader>pp', please.set_profile)
     vim.keymap.set('n', '<leader>pm', please.maximise_popup)
     vim.keymap.set('n', '<leader>pj', please.jump_to_target)
+    vim.keymap.set('n', '<leader>pl', please.look_up_target)
     vim.keymap.set('n', '<leader>py', please.yank)
 <
 ==============================================================================
@@ -216,6 +217,13 @@ jump_to_target()                                     *please.jump_to_target()*
     found which should be the case for all targets except for those with names
     which are generated when the `BUILD` file is executed.
 
+look_up_target()                                     *please.look_up_target()*
+    Looks up a build target by its label and jumps to its location.
+
+    The cursor will be moved to where the build target is created if it can be
+    found which should be the case for all targets except for those with names
+    which are generated when the `BUILD` file is executed.
+
 yank()                                                         *please.yank()*
     If the current file is a `BUILD` file, yank the label of the target which
     is under the cursor. Otherwise, yank the label of the target which takes

lua/please.lua

@@ -542,6 +542,34 @@ function M.jump_to_target()
   end)
 end
 
+---Looks up a build target by its label and jumps to its location.
+---
+---The cursor will be moved to where the build target is created if it can be
+---found which should be the case for all targets except for those with names
+---which are generated when the `BUILD` file is executed.
+function M.look_up_target()
+  logging.log_call('please.look_up_target')
+
+  logging.log_errors('Failed to look up target', function()
+    local filepath = assert(get_filepath())
+    local root = assert(get_repo_root(filepath))
+    vim.ui.input({ prompt = 'Enter target to look up' }, function(label)
+      if not label then
+        return
+      end
+      label = vim.trim(label)
+      local target, errmsg = parsing.locate_build_target(root, label)
+      if not target then
+        logging.error('Failed to look up target: %s', errmsg)
+        return
+      end
+      logging.debug('opening %s at %s', target.file, vim.inspect(target.position))
+      vim.cmd('edit ' .. target.file)
+      vim.api.nvim_win_set_cursor(0, target.position)
+    end)
+  end)
+end
+
 ---If the current file is a `BUILD` file, yank the label of the target which is
 ---under the cursor. Otherwise, yank the label of the target which takes the
 ---current file as an input.

lua/please/parsing.lua

@@ -95,6 +95,9 @@ function M.locate_build_target(root, label)
   check_parser_installed('please')
 
   local pkg, name = label:match('^//([^:]*):([^/]+)$')
+  if not pkg or not name then
+    return nil, string.format('"%s" is not a valid label', label)
+  end
   local pkg_path = vim.fs.joinpath(root, pkg)
   for _, build_file_name in ipairs(build_file_names) do
     local build_path = vim.fs.joinpath(pkg_path, build_file_name)

tests/please/parsing_spec.lua

@@ -77,6 +77,12 @@ describe('locate_build_target', function()
       label = '//does/not/exist:target',
       expected_err = 'no build file exists for package "does/not/exist"',
     },
+    {
+      name = 'should return error if label is not a valid',
+      tree = { '.plzconfig' },
+      label = 'foo',
+      expected_err = '"foo" is not a valid label',
+    },
     {
       name = 'should return position for target at the start of a BUILD file',
       tree = {

tests/please_spec.lua

@@ -3,7 +3,7 @@ local please = require('please')
 local runner = require('please.runner')
 local temptree = require('tests.temptree')
 
--- require('please.logging').toggle_debug()
+require('please.logging').toggle_debug()
 
 -- When this test file is run multiple times in parallel (in a non-sandboxed environment), at least one of the runs
 -- usually fails because some functionality being tested relies on use of the clipboard which is being shared between
@@ -1007,6 +1007,42 @@ describe('jump_to_target', function()
   end)
 end)
 
+describe('look_up_target', function()
+  it('should jump to build target which uses it as an input', function()
+    local root = temptree.create({
+      '.plzconfig',
+      ['pkg/'] = {
+        BUILD = [[
+          export_file(
+              name = "foo1",
+              src = "foo1.txt",
+          )
+
+          export_file(
+              name = "foo2",
+              src = "foo2.txt",
+          )
+        ]],
+      },
+    })
+    local input_fake = InputFake:new()
+
+    -- GIVEN we're editing a file
+    vim.cmd('edit ' .. root .. '/foo1.txt')
+    -- WHEN we call look_up_target
+    please.look_up_target()
+    -- THEN we're prompted to enter the build target to look up
+    input_fake:assert_prompt('Enter target to look up')
+    -- WHEN we enter a build target
+    input_fake:enter_input('//pkg:foo2')
+    vim.wait(500)
+    -- THEN the BUILD file containing the build target is opened
+    assert.equal(root .. '/pkg/BUILD', vim.api.nvim_buf_get_name(0), 'incorrect BUILD file')
+    -- AND the cursor is moved to the build target
+    assert.same({ 6, 0 }, vim.api.nvim_win_get_cursor(0), 'incorrect cursor position')
+  end)
+end)
+
 describe('yank', function()
   local function create_temp_tree()
     return temptree.create({