mirror of
https://github.com/tiennm99/styleguide.git
synced 2026-10-13 00:15:04 +00:00
vim: refresh from latest internal
This commit is contained in:
1 parent
70d1e9a510
commit
e77b44673d
2 files changed
+5
-13
No files matched your search
+3
-11
@@ -211,7 +211,7 @@ All other language features are fair game.
|
||||
name with the plugin (with a "vim-" prefix or ".vim" suffix if desired).
|
||||
|
||||
* Plugin metadata should be declared in the addon-info.json format (see the
|
||||
[VAM documentation](http://goo.gl/CUXJZC) for details).
|
||||
[VAM documentation](https://goo.gl/CUXJZC) for details).
|
||||
|
||||
* Functions should go in the `autoload/` subdirectory of your plugin.
|
||||
|
||||
@@ -300,7 +300,7 @@ Use [vimdoc](https://github.com/google/vimdoc).
|
||||
Provide help files generated by [vimdoc](https://github.com/google/vimdoc).
|
||||
Write documentation in .vim files in conformance with the vimdoc standards and
|
||||
include fields like "description" and "author" in the addon-info.json file (see
|
||||
the [VAM documentation](http://goo.gl/CUXJZC)).
|
||||
the [VAM documentation](https://goo.gl/CUXJZC)).
|
||||
|
||||
|
||||
### Whitespace
|
||||
@@ -525,14 +525,12 @@ Vim plugins should provide any or all of the following: **Commands**,
|
||||
### Commands
|
||||
|
||||
|
||||
|
||||
* Define in `plugin/commands.vim`.
|
||||
* CommandNamesLikeThis.
|
||||
* Prefer semantic names to a unified prefix.
|
||||
* Do not use `[!]`
|
||||
* Extract logic into functions.
|
||||
|
||||
|
||||
* `CommandNamesLikeThis`
|
||||
|
||||
* Commands should be defined in one block with no whitespace between them.
|
||||
@@ -582,14 +580,12 @@ Vim plugins should provide any or all of the following: **Commands**,
|
||||
### Autocommands
|
||||
|
||||
|
||||
|
||||
* Define in `plugin/autocmds.vim`.
|
||||
* Use augroups.
|
||||
* `augroup_names_like_this`.
|
||||
* Clear the augroup first.
|
||||
* Extract logic into functions.
|
||||
|
||||
|
||||
* All autocommands should be defined in the `plugin/autocmds.vim` file.
|
||||
|
||||
* This allows users to disable your autocommands with `Glaive myplugin
|
||||
@@ -618,14 +614,12 @@ Vim plugins should provide any or all of the following: **Commands**,
|
||||
### Functions
|
||||
|
||||
|
||||
|
||||
* FunctionNamesLikeThis.
|
||||
* Autoload all functions.
|
||||
* Prefix script-local functions with `s:`
|
||||
* Use `[!]`.
|
||||
* Use `[abort]`.
|
||||
|
||||
|
||||
* `FunctionNamesLikeThis`
|
||||
|
||||
* Prefix all script-local functions with `s:`
|
||||
@@ -670,12 +664,10 @@ Vim plugins should provide any or all of the following: **Commands**,
|
||||
### Mappings
|
||||
|
||||
|
||||
|
||||
* Provide opt-in key mappings in `plugin/mappings.vim`.
|
||||
* `<Plug>` mappings can be defined in `plugin/plugs.vim` (unlike mappings.vim,
|
||||
plugs.vim is opt-out).
|
||||
|
||||
|
||||
* Define key mappings in `plugin/mappings.vim`, using
|
||||
`maktaba#plugin#MapPrefix` to get a prefix.
|
||||
|
||||
@@ -729,7 +721,7 @@ Declare dependencies in addon-info.json and use `maktaba`.
|
||||
|
||||
Declaring dependencies in addon-info.json allows conformant plugin managers
|
||||
(like VAM) to ensure dependencies are installed. See the
|
||||
[VAM documentation](http://goo.gl/CUXJZC) for details.
|
||||
[VAM documentation](https://goo.gl/CUXJZC) for details.
|
||||
|
||||
Calling `maktaba#library#Require` from dependent code at runtime ensures that
|
||||
dependencies have been installed and that they don't include unsafe non-library
|
||||
|
||||
Reference in new issue
Block a user