✨PSCompletions(psc) ✨

English | 简体中文 | Github | Gitee

介绍

• PowerShell: 跨平台的 PowerShell。命令行中运行 pwsh 启动

• Windows PowerShell: Windows 系统内置的 PowerShell。命令行中运行 powershell 启动

• 一个 PowerShell 补全管理模块，更好、更简单、更方便的使用和管理补全

  Windows PowerShell 也可以使用此模块，但不建议

• 集中管理补全
• zh-CN，en-US 多语言切换
• 动态排序补全候选(根据使用频次)

• 补全信息可自定义(但不建议)
  • 通过修改补全json文件实现
  • psc which <completion> 获取补全文件路径
  • 建议只修改补全提示信息，避免出现不小心的修改导致整个补全失败
  • 如果出现补全问题,请使用 psc update <completion> 更新覆盖

如果 PSCompletions 对你有所帮助，请在右上角点个 Star ⭐

安装

1. 打开 PowerShell
   • 如果使用 Windows PowerShell，需要以管理员权限启动
2. Install-Module PSCompletions
3. Import-Module PSCompletions
   • 如果不想每次启动 PowerShell 都导入一次，就执行 echo "Import-Module PSCompletions" >> $PROFILE

卸载

1. 打开 PowerShell
   • 如果使用 Windows PowerShell，需要以管理员权限启动
2. Uninstall-Module PSCompletions

使用(以 git 补全为例)

可用补全列表

• 如果补全列表里没有你想要的补全，你可以提交 issues, 我会逐步添加

1. psc add git
2. 然后你就可以输入git ,按下 Space(空格键) Tab 来获得命令补全
3. 关于psc的更多命令，你可以通过输入psc然后按下 Space(空格键) Tab来了解

Demo

Tips

关于补全更新

• 当打开PowerShell 并导入 PSCompletions 后，PSCompletions 会开启一个后台作业去检查远程仓库中补全的状态
• 获取到更新后，会在下一次显示补全更新提示

关于补全菜单 UI

• 模块的补全菜单 UI 基于 PS-GuiCompletion 修改而来
• 模块自 3.0.0 版本起，默认使用本模块自带的补全菜单 UI

  由于 UI 在 Windows PowerShell 上不稳定，Windows PowerShell 将继续使用语言自带的补全菜单

  • 如果你喜欢语言自带的补全菜单，运行 psc ui menu powershell 即可
• 你可以通过 psc ui 下的命令来更改补全菜单 UI 的一些样式及配置

关于补全描述中的特殊符号

• 对于 😄😎🤔: 如果出现多个，可以选择其中一个的效果

• 😄：表示选用此补全后，可以按下 Space(空格键) 和 Tab 键继续获得补全候选

  • 可通过 psc config symbol SpaceTab <symbol> 自定义此符号
  • 如: psc config symbol SpaceTab 😄

• 😎: 表示选用此补全后，你可以输入一个不带空格的字符串，然后按下 Space(空格键) 和 Tab 键继续获得补全候选

  • 可通过 psc config symbol WriteSpaceTab <symbol> 自定义此符号

• 🤔: 表示选用此补全后，你可以按下 Space(空格键) 和 Tab 键继续获取选项类补全候选(如 --verbose)

  • 可通过 psc config symbol OptionsTab <symbol> 自定义此符号

• ...: 补全描述等待后续填充

  • 如果 ... 是最后一个补全候选，则表示可显示区域过小，无法显示所有候选项

关于路径补全

• 输入 ./ 或 .\ 后按下 Tab 以获取 子目录 或 文件 的路径补全
• 输入 / 或 \ 后按下 Tab 以获取 同级目录 的路径补全

补全列表