Add tmux completion #81

srsudar · 2016-10-13T18:49:55Z

This is adapted from the following project:

https://github.com/srsudar/tmux-completion

I've tried to follow the contributing guidelines and similar PRs that add a file. My bash knowledge is sufficiently low that some of the contributing guidelines are over my head. If I'm missing any I apologize.

Do you have any documentation on the testing framework you're using so I can write tests? Or a pointer to a command with a minimal test that can serve as an example?

This is adapted from the following project: https://github.com/srsudar/tmux-completion

scop

Bunch of comments posted. But first, most importantly, have you asked if the tmux project would be interested in including this with tmux itself?

Wrt testing, see doc/testing.txt

scop · 2016-10-13T18:58:05Z

completions/tmux

+    _init_completion || return
+
+    COMPREPLY=()
+    cur="${COMP_WORDS[COMP_CWORD]}"


Setting COMPREPLY and cur here are not necessary

scop · 2016-10-13T18:58:36Z

completions/tmux

+
+    COMPREPLY=()
+    cur="${COMP_WORDS[COMP_CWORD]}"
+    onePrev="${COMP_WORDS[COMP_CWORD-1]}"


How is onePrev different from the already existing $prev?

scop · 2016-10-13T18:58:58Z

completions/tmux

+    cur="${COMP_WORDS[COMP_CWORD]}"
+    onePrev="${COMP_WORDS[COMP_CWORD-1]}"
+
+    if [ "$COMP_CWORD" -ge 2 ]; then


Use $cword instead of $COMP_CWORD

scop · 2016-10-13T19:00:04Z

completions/tmux

+        windowCommands=("ls", "list-sessions")
+
+        prev="${COMP_WORDS[COMP_CWORD-2]}"
+        if [ "$prev" = "attach" ] || [ "$prev" = "attach-session" ] ; then


Use words instead of COMP_WORDS and cword instead of COMP_CWORD. Also, rename this to something like preprev instead of overloading the usual definition of prev

scop · 2016-10-13T19:00:36Z

completions/tmux

+        if [ "$prev" = "attach" ] || [ "$prev" = "attach-session" ] ; then
+            if [ "$onePrev" = "-t" ] ; then
+            # Get a list of all session names.
+            # We're assuming this output is in the form:


Seems like there's a missing indent step within the if block here

scop · 2016-10-13T19:06:13Z

completions/tmux

+    fi
+
+    opts=" \
+    attach-session \


Not a big fan of this long hardcoded list in the first place. Can't it be generated from somewhere?

If not, please indent the options, and the backslashes are unnecessary I think.

scop · 2016-10-13T19:06:33Z

completions/tmux

+    unlink-window \
+    up-pane"
+
+    COMPREPLY=($(compgen -W "${opts}" -- ${cur}))


$cur in double quotes

scop · 2016-10-13T19:06:53Z

completions/tmux

+
+    COMPREPLY=($(compgen -W "${opts}" -- ${cur}))
+    return
+


Unnecessary return and empty line

scop · 2016-10-13T19:07:28Z

completions/tmux

+    COMPREPLY=($(compgen -W "${opts}" -- ${cur}))
+    return
+
+}


"} &&" here, see existing completions

scop · 2016-10-13T19:07:54Z

completions/tmux

@@ -0,0 +1,134 @@
+# tmux(1) completion


Missing -*- shell-script -*-, see existing completions

srsudar · 2016-10-13T21:16:03Z

I hadn't even thought to check if tmux wanted to incorporate it. Looking at their repo I see that in their README they link to another repo that provides tmux-specific completion.

That pointer, along with this closed issue, make it sound like they aren't keen on including the completions as part of tmux. Would you prefer I ask explicitly before considering an eventual merge?

The completion script they link to looks like it attempts to do more things than this PR, but it is giving me errors when I try to use it. Since they recommend that one in their documentation, however, maybe accepting something like this would constitute a break from their semi-official completion? Would that preclude a merge?

scop · 2016-10-14T05:50:41Z

I suggest you work with upstream and the other tmux completion author first. I cannot comment on their wishes and practices as I'm not at all involved with those projects, but It's generally the better the closer to upstream packages completions are kept. That way for instance some things can be hardcoded in the completion (e.g. the option list: if the completion was shipped with tmux, it could be easily kept up to date with the tmux version it ships), which is not a luxury we have in bash-completion. Also, more importantly, a maintainer who is actively using the completion is a good thing to have, if not a necessity. I'm not a tmux user and there are no other active project members at the moment.

