Adds support for tab-completion of all parameters, long and short #395

seamlessintegrations · 2017-02-02T21:37:27Z

This fork adds support for tab-completing of nearly all parameters, short (-) and long (--), even with tab-completion of values.

…status, rm

… status, rm

rkeithhill

We have started adding Pester tests for TabExpansion. Could you add some Pester tests for this functionality? Look at test/TabExpansion.Tests.ps1 for examples of how to do this.

rkeithhill · 2017-02-02T21:42:09Z

src/GitTabExpansion.ps1

+function script:expandParams($cmd, $filter) {
+    $params[$cmd] -split ' ' |
+        where { $_ -like "$filter*" } |
+        sort |


Please replace all aliases with the full command name: where -> where-object, sort -> sort-object, foreach -> foreach-object. We have folks running this on PowerShell Core on Linux and sort is a native command (not an alias for Sort-Object).

rkeithhill · 2017-02-02T21:43:56Z

src/ParamsExpansions.ps1

+    status = @{
+        'untracked-files' = 'no normal all'
+        'ignore-submodules' = 'none untracked dirty all' }
+}


EOL at EOF please. We have a .editorconfig file that will handle this if you use an editor that works with EditorConfig files. For instance, Visual Studio Code.

rkeithhill · 2017-02-02T22:34:32Z

src/posh-git.psm1

@@ -17,6 +17,7 @@ if ($psv.Major -lt 3 -and !$NoVersionWarn) {
 . $PSScriptRoot\GitUtils.ps1
 . $PSScriptRoot\GitPrompt.ps1
 . $PSScriptRoot\GitTabExpansion.ps1
+. $PSScriptRoot\ParamsExpansions.ps1


How about renaming this file to GitParamTabExpansion.ps1 (no need for the s on Params or Expansions). I think that would be consistent with most of the other scripts. Thanks!

rkeithhill · 2017-02-02T22:38:13Z

BTW I suspect this PR will need to undo or tweak what I did in PR #379. In that PR, I updated regex to ignore parameter between the remote and multiple refspec paths.

rkeithhill · 2017-02-02T23:12:47Z

src/posh-git.psm1

@@ -17,7 +17,7 @@ if ($psv.Major -lt 3 -and !$NoVersionWarn) {
 . $PSScriptRoot\GitUtils.ps1
 . $PSScriptRoot\GitPrompt.ps1
 . $PSScriptRoot\GitTabExpansion.ps1
-. $PSScriptRoot\ParamsExpansions.ps1
+. $PSScriptRoot\GitParamsExpansion.ps1


Sorry for being a bit pedantic here, but could you make that GitParamTabExpansion.ps1. Thanks.

rkeithhill · 2017-02-02T23:32:16Z

@seamlessintegrations Do you have a good debugger setup? If not, I'd recommend grabbing VS Code http://code.visualstudio.com. Then use Visual Studio Code to open your cloned posh-git folder. Open your Pester tests file and VS Code should prompt you to install the PowerShell extension. Once that is installed it will ask you to reload so the extension can be started. Once that is done, set a breakpoint in your test script, open the Debug view (View | Debug) and select "Launch Pester Tests" from the launch configuration drop down. Now press F5 and you'll be debugging your Pester tests.

Also, you might want to load the "EditorConfig for VS Code" extension. It will use the settings in that .editorconfig file.

seamlessintegrations · 2017-02-02T23:44:53Z

@rkeithhill Thanks alot for your hints. I was just using powershell and vim / notepad++.

Regarding PR #379 I'm not quite sure what you mean. the gitParams regex works just fine with my params tab completion additions, and I can't see for what reasons they shouldn't.

rkeithhill · 2017-02-03T00:31:01Z

Does param completion work for fetch/push/pull? If so, then I guess we're good.

rkeithhill · 2017-02-03T00:46:43Z

Nevermind. I see you have tests specifically for push. I want to get @dahlbyk to review this as well.

rkeithhill · 2017-02-03T00:51:42Z

test/ParamsTabExpansion.Tests.ps1

@@ -0,0 +1,45 @@
+. $PSScriptRoot\Shared.ps1


Can you rename your Pester test file to GitParamTabExpansion.Tests.ps1. We have a fledgling conventions of <filename-under-test>.Tests.ps1. Thanks.

seamlessintegrations · 2017-02-03T01:07:04Z

I have tests only for push because this covers all functions that I've written. I can add more if you want.

Param Completion works for add, bisect, blame, branch, checkout, clean, clone, commit, config, describe, diff, difftool, fetch, gc, grep, help, init, log, merge, mergetool, mv, notes, prune, pull, push, rebase, reflog, remote, reset, revert, rm, shortlog, show, stash, status, submodule, tag and whatchanged. So yes, it works for fetch/push/pull.

Even parameter values can be completed or cycled through by repeatedly pressing TAB, e.g.

git pull --rebase=TAB => false
git pull --rebase=TAB => preserve
git pull --rebase=TAB => true

dahlbyk

This is awesome! Many many thanks for taking the initiative on this!

dahlbyk · 2017-02-03T19:38:04Z

src/GitTabExpansion.ps1

@@ -330,6 +351,21 @@ function GitTabExpansionInternal($lastBlock) {
            gitBranches $matches['ref'] $true
            gitTags $matches['ref']
        }
+
+        # Handles git <cmd> --<param>=<value>
+        "^(?<cmd>$($someCommands -join '|')).* --(?<param>[^=]+)=(?<value>\S*)$" {


I'm not terribly concerned about performance, but can we precompute $someCommands -join '|' since it's used a couple times?

More generally, It seems a little curious to use $someCommands here rather than explicitly looking for the keys in $paramvalues (or $params/$shortparams). Does everything still work as expected if a command is found in $someCommands but not one of the params lists? If not, we might consider a test to iterate over $someCommands (via tab-completing git <tab>) checking if long and short parameters can be completed successfully.

dahlbyk · 2017-02-03T19:43:41Z

src/GitParamTabExpansion.ps1

+$params = @{
+    add = 'dry-run verbose force interactive patch edit update all no-ignore-removal no-all ignore-removal intent-to-add refresh ignore-errors ignore-missing'
+    bisect = 'no-checkout term-old term-new'
+	blame = 'root show-stats reverse porcelain line-porcelain incremental encoding= contents date score-debug show-name show-number show-email abbrev'


tab? spaces!

dahlbyk · 2017-02-03T19:48:56Z

src/GitParamTabExpansion.ps1

+        encoding = 'utf-8' }
+    status = @{
+        'untracked-files' = 'no normal all'
+        'ignore-submodules' = 'none untracked dirty all' }


Formatting nitpick - can you move the } on these definitions to its own line? If we need to add a parameter, diffs like this are a pet peeve:

- 'ignore-submodules' = 'none untracked dirty all' } + 'ignore-submodules' = 'none untracked dirty all' + 'insects' = 'ant butterfly' }

