Complete command line arguments #294

otreblan · 2021-06-09T00:42:25Z

Closes #117.

bash.mp4

In vim, - must be added to the keyword characters for this to work.

autocmd FileType sh set iskeyword+=45

codecov · 2021-06-09T01:00:35Z

Codecov Report

Merging #294 (bf5e329) into master (b8c0c64) will increase coverage by 0.25%.
The diff coverage is 80.76%.

@@            Coverage Diff             @@
##           master     #294      +/-   ##
==========================================
+ Coverage   74.04%   74.30%   +0.25%     
==========================================
  Files          18       18              
  Lines         551      576      +25     
  Branches       88       94       +6     
==========================================
+ Hits          408      428      +20     
- Misses        124      126       +2     
- Partials       19       22       +3

Impacted Files	Coverage Δ
server/src/server.ts	`63.58% <80.00%> (+1.45%)`	⬆️
server/src/analyser.ts	`83.23% <81.81%> (-0.21%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a16b288...bf5e329. Read the comment docs.

skovhus · 2021-06-09T11:46:04Z

@otreblan thanks for adding this! 👏 Do you have time to add a few unit tests? That would be great.

otreblan · 2021-06-09T13:28:24Z

@otreblan thanks for adding this! clap Do you have time to add a few unit tests? That would be great.

Done

skovhus

Thank you so much for contributing here. This would be a great addition to the language server.

The get-options.sh shell script doesn't seem that portable. I'm wondering if we can come up with a more portable/cross platform solution. Note the we already have the man and help page that we could parse.

Another thing: updating the triggerCharacters configuration option (line 107 in src/server.ts) to include - makes it work without additional configuration.

server/src/get-options.sh

server/src/server.ts

Co-authored-by: Kenneth Skovhus <skovhus@users.noreply.github.com>

otreblan · 2021-06-13T23:50:46Z

Another thing: updating the triggerCharacters configuration option (line 107 in src/server.ts) to include - makes it work without additional configuration.

When - is in triggerCharacters:

trigger.mp4

skovhus · 2021-07-04T19:32:19Z

server/src/get-options.sh

@@ -1,6 +1,8 @@
 #!/usr/bin/env bash

-source /usr/share/bash-completion/bash_completion
+DATADIR="$(pkg-config --variable=datadir bash-completion)"


How does the script handle if the user doesn't have the completion installed?

~ pkg-config --variable=datadir bash-completion package bash-completion was not found in the pkg-config search path. Perhaps you should add the directory containing `bash-completion.pc' to the PKG_CONFIG_PATH environment variable No package 'bash-completion' found ~ echo $? 1

At least on OS X the suggested solution doesn't work. Does the solution works on most Linux distributions?

It should work if the bash-completion package is installed and it provides a bash-completion.pc file.

skovhus

Thanks for adding this!

otreblan · 2021-08-11T19:10:03Z

server/src/get-options.sh

+	# Disabled by default because _longopt executes the program
+	# to get its options.
+	if (( ${BASH_LSP_COMPLETE_LONGOPTS} == 1 ))
+	then
+		_longopt "${COMP_WORDS[0]}"
+	fi


Btw _longopts is disabled until BASH_LSP_COMPLETE_LONGOPTS=1, because it can execute an arbirary program.

Ah, so we require people to set BASH_LSP_COMPLETE_LONGOPTS=1 in their bash profile, or?

gegoune · 2021-08-11T20:19:00Z