Closing at least for now, post a note here if things don't work out with upstream and the other recommended tmux completion author. But be prepare to make a case for inclusion here, I'm reluctant to add another completion in bash-completion over upstream tmux recommendations and for the reasons outlined above.

srsudar · 2016-10-14T14:22:51Z

All of those seem like compelling points to me. No worries.

imomaliev · 2016-10-17T05:58:59Z

@srsudar Hi. I am current maintainer of tmux-bash-completion. What errors are you having? You can submit your issues here https://github.com/imomaliev/tmux-bash-completion/issues.

srsudar · 2016-10-17T18:54:50Z

I decided not to open an issue because I only tried very briefly and I wasn't sure it was a problem with the project rather than my setup. I'll open an issue there just so you can respond and this doesn't linger as something unaddressed about the project. =)

srsudar · 2016-10-17T18:59:39Z

Opened an issue.

Boruch-Baum · 2019-02-26T19:34:40Z

I just corresponded with the tmux developer, and confirmed that he has no interest in having his repository host a bash completion script. I recently wrote a very comprehensive one, and can offer it to this project. In reading the prior comments on this thread, I see a reference to another tmux-completion repository, so I looked there, and mine is way more comprehensive. If you're interested, I can make a PR.

imomaliev · 2019-02-27T03:01:43Z

@Boruch-Baum Hi, I am currently maintaining bash-completion script for tmux that is suggested in README for tmux https://github.com/imomaliev/tmux-bash-completion/ if you are interested in helping I could give you collaborator access

Boruch-Baum · 2019-02-27T03:32:30Z

@imomaliev : Hi! I don't mind sharing. My preference is for my code contribution to be widely distributed (as long as it works well). If the 'bash completion' accepts my work, then it automatically is included in the debian and other repositories and for anyone who has the package, it will 'just work' without having to search the internet, and manually maintain the file. tmux is a popular enough package to deserve inclusion here. If this doesn't work, I might try approaching the developers of the tmux plugin manager, which is also a debian package, and is very common for tmux user to use. If that doesn't work out, then I might try making it a tmux plug-in, which seems do-able since the mechanics are just a shell script - it just doesn't need a keybinding. Having a totally stand-alone repository for a single bash completion just doesn't seem right; imagine the hassle if that were the case for every package!

scop · 2019-04-21T10:17:02Z

I agree that generally hosting a completion with us here is the 2nd best option to having it upstream. So my suggestion for you is to:

merge your work into a single file, perhaps in the @imomaliev repository so improvements while you work are available to the public until it lands here
adjust code style, practices etc with the ones in this repository
once all that is done, prepare another pull request here and I'll have a look
volunteer to maintain the code here in bash-completion once it's in

Boruch-Baum · 2019-10-25T19:35:35Z

@scop @imomaliev @jackfletch : Jack Fletcher's comment finally got me to at least post my work, but I'm not available now for the back-and-forth that @scop is suggesting, so if someone else will carry the ball on it, great. See here.

scop · 2020-04-19T07:02:27Z

Any progress on this front? I'm slowly starting to use tmux myself, so would have more incentive to help out.

Boruch-Baum · 2020-04-19T07:35:04Z

On 2020-04-19 00:02, Ville Skyttä wrote: Any progress on this front? I'm slowly starting to use tmux myself, so would have more incentive to help out.

@scop: Likewise, I've received no response to the work[1] that I published six months ago and referenced here[2]. It's a complete implementation in a single file, so you should be able to just drop it into your bash-completion folder and benefit from it. 1] https://github.com/Boruch-Baum/tmux_bash_completion -- hkp://keys.gnupg.net CA45 09B5 5351 7C11 A9D1 7286 0036 9E45 1595 8BC0

imomaliev · 2020-04-19T08:58:05Z

I would gladly help with making this completion file https://github.com/imomaliev/tmux-bash-completion part of bash-completion upstream, or any other file chosen as base for this

scop · 2020-05-01T12:13:37Z

so you should be able to just drop it into your bash-completion folder and benefit from it.