vs

'ignore-submodules' = 'none untracked dirty all' + 'insects' = 'ant butterfly' }

rkeithhill · 2017-02-04T04:00:44Z

Yeah, pretty awesome indeed. I'm looking forward to this functionality!

Also added cached param to diff. That param should be there, right? I mean, I use git diff --cached quite a bit.

rkeithhill · 2017-02-04T19:00:24Z

@dahlbyk Can we approve this? I have a PR queued up that fixes each of the issues you've raised. Also the cached parameter seems to be missing from the git diff command. It should be there, right?

Also, any chance you'd enable "squash & merge" on this repo - at least temporarily? I think this PR would be a good candidate for that.

Update: I submitted a PR to @seamlessintegrations fork. Hopefully, he'll have time shortly to look at it and merge it. I believe it should address all of @dahlbyk review issues.

seamlessintegrations · 2017-02-06T08:28:55Z

I'm sorry. I haven't seen your PR until now. I'll merge it soon.

rkeithhill · 2017-02-06T14:32:48Z

LGTM!

dahlbyk · 2017-02-06T16:54:55Z

Also, any chance you'd enable "squash & merge" on this repo - at least temporarily? I think this PR would be a good candidate for that.

I'm philosophically opposed to "squash & merge" because it loses the association between the PR commits and it coming into master:

* 7839e32 (HEAD -> master) Merge branch 'feature'
| * a3d6c38 (feature) Commit G
| * 1897f3d Commit F
| * 32bc8c4 Commit E
| * 510d269 Commit D
| * 7374aa9 Commit C
| * 8ec9109 Commit B
| * 2d02a6d Commit A
|/
* 9ca3d76

If we wanted to squash the commits, we should do it here in the PR branch. But history here is already rather messy anyway from merging year-old PRs - this is no exception.

Thanks again, @seamlessintegrations!

seamlessintegrations added 13 commits April 12, 2015 05:32

tab completion for branch and log parameters implemented

2f4af9f

tab completion for add and status parameters implemented

1ad85e2

tab completion for diff and merge parameters implemented

021afc4

parameter values completion added for add, branch, diff, log, merge, …

53ddd27

…status, rm

added support for short parameters for add, branch, diff, log, merge,…

3c97e14

… status, rm

added tab completion for commit cmd

98b0b9f

added tab completion for checkout, fetch, pull, push cmds

8a6a99d

added tab completion for rebase

57c9159

added tab completion for all other cmds except bisect, svn

f990b3b

added tab completion for bisect

f40922a

Merge branch 'master' of https://github.com/dahlbyk/posh-git