Should it work when editing sh file (with #!/usr/bin/env bash) in neovim started from zsh? I have installed bash-completion package with homebrew, but it does not provide completions on find -. bashls updated to 2.0.0 and iskeyword contains - (45).

otreblan · 2021-08-11T21:49:06Z

Should it work when editing sh file (with #!/usr/bin/env bash) in neovim started from zsh? I have installed bash-completion package with homebrew, but it does not provide completions on find -. bashls updated to 2.0.0 and iskeyword contains - (45).

Do you have bash-completion@1 or bash-completion@2?

gegoune · 2021-08-11T22:12:51Z

Version 1. Works with @2, thank you! Although I am only getting completions for find, none for head or sort, as per video above. Using native nvim LSP client.

otreblan · 2021-08-11T22:21:41Z

Version 1. Works with @2, thank you! Although I am only getting completions for find, none for head or sort, as per video above. Using native nvim LSP client.

gegoune · 2021-08-11T22:27:28Z

I see, there is no completions for those in /usr/local/share/bash-completion/completions/. Commands with completions there do work fine. Great job, thanks!

David-Else · 2021-09-03T17:53:45Z

Hi, I can't find any documentation on this feature in the README.

I have the following installed, and it works with find - [tab tab] on the command line:

Installed Packages
Name         : bash-completion
Epoch        : 1
Version      : 2.7
Release      : 5.el8
Architecture : noarch
Size         : 895 k
Source       : bash-completion-2.7-5.el8.src.rpm
Repository   : @System
From repo    : anaconda
Summary      : Programmable completion for Bash
URL          : https://github.com/scop/bash-completion
License      : GPLv2+
Description  : bash-completion is a collection of shell functions that take advantage
             : of the programmable completion feature of bash.

It does not seem to work in Neovim using the default config for the LSP https://github.com/neovim/nvim-lspconfig/blob/master/CONFIG.md#bashls and https://github.com/hrsh7th/nvim-cmp . Can anyone help? Thanks.

npm ls -g --depth=0
/usr/local/lib
├── bash-language-server@2.0.0

otreblan · 2021-09-03T20:15:28Z

@David-Else Whats the output of pkg-config --variable=datadir bash-completion?

David-Else · 2021-09-03T21:46:15Z

@otreblan The result is nothing, just an empty line. Also echo $BASH_COMPLETION gives an empty line too.

otreblan · 2021-09-03T21:57:35Z

@David-Else Does your installation has /usr/share/pkgconfig/bash-completion.pc?

David-Else · 2021-09-03T22:08:30Z

@otreblan yes:

$ls /usr/share/pkgconfig/
total 48K
drwxr-xr-x.   2 root root 4.0K Aug 16 11:42 .
drwxr-xr-x. 233 root root  12K Jul 21 09:17 ..
(various files)
-rw-r--r--.   1 root root  292 Apr 12 01:35 bash-completion.pc

otreblan · 2021-09-03T22:09:24Z

@David-Else And it's contents?

David-Else · 2021-09-03T22:11:22Z

@otreblan

bat /usr/share/pkgconfig/bash-completion.pc 
───────┬──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
       │ File: /usr/share/pkgconfig/bash-completion.pc
───────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
   1   │ prefix=/usr
   2   │ compatdir=/etc/bash_completion.d
   3   │ completionsdir=${prefix}/share/bash-completion/completions
   4   │ helpersdir=${prefix}/share/bash-completion/helpers
   5   │ 
   6   │ Name: bash-completion
   7   │ Description: programmable completion for the bash shell
   8   │ URL: https://github.com/scop/bash-completion
   9   │ Version: 2.7
───────┴──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────

Am I still meant to add autocmd FileType sh set iskeyword+=45, I assumed that was fixed somewhere in this PR?

otreblan · 2021-09-03T22:19:08Z

@David-Else Your bash-completion is too old, datadir was added 2 years ago https://github.com/scop/bash-completion/blame/master/bash-completion.pc.in

David-Else · 2021-09-03T22:24:51Z

@otreblan Cheers! I will try to update using the source from Github, I am using Rocky Linux 8, and they do have some out of date things hidden in there.

Noteworthy changes: * Upgrade dependencies * Adds support for completing command line arguments (bash-lsp/bash-language-server#294) * Default configuration change: parsing errors are not highlighted as problems (as the grammar is buggy)

David-Else · 2022-02-12T14:20:06Z

@otreblan Hello again. I removed my old Centos 8 RPM version of bash-completion and installed the latest from source. Now my bash-completion.pc is installed in /usr/local/share/pkgconfig and says:

prefix=/usr/local
datadir=/usr/local/share
sysconfdir=/usr/local/etc

compatdir=${sysconfdir}/bash_completion.d
completionsdir=${datadir}/bash-completion/completions
helpersdir=${datadir}/bash-completion/helpers

Name: bash-completion
Description: programmable completion for the bash shell
URL: https://github.com/scop/bash-completion
Version: 2.11

I am still not getting auto completion in neovim. You asked me before did I have /usr/share/pkgconfig/bash-completion.pc, now the file has moved could that be the problem? Thanks.

EDIT pkg-config --variable=datadir bash-completion still shows nothing

David-Else · 2022-04-20T19:42:53Z

@otreblan Thanks to the new 2.1 version it now works! :)

David-Else · 2023-01-04T17:42:42Z

This feature works in Helix, but there is a problem. It does not happen in Neovim, can it be solved here or should I make a request to the Helix devs? If so, what should I ask them to implement? Cheers!

Type find - and ctrl-x to trigger autocomplete:
Select depth

Now you are left with the original - that should not be there, it should be -depth not --depth

skovhus · 2023-01-04T18:12:07Z

@David-Else it seems like a Helix issue as it works in all other clients. And I'm honestly not sure what the issue is.

David-Else · 2023-01-04T18:59:26Z

@skovhus Thanks for the quick reply!

otreblan added 3 commits June 8, 2021 19:28

Complete command line arguments

47319f8

Prettier

43c3c93

Eslint autofix

3835106

Merge branch 'master' into master

c93d131

otreblan added 2 commits June 9, 2021 06:59

Add commandNameAtPoint test

7d6916d

Test onCompletion for command options

c2ec492

skovhus reviewed Jun 13, 2021

View reviewed changes

server/src/get-options.sh Show resolved Hide resolved

server/src/get-options.sh Outdated Show resolved Hide resolved

server/src/get-options.sh Outdated Show resolved Hide resolved

server/src/server.ts Show resolved Hide resolved

server/src/server.ts Outdated Show resolved Hide resolved

otreblan and others added 7 commits June 13, 2021 17:19

Trim and filter results

f956526

Co-authored-by: Kenneth Skovhus <skovhus@users.noreply.github.com>

Generic way of getting the path to bash_completion

25da9ac

set -uo pipefail

0206cb5

No pipefail

54527cf

No set

d8b2adc

Disable _longopt by default

f902cf4

Return an empty array when get-completions fails

682de8a

skovhus reviewed Jul 4, 2021

View reviewed changes

otreblan and others added 3 commits July 4, 2021 14:48

Exit get-options.sh if bash-completion isn't installed

3cff08d

Merge branch 'master' into master

16ad7d6

Merge branch 'master' into master

bf5e329

skovhus approved these changes Aug 11, 2021

View reviewed changes

skovhus merged commit 2b4d8a6 into bash-lsp:master Aug 11, 2021

otreblan commented Aug 11, 2021

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Complete command line arguments #294

Complete command line arguments #294

otreblan commented Jun 9, 2021

codecov bot commented Jun 9, 2021 •

edited

Loading

skovhus commented Jun 9, 2021

otreblan commented Jun 9, 2021

skovhus left a comment

otreblan commented Jun 13, 2021

skovhus Jul 4, 2021

skovhus Jul 4, 2021 •

edited

Loading

otreblan Jul 4, 2021

skovhus left a comment

otreblan Aug 11, 2021

skovhus Aug 11, 2021

gegoune commented Aug 11, 2021 •

edited

Loading

otreblan commented Aug 11, 2021

gegoune commented Aug 11, 2021

otreblan commented Aug 11, 2021

gegoune commented Aug 11, 2021

David-Else commented Sep 3, 2021

otreblan commented Sep 3, 2021

David-Else commented Sep 3, 2021 •

edited

Loading

otreblan commented Sep 3, 2021

David-Else commented Sep 3, 2021

otreblan commented Sep 3, 2021

David-Else commented Sep 3, 2021

otreblan commented Sep 3, 2021

David-Else commented Sep 3, 2021

David-Else commented Feb 12, 2022 •

edited

Loading

David-Else commented Apr 20, 2022

David-Else commented Jan 4, 2023

skovhus commented Jan 4, 2023

David-Else commented Jan 4, 2023

Complete command line arguments #294

Complete command line arguments #294

Conversation

otreblan commented Jun 9, 2021

codecov bot commented Jun 9, 2021 • edited Loading

Codecov Report

skovhus commented Jun 9, 2021

otreblan commented Jun 9, 2021

skovhus left a comment

Choose a reason for hiding this comment

otreblan commented Jun 13, 2021

skovhus Jul 4, 2021

Choose a reason for hiding this comment

skovhus Jul 4, 2021 • edited Loading

Choose a reason for hiding this comment

otreblan Jul 4, 2021

Choose a reason for hiding this comment

skovhus left a comment

Choose a reason for hiding this comment

otreblan Aug 11, 2021

Choose a reason for hiding this comment

skovhus Aug 11, 2021

Choose a reason for hiding this comment

gegoune commented Aug 11, 2021 • edited Loading

otreblan commented Aug 11, 2021

gegoune commented Aug 11, 2021

otreblan commented Aug 11, 2021

gegoune commented Aug 11, 2021

David-Else commented Sep 3, 2021

otreblan commented Sep 3, 2021

David-Else commented Sep 3, 2021 • edited Loading

otreblan commented Sep 3, 2021

David-Else commented Sep 3, 2021

otreblan commented Sep 3, 2021

David-Else commented Sep 3, 2021

otreblan commented Sep 3, 2021

David-Else commented Sep 3, 2021

David-Else commented Feb 12, 2022 • edited Loading

David-Else commented Apr 20, 2022

David-Else commented Jan 4, 2023

skovhus commented Jan 4, 2023

David-Else commented Jan 4, 2023

codecov bot commented Jun 9, 2021 •

edited

Loading

skovhus Jul 4, 2021 •

edited

Loading

gegoune commented Aug 11, 2021 •

edited

Loading

David-Else commented Sep 3, 2021 •

edited

Loading

David-Else commented Feb 12, 2022 •

edited

Loading