private/Get-VimOption.ps1
|
<# .SYNOPSIS Convert Vim OPTIONS into PSCustomObject with CompletionText and ToolTip properties. ExcludeArgument property lists incompatible OPTIONS. .DESCRIPTION Convert Vim OPTIONS into PSCustomObject with CompletionText and ToolTip properties. ExcludeArgument property lists incompatible OPTIONS separated with the Regex 'or', '|', operator. CompletionText and ToolTip are required. .EXAMPLE None .INPUTS None .OUTPUTS An arrary of [PSCustomObject]@{ CompletionText = "Vim OPTION" ToolTip = "Vim OPTION with help" ExcludeArgument = '-v|-E|-d|-y' } .NOTES function Get-VimOption { if (Get-Command -Name vim -ErrorAction SilentlyContinue) { $VimArguments = & vim --help | Select-String -Pattern '^\s*[-+]' } else { return '' } $VimArguments | ForEach-Object -Process { $ToolTip = $_.ToString() $CompletionText = ($ToolTip -Split '\t+', 0, "RegexMatch") $Length = [int] $CompletionText.Length if ($Length -eq 2) { $CompletionText = $CompletionText[0].Trim() } else { $CompletionText = $CompletionText.Trim().Split()[0] } $CompletionText = ($CompletionText -Split '[[<( ]')[0] $ToolTip = $ToolTip.Trim() [PSCustomObject]@{ Argument = "$CompletionText" ToolTip = "$ToolTip" } } } #> function Get-VimOption { [CmdletBinding()] [OutputType([System.Management.Automation.PSObject[]])] param() $Argument = @( [PSCustomObject]@{ CompletionText = '-' ToolTip = "-`tRead text from stdin" } [PSCustomObject]@{ CompletionText = '--' ToolTip = "--`tOnly file names after this" } ) $Argument += @( [PSCustomObject]@{ CompletionText = '-m' ToolTip = "-m`tModifications (writing files) not allowed" } [PSCustomObject]@{ CompletionText = '-M' ToolTip = "-M`tModifications in text not allowed" } [PSCustomObject]@{ CompletionText = '-b' ToolTip = "-b`tBinary mode" } [PSCustomObject]@{ CompletionText = '-l' ToolTip = "-l`tLisp mode" } $ToolTip = @( "-V[N][fname]`tBe verbose [level N] (default: 10)", "[log messages to fname]`n", "When bigger than zero, Vim will give messages about what it is doing." ) -join ' ' [PSCustomObject]@{ CompletionText = '-V' ToolTip = $ToolTip } [PSCustomObject]@{ CompletionText = '-D' ToolTip = "-D`tDebugging mode" } [PSCustomObject]@{ CompletionText = '-n' ToolTip = "-n`tNo swap file, use memory only" } [PSCustomObject]@{ CompletionText = '-r' ToolTip = "-r [swap file]`tList swap files and exit or recover from a swap file." } [PSCustomObject]@{ CompletionText = '-L' ToolTip = "-L [swap file]`tList swap files and exit or recover from a swap file." } [PSCustomObject]@{ CompletionText = '-A' ToolTip = 'Start in Arabic mode' ExcludeArgument = '-H|-F' } [PSCustomObject]@{ CompletionText = '-H' ToolTip = 'Start in Hebrew mode' ExcludeArgument = '-A|-F' } [PSCustomObject]@{ CompletionText = '-F' ToolTip = 'Start in Farsi mode' ExcludeArgument = '-A|-H' } [PSCustomObject]@{ CompletionText = '-u' ToolTip = "-u <vimrc>`tUse <vimrc> instead of any .vimrc" } [PSCustomObject]@{ CompletionText = '--noplugin' ToolTip = "--noplugin`tDon't load plugin scripts" } [PSCustomObject]@{ CompletionText = '-o' ToolTip = "-o[N]`tOpen N windows (default: one for each file)" } [PSCustomObject]@{ CompletionText = '-O' ToolTip = "-O[N]`tOpen N windows split vertically (default: one for each file)" } [PSCustomObject]@{ CompletionText = '-p' ToolTip = "-p[N]`tOpen N tab pages (default: one for each file)" } [PSCustomObject]@{ CompletionText = '-q' ToolTip = "-q [errorfile]`tEdit file with first error quickfix file]" } [PSCustomObject]@{ CompletionText = '--cmd' ToolTip = "--cmd <command>`tExecute <command> before loading any vimrc file" } [PSCustomObject]@{ CompletionText = '-c' ToolTip = "-c <command>`tExecute <command> after loading the first file" } [PSCustomObject]@{ CompletionText = '-S' ToolTip = "-S <session>`tSource file <session> after loading the first file" } [PSCustomObject]@{ CompletionText = '-s' ToolTip = "-s <scriptin>`tRead Normal mode commands from file <scriptin>" } [PSCustomObject]@{ CompletionText = '-w' ToolTip = "-w <scriptout>`tAppend all typed commands to file <scriptout>" } [PSCustomObject]@{ CompletionText = '-W' ToolTip = "-W <scriptout>`tWrite all typed commands to file <scriptout>" } [PSCustomObject]@{ CompletionText = '--startuptime' ToolTip = "--startuptime <file>`tWrite startup timing messages to <file>" } [PSCustomObject]@{ CompletionText = '--help' ToolTip = "-h or --help`tPrint Help and exit" } [PSCustomObject]@{ CompletionText = '-h' ToolTip = "-h or --help`tPrint Help and exit" } [PSCustomObject]@{ CompletionText = '--version' ToolTip = "--version`tPrint version information and exit" } [PSCustomObject]@{ CompletionText = '-t' ToolTip = "-t tag`tEdit file where tag is defined" } ) $Argument += @( [PSCustomObject]@{ CompletionText = '-e' ToolTip = "-e`tEx mode (like ""ex"")" ExcludeArgument = '-v|-E|-d|-y' } [PSCustomObject]@{ CompletionText = '-E' ToolTip = "-E`tImproved Ex mode" ExcludeArgument = '-v|-e|-d|-y' } [PSCustomObject]@{ CompletionText = '-v' ToolTip = "-v`tVi mode (like ""vi"")" ExcludeArgument = '-e|-E|-s|-d|-y' } [PSCustomObject]@{ CompletionText = '-y' ToolTip = "-y`tEasy mode (like ""evim"", modeless)" ExcludeArgument = '-v|-e|-E|-s|-d' } [PSCustomObject]@{ CompletionText = '-C' ToolTip = "-C`tCompatible with Vi: 'compatible'" } [PSCustomObject]@{ CompletionText = '-N' ToolTip = "-N`tNot fully Vi compatible: 'nocompatible'" } # Not implemented # [PSCustomObject]@{ # CompletionText = '-T' # ToolTip = "-T <terminal>`tSet terminal type to <terminal>" # } [PSCustomObject]@{ CompletionText = '--not-a-term' ToolTip = "--not-a-term`tSkip warning for input/output not being a terminal" } [PSCustomObject]@{ CompletionText = '--ttyfail' ToolTip = "--ttyfail`tExit if input or output is not a terminal" } # Not implemented on Windows # [PSCustomObject]@{ # CompletionText = '-X' # ToolTip = 'Do not connect to X server' # } [PSCustomObject]@{ CompletionText = '-x' ToolTip = "-x`tEdit encrypted files" } ) # gvim GUI parameters $Argument += @( # Not supported on Windows. Use gvim # [PSCustomObject]@{ # CompletionText = '-g' # ToolTip = "-g`tRun using GUI (like ""gvim"")" # } [PSCustomObject]@{ CompletionText = '-f' ToolTip = "-f`tForeground: Don't fork when starting GUI" } [PSCustomObject]@{ CompletionText = '--nofork' ToolTip = "--nofork`tForeground: Don't fork when starting GUI" } [PSCustomObject]@{ CompletionText = '-U' ToolTip = "-U <gvimrc>`tUse <gvimrc> instead of any .gvimrc" } # Windows specific GUI options if ($IsWindows) { [PSCustomObject]@{ CompletionText = '-P' ToolTip = "-P <parent title>`tOpen Vim inside parent application" } [PSCustomObject]@{ CompletionText = '--windowid' ToolTip = "--windowid <HWND> Open Vim inside another win32 widget" } } ) $Remote = 'Edit <files> in a Vim server if possible' $Silent = 'don''t complain if there is no server' $Wait = 'wait for files to have been edited' $Tab = 'but open tab page for each file' $Argument += @( [PSCustomObject]@{ CompletionText = '--remote' ToolTip = "--remote <files>`t$Remote" } [PSCustomObject]@{ CompletionText = '--remote-silent' ToolTip = "--remote-silent <files>`t$Remote and $Silent" } [PSCustomObject]@{ CompletionText = '--remote-wait' ToolTip = "--remote-wait <files>`t$Remote and $Wait" } [PSCustomObject]@{ CompletionText = '--remote-wait-silent' ToolTip = "--remote-wait-silent <files>`t$Remote, $Wait and $Silent" } [PSCustomObject]@{ CompletionText = '--remote-tab' ToolTip = "--remote-tab`t$Remote, $Tab" } [PSCustomObject]@{ CompletionText = '--remote-tab-silent' ToolTip = "--remote-tab-silent`t$Remote, $Tab, and $Silent" } [PSCustomObject]@{ CompletionText = '--remote-tab-wait' ToolTip = "--remote-tab-wait`t$Remote, $Tab, and $Wait" } [PSCustomObject]@{ CompletionText = '--remote-tab-wait-silent' ToolTip = "--remote-tab-wait-silent`t$Remote, $Tab, and $Wait, and $Silent" } ) $Argument += @( [PSCustomObject]@{ CompletionText = '--remote-send' ToolTip = "--remote-send <keys>`tSend <keys> to a Vim server and exit" } [PSCustomObject]@{ CompletionText = '--remote-expr' ToolTip = "--remote-expr <expr>`tEvaluate <expr> in a Vim server and print result" } [PSCustomObject]@{ CompletionText = '--literal' ToolTip = "--literal`tDon't expand wildcards" } [PSCustomObject]@{ CompletionText = '--serverlist' ToolTip = "--serverlist`tList available Vim server names and exit" } [PSCustomObject]@{ CompletionText = '--servername' ToolTip = "--servername <name>`tSend to/become the Vim server <name>. Tab to expand running server names" } [PSCustomObject]@{ CompletionText = '-i' ToolTip = "-i <viminfo>`tUse <viminfo> instead of .viminfo" } [PSCustomObject]@{ CompletionText = '--clean' ToolTip = "--clean`t'nocompatible', Vim defaults, no plugins, no viminfo" } ) $Argument += @( [PSCustomObject]@{ CompletionText = '+' ToolTip = "+<lnum>`tStart at line <lnum>" } [PSCustomObject]@{ CompletionText = '+ ' ToolTip = "+`tStart at end of file" } ) return $Argument } |