df39d27

moved file due to new filesystem layout

c76f1f6

moved source params expansion statement into posh-git.psm1

fc39c00

rkeithhill requested changes Feb 2, 2017

View reviewed changes

seamlessintegrations added 4 commits February 2, 2017 23:13

replaced aliases with full cmdlet names

4361b1b

whitespaces / eol / eof fixes

bf2bda9

eol at eof added

0302fd5

renamed file for consistency reasons

fe0608e

rkeithhill reviewed Feb 2, 2017

View reviewed changes

seamlessintegrations added 2 commits February 3, 2017 00:16

renamed file for consistency reasons

dffdbd3

added parameter tab expansion tests

8eff9cc

corrected test result expectations

f11d033

rkeithhill reviewed Feb 3, 2017

View reviewed changes

renamed file for consistency reasons

a96f23c

dahlbyk reviewed Feb 3, 2017

View reviewed changes

Clean up PR issues that @dahlbyk raised.

302f50e

Also added cached param to diff. That param should be there, right? I mean, I use git diff --cached quite a bit.

rkeithhill approved these changes Feb 4, 2017

View reviewed changes

rkeithhill added this to the v0.7 milestone Feb 4, 2017

rkeithhill added the Area-TabExpansion label Feb 4, 2017

closing braces are on a new line now

48a1062

rkeithhill mentioned this pull request Feb 4, 2017

Improve module description. #399

Merged

command lists are now precomputed

51a78d0

seamlessintegrations added 2 commits February 6, 2017 10:52

merged both versions

5083dcd

Merge branch 'rkeithhill-rkeithhill/fix-last-misc-pr-issues'

703f328

dahlbyk merged commit 1327b98 into dahlbyk:master Feb 6, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds support for tab-completion of all parameters, long and short #395

Adds support for tab-completion of all parameters, long and short #395

seamlessintegrations commented Feb 2, 2017 •

edited

Loading

rkeithhill left a comment

rkeithhill Feb 2, 2017

rkeithhill Feb 2, 2017

rkeithhill Feb 2, 2017

rkeithhill commented Feb 2, 2017

rkeithhill Feb 2, 2017

rkeithhill commented Feb 2, 2017 •

edited

Loading

seamlessintegrations commented Feb 2, 2017

rkeithhill commented Feb 3, 2017

rkeithhill commented Feb 3, 2017

rkeithhill Feb 3, 2017 •

edited

Loading

seamlessintegrations commented Feb 3, 2017 •

edited

Loading

dahlbyk left a comment

dahlbyk Feb 3, 2017

dahlbyk Feb 3, 2017

dahlbyk Feb 3, 2017

rkeithhill commented Feb 4, 2017

rkeithhill commented Feb 4, 2017 •

edited

Loading

seamlessintegrations commented Feb 6, 2017

rkeithhill commented Feb 6, 2017

dahlbyk commented Feb 6, 2017

Adds support for tab-completion of all parameters, long and short #395

Adds support for tab-completion of all parameters, long and short #395

Conversation

seamlessintegrations commented Feb 2, 2017 • edited Loading

rkeithhill left a comment

Choose a reason for hiding this comment

rkeithhill Feb 2, 2017

Choose a reason for hiding this comment

rkeithhill Feb 2, 2017

Choose a reason for hiding this comment

rkeithhill Feb 2, 2017

Choose a reason for hiding this comment

rkeithhill commented Feb 2, 2017

rkeithhill Feb 2, 2017

Choose a reason for hiding this comment

rkeithhill commented Feb 2, 2017 • edited Loading

seamlessintegrations commented Feb 2, 2017

rkeithhill commented Feb 3, 2017

rkeithhill commented Feb 3, 2017

rkeithhill Feb 3, 2017 • edited Loading

Choose a reason for hiding this comment

seamlessintegrations commented Feb 3, 2017 • edited Loading

dahlbyk left a comment

Choose a reason for hiding this comment

dahlbyk Feb 3, 2017

Choose a reason for hiding this comment

dahlbyk Feb 3, 2017

Choose a reason for hiding this comment

dahlbyk Feb 3, 2017

Choose a reason for hiding this comment

rkeithhill commented Feb 4, 2017

rkeithhill commented Feb 4, 2017 • edited Loading

seamlessintegrations commented Feb 6, 2017

rkeithhill commented Feb 6, 2017

dahlbyk commented Feb 6, 2017

seamlessintegrations commented Feb 2, 2017 •

edited

Loading

rkeithhill commented Feb 2, 2017 •

edited

Loading

rkeithhill Feb 3, 2017 •

edited

Loading

seamlessintegrations commented Feb 3, 2017 •

edited

Loading

rkeithhill commented Feb 4, 2017 •

edited

Loading