Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thinca/hubot-vimhelp
A hubot script that shows Vim's help.
https://github.com/thinca/hubot-vimhelp
help hubot hubot-scripts vim
Last synced: 23 days ago
JSON representation
A hubot script that shows Vim's help.
- Host: GitHub
- URL: https://github.com/thinca/hubot-vimhelp
- Owner: thinca
- License: zlib
- Created: 2016-06-18T11:12:46.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-07-17T14:06:44.000Z (over 1 year ago)
- Last Synced: 2025-01-03T05:28:49.699Z (about 1 month ago)
- Topics: help, hubot, hubot-scripts, vim
- Language: TypeScript
- Homepage:
- Size: 256 KB
- Stars: 10
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# hubot-vimhelp
[![NPM Version][npm-image]][npm-url]
[![Node.js Version][node-version-image]][node-version-url]
[![Test][test-ci-badge]][test-ci-action]
[![Lint][lint-ci-badge]][lint-ci-action]
[![Test Coverage][codecov-image]][codecov-url]
A hubot script that shows Vim's help.
See [`scripts/vimhelp.js`](scripts/vimhelp.js) for full documentation.
## Requirements
- Node.js v16.0.0+
- [vimhelp](https://github.com/thinca/node-vimhelp)
- Vim
- Git (Optional)
## Installation
In hubot project repo, run:
`npm install hubot-vimhelp --save`
Then add **hubot-vimhelp** to your `external-scripts.json`:
```json
[
"hubot-vimhelp"
]
```
## Sample Interaction
```
user1>> :help j
hubot>>
j or *j*
or **
CTRL-J or *CTRL-J*
or ** *CTRL-N*
CTRL-N [count] lines downward |linewise|.
```
Also reacts for reply.
```
user1>> @hubot :help j
hubot>>
@user1
j or *j*
or **
CTRL-J or *CTRL-J*
or ** *CTRL-N*
CTRL-N [count] lines downward |linewise|.
```
## Commands
### :help
Show the help of Vim.
`:h` which is a shortcut version is available.
### :vimhelp
This is a command for administrator.
Some sub commands exist.
#### :vimhelp help
Show the simple help of `:vimhelp`.
#### :vimhelp plugin
This command manages the Vim plugins.
User can show the help of Vim plugin after you installed a Vim plugin.
User can specify the {plugin-name} by the one of following formats:
- A repository name of [vim-scripts](https://github.com/vim-scripts)
- A GitHub repository in `owner/repos` style
- A URL of Git repository
##### :vimhelp plugin install/add {plugin-name}...
Install Vim plugins. You can specify one or more plugin names.
##### :vimhelp plugin uninstall/rm/remove/delete {plugin-name}...
Uninstall Vim plugins. You can specify one or more plugin names.
##### :vimhelp plugin update [{plugin-name}...]
Update installed Vim plugins. You can specify one or more plugin names.
All Vim plugins are updated when `{plugin-name}` is not specified.
##### :vimhelp plugin list
Show the list of installed Vim plugins.
## License
[zlib License](LICENSE.txt)
## Author
thinca
[npm-image]: https://img.shields.io/npm/v/hubot-vimhelp.svg
[npm-url]: https://npmjs.org/package/hubot-vimhelp
[node-version-image]: https://img.shields.io/node/v/hubot-vimhelp.svg
[node-version-url]: https://nodejs.org/en/download/
[test-ci-badge]: ./../../workflows/Test/badge.svg
[test-ci-action]: ./../../actions?query=workflow%3ATest
[lint-ci-badge]: ./../../workflows/Lint/badge.svg
[lint-ci-action]: ./../../actions?query=workflow%3ALint
[codecov-image]: https://codecov.io/gh/thinca/hubot-vimhelp/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/thinca/hubot-vimhelp