diff --git a/autoload/SpaceVim/layers/git.vim b/autoload/SpaceVim/layers/git.vim index 44dc03629..86ed77872 100644 --- a/autoload/SpaceVim/layers/git.vim +++ b/autoload/SpaceVim/layers/git.vim @@ -7,10 +7,28 @@ "============================================================================= -" Layer Options: -" s:git_plugin which plugin is used as the background plugin in git layer +"" +" @section git, layer-git +" @parentsection layers +" `git` layer provides git integration for SpaceVim. +" +" @subsection Layer options +" +" `git_plugin`: Set the background plugin used in `git` layer. The default +" value is `git`, the following plugins are supported: `gina`, `fugitive` and +" `gita`. +" > +" [[layers]] +" name = 'git' +" git_plugin = 'git' +" < +" +if exists('s:git_plugin') + finish +endif + let s:git_plugin = 'git' @@ -116,8 +134,10 @@ endfunction function! SpaceVim#layers#git#set_variable(var) abort let s:git_plugin = get(a:var, + \ 'git_plugin', + \ get(a:var, \ 'git-plugin', - \ s:git_plugin) + \ s:git_plugin)) endfunction diff --git a/doc/SpaceVim.txt b/doc/SpaceVim.txt index fbbc439ae..365ab3f2d 100644 --- a/doc/SpaceVim.txt +++ b/doc/SpaceVim.txt @@ -89,88 +89,89 @@ CONTENTS *SpaceVim-contents* 5. core#tabline............................|SpaceVim-layer-core-tabline| 6. exprfold....................................|SpaceVim-layer-exprfold| 7. format........................................|SpaceVim-layer-format| - 8. github........................................|SpaceVim-layer-github| - 9. incsearch..................................|SpaceVim-layer-incsearch| - 10. indentmove...............................|SpaceVim-layer-indentmove| - 11. lang#actionscript.................|SpaceVim-layer-lang-actionscript| - 12. lang#agda.................................|SpaceVim-layer-lang-agda| - 13. lang#asciidoc.........................|SpaceVim-layer-lang-asciidoc| - 14. lang#asepctj...........................|SpaceVim-layer-lang-asepctj| - 15. lang#batch...............................|SpaceVim-layer-lang-batch| - 16. lang#c.......................................|SpaceVim-layer-lang-c| - 17. lang#chapel.............................|SpaceVim-layer-lang-chapel| - 18. lang#clojure...........................|SpaceVim-layer-lang-clojure| - 19. lang#coffeescript.................|SpaceVim-layer-lang-coffeescript| - 20. lang#crystal...........................|SpaceVim-layer-lang-crystal| - 21. lang#csharp.............................|SpaceVim-layer-lang-csharp| - 22. lang#d.......................................|SpaceVim-layer-lang-d| - 23. lang#dart.................................|SpaceVim-layer-lang-dart| - 24. lang#dockerfile.....................|SpaceVim-layer-lang-dockerfile| - 25. lang#eiffel.............................|SpaceVim-layer-lang-eiffel| - 26. lang#elixir.............................|SpaceVim-layer-lang-elixir| - 27. lang#elm...................................|SpaceVim-layer-lang-elm| - 28. lang#erlang.............................|SpaceVim-layer-lang-erlang| - 29. lang#extra...............................|SpaceVim-layer-lang-extra| - 30. lang#foxpro.............................|SpaceVim-layer-lang-foxpro| - 31. lang#fsharp.............................|SpaceVim-layer-lang-fsharp| - 32. lang#go.....................................|SpaceVim-layer-lang-go| - 33. lang#goby.................................|SpaceVim-layer-lang-goby| - 34. lang#gosu.................................|SpaceVim-layer-lang-gosu| - 35. lang#graphql...........................|SpaceVim-layer-lang-graphql| - 36. lang#groovy.............................|SpaceVim-layer-lang-groovy| - 37. lang#hack.................................|SpaceVim-layer-lang-hack| - 38. lang#haskell...........................|SpaceVim-layer-lang-haskell| - 39. lang#html.................................|SpaceVim-layer-lang-html| - 40. lang#hy.....................................|SpaceVim-layer-lang-hy| - 41. lang#idris...............................|SpaceVim-layer-lang-idris| - 42. lang#j.......................................|SpaceVim-layer-lang-j| - 43. lang#janet...............................|SpaceVim-layer-lang-janet| - 44. lang#java.................................|SpaceVim-layer-lang-java| - 45. lang#javascript.....................|SpaceVim-layer-lang-javascript| - 46. lang#json.................................|SpaceVim-layer-lang-json| - 47. lang#julia...............................|SpaceVim-layer-lang-julia| - 48. lang#kotlin.............................|SpaceVim-layer-lang-kotlin| - 49. lang#lisp.................................|SpaceVim-layer-lang-lisp| - 50. lang#livescript.....................|SpaceVim-layer-lang-livescript| - 51. lang#lua...................................|SpaceVim-layer-lang-lua| - 52. lang#moonscript.....................|SpaceVim-layer-lang-moonscript| - 53. lang#nim...................................|SpaceVim-layer-lang-nim| - 54. lang#nix...................................|SpaceVim-layer-lang-nix| - 55. lang#ocaml...............................|SpaceVim-layer-lang-ocaml| - 56. lang#pact.................................|SpaceVim-layer-lang-pact| - 57. lang#php...................................|SpaceVim-layer-lang-php| - 58. lang#pony.................................|SpaceVim-layer-lang-pony| - 59. lang#processing.....................|SpaceVim-layer-lang-processing| - 60. lang#prolog.............................|SpaceVim-layer-lang-prolog| - 61. lang#puppet.............................|SpaceVim-layer-lang-puppet| - 62. lang#python.............................|SpaceVim-layer-lang-python| - 63. lang#racket.............................|SpaceVim-layer-lang-racket| - 64. lang#racket................................|SpaceVim-layer-lang-red| - 65. lang#ring....................................|SpaceVim-layer-lang-r| - 66. lang#ring.................................|SpaceVim-layer-lang-ring| - 67. lang#ruby.................................|SpaceVim-layer-lang-ruby| - 68. lang#rust.................................|SpaceVim-layer-lang-rust| - 69. lang#scala...............................|SpaceVim-layer-lang-scala| - 70. lang#scheme.............................|SpaceVim-layer-lang-scheme| - 71. lang#sh.....................................|SpaceVim-layer-lang-sh| - 72. lang#sml...................................|SpaceVim-layer-lang-sml| - 73. lang#swig................................|SpaceVim-layer-lang-swift| - 74. lang#swig.................................|SpaceVim-layer-lang-swig| - 75. lang#tcl...................................|SpaceVim-layer-lang-tcl| - 76. lang#toml.................................|SpaceVim-layer-lang-toml| - 77. lang#typescript.....................|SpaceVim-layer-lang-typescript| - 78. lang#v.......................................|SpaceVim-layer-lang-v| - 79. lang#vbnet...............................|SpaceVim-layer-lang-vbnet| - 80. lang#xml...................................|SpaceVim-layer-lang-xml| - 81. lang#xquery.............................|SpaceVim-layer-lang-xquery| - 82. language server protocol........................|SpaceVim-layer-lsp| - 83. leaderf.....................................|SpaceVim-layer-leaderf| - 84. operator...................................|SpaceVim-layer-operator| - 85. shell.........................................|SpaceVim-layer-shell| - 86. test...........................................|SpaceVim-layer-test| - 87. tmux...........................................|SpaceVim-layer-tmux| - 88. tools#dash...............................|SpaceVim-layer-tools-dash| - 89. tools#zeal...............................|SpaceVim-layer-tools-zeal| + 8. git..............................................|SpaceVim-layer-git| + 9. github........................................|SpaceVim-layer-github| + 10. incsearch.................................|SpaceVim-layer-incsearch| + 11. indentmove...............................|SpaceVim-layer-indentmove| + 12. lang#actionscript.................|SpaceVim-layer-lang-actionscript| + 13. lang#agda.................................|SpaceVim-layer-lang-agda| + 14. lang#asciidoc.........................|SpaceVim-layer-lang-asciidoc| + 15. lang#asepctj...........................|SpaceVim-layer-lang-asepctj| + 16. lang#batch...............................|SpaceVim-layer-lang-batch| + 17. lang#c.......................................|SpaceVim-layer-lang-c| + 18. lang#chapel.............................|SpaceVim-layer-lang-chapel| + 19. lang#clojure...........................|SpaceVim-layer-lang-clojure| + 20. lang#coffeescript.................|SpaceVim-layer-lang-coffeescript| + 21. lang#crystal...........................|SpaceVim-layer-lang-crystal| + 22. lang#csharp.............................|SpaceVim-layer-lang-csharp| + 23. lang#d.......................................|SpaceVim-layer-lang-d| + 24. lang#dart.................................|SpaceVim-layer-lang-dart| + 25. lang#dockerfile.....................|SpaceVim-layer-lang-dockerfile| + 26. lang#eiffel.............................|SpaceVim-layer-lang-eiffel| + 27. lang#elixir.............................|SpaceVim-layer-lang-elixir| + 28. lang#elm...................................|SpaceVim-layer-lang-elm| + 29. lang#erlang.............................|SpaceVim-layer-lang-erlang| + 30. lang#extra...............................|SpaceVim-layer-lang-extra| + 31. lang#foxpro.............................|SpaceVim-layer-lang-foxpro| + 32. lang#fsharp.............................|SpaceVim-layer-lang-fsharp| + 33. lang#go.....................................|SpaceVim-layer-lang-go| + 34. lang#goby.................................|SpaceVim-layer-lang-goby| + 35. lang#gosu.................................|SpaceVim-layer-lang-gosu| + 36. lang#graphql...........................|SpaceVim-layer-lang-graphql| + 37. lang#groovy.............................|SpaceVim-layer-lang-groovy| + 38. lang#hack.................................|SpaceVim-layer-lang-hack| + 39. lang#haskell...........................|SpaceVim-layer-lang-haskell| + 40. lang#html.................................|SpaceVim-layer-lang-html| + 41. lang#hy.....................................|SpaceVim-layer-lang-hy| + 42. lang#idris...............................|SpaceVim-layer-lang-idris| + 43. lang#j.......................................|SpaceVim-layer-lang-j| + 44. lang#janet...............................|SpaceVim-layer-lang-janet| + 45. lang#java.................................|SpaceVim-layer-lang-java| + 46. lang#javascript.....................|SpaceVim-layer-lang-javascript| + 47. lang#json.................................|SpaceVim-layer-lang-json| + 48. lang#julia...............................|SpaceVim-layer-lang-julia| + 49. lang#kotlin.............................|SpaceVim-layer-lang-kotlin| + 50. lang#lisp.................................|SpaceVim-layer-lang-lisp| + 51. lang#livescript.....................|SpaceVim-layer-lang-livescript| + 52. lang#lua...................................|SpaceVim-layer-lang-lua| + 53. lang#moonscript.....................|SpaceVim-layer-lang-moonscript| + 54. lang#nim...................................|SpaceVim-layer-lang-nim| + 55. lang#nix...................................|SpaceVim-layer-lang-nix| + 56. lang#ocaml...............................|SpaceVim-layer-lang-ocaml| + 57. lang#pact.................................|SpaceVim-layer-lang-pact| + 58. lang#php...................................|SpaceVim-layer-lang-php| + 59. lang#pony.................................|SpaceVim-layer-lang-pony| + 60. lang#processing.....................|SpaceVim-layer-lang-processing| + 61. lang#prolog.............................|SpaceVim-layer-lang-prolog| + 62. lang#puppet.............................|SpaceVim-layer-lang-puppet| + 63. lang#python.............................|SpaceVim-layer-lang-python| + 64. lang#racket.............................|SpaceVim-layer-lang-racket| + 65. lang#racket................................|SpaceVim-layer-lang-red| + 66. lang#ring....................................|SpaceVim-layer-lang-r| + 67. lang#ring.................................|SpaceVim-layer-lang-ring| + 68. lang#ruby.................................|SpaceVim-layer-lang-ruby| + 69. lang#rust.................................|SpaceVim-layer-lang-rust| + 70. lang#scala...............................|SpaceVim-layer-lang-scala| + 71. lang#scheme.............................|SpaceVim-layer-lang-scheme| + 72. lang#sh.....................................|SpaceVim-layer-lang-sh| + 73. lang#sml...................................|SpaceVim-layer-lang-sml| + 74. lang#swig................................|SpaceVim-layer-lang-swift| + 75. lang#swig.................................|SpaceVim-layer-lang-swig| + 76. lang#tcl...................................|SpaceVim-layer-lang-tcl| + 77. lang#toml.................................|SpaceVim-layer-lang-toml| + 78. lang#typescript.....................|SpaceVim-layer-lang-typescript| + 79. lang#v.......................................|SpaceVim-layer-lang-v| + 80. lang#vbnet...............................|SpaceVim-layer-lang-vbnet| + 81. lang#xml...................................|SpaceVim-layer-lang-xml| + 82. lang#xquery.............................|SpaceVim-layer-lang-xquery| + 83. language server protocol........................|SpaceVim-layer-lsp| + 84. leaderf.....................................|SpaceVim-layer-leaderf| + 85. operator...................................|SpaceVim-layer-operator| + 86. shell.........................................|SpaceVim-layer-shell| + 87. test...........................................|SpaceVim-layer-test| + 88. tmux...........................................|SpaceVim-layer-tmux| + 89. tools#dash...............................|SpaceVim-layer-tools-dash| + 90. tools#zeal...............................|SpaceVim-layer-tools-zeal| 7. Usage....................................................|SpaceVim-usage| 1. custom_plugins........................|SpaceVim-usage-custom_plugins| 2. repl............................................|SpaceVim-usage-repl| @@ -1473,6 +1474,22 @@ KEY BINDINGS < +============================================================================== +GIT *SpaceVim-layer-git* + +`git` layer provides git integration for SpaceVim. + +LAYER OPTIONS + +`git_plugin`: Set the background plugin used in `git` layer. The default value +is `git`, the following plugins are supported: `gina`, `fugitive` and `gita`. +> + [[layers]] + name = 'git' + git_plugin = 'git' +< + + ============================================================================== GITHUB *SpaceVim-layer-github* diff --git a/docs/cn/layers/git.md b/docs/cn/layers/git.md index 0f6bef7e8..d95e19c91 100644 --- a/docs/cn/layers/git.md +++ b/docs/cn/layers/git.md @@ -10,6 +10,7 @@ lang: zh - [模块描述](#模块描述) - [启用模块](#启用模块) +- [模块选项](#模块选项) - [快捷键](#快捷键) @@ -27,6 +28,18 @@ lang: zh name = "git" ``` +## 模块选项 + +- `git_plugin`: 设置后台使用的 git 插件,默认为 `git`,除此之外,还可以设置成为:`gina`, `fugitive`, `gita`, `git`。 + +如果需要使用 `fugitive` 作为后台插件,可以使用: + +```toml +[[layers]] + name = "git" + git_plugin = 'fugitive' +``` + ## 快捷键 | 快捷键 | 功能描述 | diff --git a/docs/layers/git.md b/docs/layers/git.md index 18576fb91..e300406dd 100644 --- a/docs/layers/git.md +++ b/docs/layers/git.md @@ -29,7 +29,15 @@ To use this configuration layer, add following snippet to your custom configurat ## Layer options -- `git-plugin`: default value is `gina` (or `gita` on older vim versions), available values include: `gina`, `fugitive`, `gita` +- `git_plugin`: default value is `git`, available values include: `gina`, `fugitive`, `gita`, `git`. + +if you want to use `fugitive` instead: + +```toml +[[layers]] + name = "git" + git_plugin = 'fugitive' +``` ## Key bindings