jfishe/vimtabcompletion

Vim Argument Completer for PowerShell

VimTabCompletion

Powershell Tab Completion for Vim

Author: [email protected]

VimTabCompletion was tested against Windows PowerShell 5.1 and PowerShell Core 7.0.3 on Windows. Refer to about_VimTabCompletion for features and limitations.

Installation

Vim

VimTabCompletion requires Vim in $env:PATH or $Env:VIMRUNTIME and recommends vim / vim-win32-installer.

To install with Chocolatey:

choco install vim

Ctags

VimTabCompletion requires readtags for tag completion and recommends universal-ctags / ctags.

To install with Chocolatey:

choco install universal-ctags

Git

VimTabCompletion requires git to locate the project root for use by ctags.

To install with Chocolatey:

choco install git

VimTabCompletion Module

VimTabCompletion exports PowerShell function TabExpansion but does not interfere with existing TabExpansion functions.

To install from PowerShell Gallery:

Find-Module -Name VimTabCompletion

# Version              Name                                Repository
# -------              ----                                ----------
# 1.2.0                VimTabCompletion                    PSGallery

# Use AllowClobber to update TabExpansion
Install-Module -Name VimTabCompletion -AllowClobber

# WARNING: The externally managed, dependent module 'vim' is not installed on
# this computer. To use the current module 'VimTabCompletion', ensure that its
# dependent module 'vim' is installed.
# WARNING: The externally managed, dependent module 'ctags' is not installed on
# this computer. To use the current module 'VimTabCompletion', ensure that its
# dependent module 'ctags' is installed.

Add Import-Module VimTabCompletion to $Env:PROFILE, because PowerShell does not activate completion until a module member is called in a session. Native commands like Vim are not module members.

Building

.\build.ps1

Publish to LocalRepo1

deploy.PSDeploy.ps1 uses a PSRepository defined by Set-PSRepository, e.g., LocalRepo1. To publish to a different location than PSGallery, change to the project root directory:

$Env:PublishToRepo = 'LocalRepo1' # Default: 'PSGallery'

# Not required if you ran .\build.ps1 in the current shell
$Env:PSModulePath = "$(pwd)\_build_dependencies_\;$env:PSModulePath"

Set-BuildEnvironment -Force

# Default: 'Unknown' when building locally. Reset by build.ps1.
$Env:BHBuildSystem = 'LocalRepo1'

# Override
.\build.ps1 -Task Distribute

Testing

VimTabCompletion requires Vim and readtags.

.\build.ps1 -Task Test

Change Log

git-chglog / git-chglog generates CHANGELOG.md. The template is in .chglog/CHANGELOG.tpl.md.

git-chglog -o CHANGELOG.md # To regenerate the change log
git-chglog 1.0.0..2.0.0 # To update with range of tags

License

• MIT License: LICENSE
• RamblingCookieMonster / BuildHelpers created Invoke-Git under the MIT License: ThirdPartyNotice

vimtabcompletion's Issues

-u[use given vimrc file instead of default .vimrc]:config:->config

Completion not working for new powershell sessions

Updated README and about_VimTabCompletion with a work around to either call a module member or import the module.

vim -V10C:\ incorrect completion

• vim -V10C:\ completes vim -V10C:'C:\$Recycle.Bin\'
• vim -V10'C:\' completes vim -V10-V10'C:\data\'
• tabexpansion2 -inputScript 'vim -V10C:\' -cursorColumn 11 | Select-Object -ExpandProperty CompletionMatches does not pre-pend -V10. PS uses C: as a word separator.