Of course I won't do something like that, we have a project that hosts and ships completions here :) Personally I only use completions that are shipped along with the respective upstream tools, or ones we ship here, to maximize sharing the benefit to others.

scop · 2020-05-01T12:17:24Z

I would gladly help with making this completion file https://github.com/imomaliev/tmux-bash-completion part of bash-completion upstream, or any other file chosen as base for this

Since you're the only one who promised active help within these past two weeks, if you are available also to help out by maintaining the file within bash-completion in long term starting when it's in (I'll give you contributor access for that), you get to choose the base implementation. If you agree, feel free to post a PR and let's start working on it.

scop · 2020-05-01T12:21:31Z

The above comment doesn't BTW mean that others would not be welcome to help out too, and I'll gladly give collaborator access to people now and later who do good work and can show some, are willing to commit to the project's ways, and intend to be available to help out in longer term. I just want to have someone (or more) active here besides myself to drive the inciusion.

imomaliev · 2020-07-28T08:21:14Z

If there are no new collaborators, on this issue, I think I will have time next week to start working on this

Add tmux completion

9313fe6

This is adapted from the following project: https://github.com/srsudar/tmux-completion

srsudar mentioned this pull request Oct 13, 2016

Merging upstream srsudar/tmux-completion#2

Closed

scop requested changes Oct 13, 2016

View reviewed changes

scop closed this Oct 14, 2016

aprokop mentioned this pull request Oct 14, 2016

submit this to upstream bash-completion project imomaliev/tmux-bash-completion#1

Open

srsudar mentioned this pull request Oct 17, 2016

_get_comp_words_by_ref not found imomaliev/tmux-bash-completion#3

Closed

imomaliev mentioned this pull request Jan 11, 2017

Request to merge this project into bash-completion. imomaliev/tmux-bash-completion#4

Closed

srsudar mentioned this pull request Oct 19, 2020

Can you add support for rename-session please? srsudar/tmux-completion#7

Closed

imomaliev mentioned this pull request Oct 5, 2022

Help maintaining imomaliev/tmux-bash-completion#13

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add tmux completion #81

Add tmux completion #81

srsudar commented Oct 13, 2016

scop left a comment

scop Oct 13, 2016

scop Oct 13, 2016

scop Oct 13, 2016

scop Oct 13, 2016

scop Oct 13, 2016

scop Oct 13, 2016

scop Oct 13, 2016

scop Oct 13, 2016

scop Oct 13, 2016

scop Oct 13, 2016

srsudar commented Oct 13, 2016

scop commented Oct 14, 2016

srsudar commented Oct 14, 2016

imomaliev commented Oct 17, 2016

srsudar commented Oct 17, 2016

srsudar commented Oct 17, 2016

Boruch-Baum commented Feb 26, 2019

imomaliev commented Feb 27, 2019

Boruch-Baum commented Feb 27, 2019

scop commented Apr 21, 2019

Boruch-Baum commented Oct 25, 2019

scop commented Apr 19, 2020

Boruch-Baum commented Apr 19, 2020 via email

imomaliev commented Apr 19, 2020 •

edited

Loading

scop commented May 1, 2020

scop commented May 1, 2020

scop commented May 1, 2020 •

edited

Loading

imomaliev commented Jul 28, 2020 •

edited

Loading

Add tmux completion #81

Add tmux completion #81

Conversation

srsudar commented Oct 13, 2016

scop left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

srsudar commented Oct 13, 2016

scop commented Oct 14, 2016

srsudar commented Oct 14, 2016

imomaliev commented Oct 17, 2016

srsudar commented Oct 17, 2016

srsudar commented Oct 17, 2016

Boruch-Baum commented Feb 26, 2019

imomaliev commented Feb 27, 2019

Boruch-Baum commented Feb 27, 2019

scop commented Apr 21, 2019

Boruch-Baum commented Oct 25, 2019

scop commented Apr 19, 2020

Boruch-Baum commented Apr 19, 2020 via email

imomaliev commented Apr 19, 2020 • edited Loading

scop commented May 1, 2020

scop commented May 1, 2020

scop commented May 1, 2020 • edited Loading

imomaliev commented Jul 28, 2020 • edited Loading

imomaliev commented Apr 19, 2020 •

edited

Loading

scop commented May 1, 2020 •

edited

Loading

imomaliev commented Jul 28, 2020 •

edited

Loading