Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(quickfix): auto_close_when_success false is ignored #234

Merged
merged 2 commits into from
May 20, 2024
Merged

fix(quickfix): auto_close_when_success false is ignored #234

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
82c3b54
fix(quickfix): auto_close_when_success false is ignored
luxstudio90 May 19, 2024
cdabc3b
fix(quickfix): remove vim_defer_fn() on close
luxstudio90 May 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions lua/cmake-tools/quickfix.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,10 @@ function _quickfix.run(cmd, env_script, env, args, cwd, opts, on_exit, on_output
_quickfix.close(opts)
end, 100)
end
if code == 0 and not opts.auto_close_when_success then
_quickfix.show(opts)
_quickfix.scroll_to_bottom()
Copy link
Owner

@Civitasv Civitasv May 20, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When code equals 0, and auto_close_when_success is set to false, it should remain open. I don't see why should we add this block.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to be needed when the "Executor" has opts.auto_close_when_success = true and the "Runner" has opts.auto_close_when_success = false and both use quickfix.

If you run CMakeRun, the executor runs first, closing the quickfix window on success. Then the runner executes but the quickfix is closed by the runner and remains closed.

I can reproduce this all the time with the following config:

opts = {
    cmake_regenerate_on_save = true,
    cmake_generate_options = { "-DCMAKE_EXPORT_COMPILE_COMMANDS=1", "-GNinja" },
    cmake_build_directory = "build",
    cmake_soft_link_compile_commands = true,
    cmake_executor = {
      name = "quickfix", -- name of the executor
      opts = {
        show = "always",
        position = "belowright",
        size = 15,
        auto_close_when_success = true,
      },
    },
    cmake_runner = { 
      name = "quickfix", -- name of the runner
      opts = {
        show = "always",
        position = "belowright",
        size = 15,
        auto_close_when_success = false,
      },
    },
},

Can you check?

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can reproduce this with this config. But the pr cannot fix it. I think the reason is from vim.defer_fn.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed. Using the following seems to do the trick:

if code == 0 and opts.auto_close_when_success then
  -- vim.defer_fn(function()
  _quickfix.close(opts)
  -- end, 100)
end

Is there a reason for the vim.defer_fn on close?

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can remove this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have removed it. Behaviour is OK now.

end
if on_exit ~= nil then
on_exit(code)
end
Expand Down
Loading