[Feature Request]Job timeout

Open
#482 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
42/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
lua
Domain
cli

Research direction

Start by tracing plenary.nvim's job feature from the issue's Lua example, including both sync() and start() usage. Determine where command completion and exit errors are handled. Done means users can set a millisecond timeout and receive an error when a command exceeds it; no files or tests are named in the issue.

Written by the indexing model from the issue text.

Description

Commands in plenary.nvim's job sometimes take a long time to resolve, which can be frustrating for users. To address this, I propose adding a timeout option to the plugin's job feature. This would allow users to set a timeout for commands and automatically quit the command with an error message if it takes too long to execute.

local Job = require'plenary.job'

Job:new({
  command = 'someTooLongTimeCommand',
  args = { '--files' },
  cwd = '/usr/bin',
  env = { ['a'] = 'b' },
  on_exit = function(j, return_val)
    print(return_val)
    print(j:result())
  end,
  timeout = 5000 -- timout with ms
}):sync() -- or start()
Dominant language
Lua
Stars
3.5k
Forks
340
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from nvim-lua/plenary.nvim

All issues in nvim-lua/plenary.nvim

Similar issues

More Lua issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.