Request for better documentation about the dependency on `curl`

Open
#495 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
lua
Domain
documentation

Research direction

The reported failure originates at plenary/curl.lua:273, with the stack also referencing plenary/job.lua:240. First locate the repository's existing dependency documentation, then document curl as a dependency with minimum version 7.43.0; done means users can discover the requirement and avoid the reported error.

Written by the indexing model from the issue text.

Description

If you are running a version of curl that is out of date, plenary jobs spam Neovim to the point of being unusable with this message

Error executing luv callback:                                                                                                 
...al/.config/nvim/bundle/plenary.nvim/lua/plenary/curl.lua:273: post http://localhost:35831/exa.language_server_pb.LanguageSe
rverService/Heartbeat - curl error exit_code=2 stderr={ "curl: option --data-raw: is unknown", "curl: try 'curl --help' or 'cu
rl --manual' for more information" }                                                                                          
stack traceback:                                                                                                              
        [C]: in function 'error'                                                                                              
        ...al/.config/nvim/bundle/plenary.nvim/lua/plenary/curl.lua:273: in function '_user_on_exit'                          
        ...nal/.config/nvim/bundle/plenary.nvim/lua/plenary/job.lua:240: in function '_shutdown'                              
        ...nal/.config/nvim/bundle/plenary.nvim/lua/plenary/job.lua:46: in function <...nal/.config/nvim/bundle/plenary.nvim/l
ua/plenary/job.lua:37>

--data-raw was added in curl 7.43.0. It'd be nice if this repo mentions that curl is a dependency and has an expected version minimum.

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.