Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jfishe/vimtabcompletion
Vim Argument Completer for PowerShell
https://github.com/jfishe/vimtabcompletion
argumentcompleter powershell powershell-core powershell-module tabcompletion vim windows-powershell
Last synced: 22 days ago
JSON representation
Vim Argument Completer for PowerShell
- Host: GitHub
- URL: https://github.com/jfishe/vimtabcompletion
- Owner: jfishe
- License: mit
- Created: 2020-07-24T19:41:33.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-09-23T16:40:40.000Z (over 4 years ago)
- Last Synced: 2024-11-15T11:08:05.252Z (3 months ago)
- Topics: argumentcompleter, powershell, powershell-core, powershell-module, tabcompletion, vim, windows-powershell
- Language: PowerShell
- Homepage:
- Size: 153 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# VimTabCompletion
Powershell Tab Completion for Vim
Author: [email protected]
[](https://ci.appveyor.com/project/jfishe/vimtabcompletion)
VimTabCompletion was tested against Windows PowerShell 5.1 and PowerShell Core
7.0.3 on Windows. Refer to
[about_VimTabCompletion](VimTabCompletion/en-US/about_VimTabCompletion) for
features and limitations.
## Installation
### Vim
VimTabCompletion requires Vim in `$env:PATH` or `$Env:VIMRUNTIME` and recommends
[vim / vim-win32-installer](https://github.com/vim/vim-win32-installer).
To install with Chocolatey:
```PowerShell
choco install vim
```
### Ctags
VimTabCompletion requires `readtags` for tag completion and recommends
[universal-ctags / ctags](https://github.com/universal-ctags/ctags).
To install with [Chocolatey](https://chocolatey.org/):
```PowerShell
choco install universal-ctags
```
### Git
VimTabCompletion requires [`git`](https://git-scm.com/) to locate the project
root for use by [ctags](#ctags).
To install with [Chocolatey](https://chocolatey.org/):
```PowerShell
choco install git
```
### VimTabCompletion Module
VimTabCompletion exports PowerShell function TabExpansion but does not
interfere with existing TabExpansion functions.
To install from [PowerShell Gallery](https://go.microsoft.com/fwlink/?linkid=2118474):
```PowerShell
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:
``` powershell
$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](https://github.com/git-chglog/git-chglog) generates
[CHANGELOG.md](CHANGELOG.md). The template is in
[.chglog/CHANGELOG.tpl.md](.chglog/CHANGELOG.tpl.md).
```bash
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](LICENSE)
- [RamblingCookieMonster / BuildHelpers](https://github.com/RamblingCookieMonster/BuildHelpers)
created `Invoke-Git` under the MIT License:
[ThirdPartyNotice](ThirdPartyNotice.md#invoke-git)