SpaceVim
A community-driven vim distribution
Home | About | Quick start guide | Documentation | Development | Community | Sponsors
SpaceVim is an effort of all the volunteers. We encourage you to pitch in. The community makes SpaceVim what it is. We have a few guidelines which we need all contributors to follow.
You can only consider reading the sections relevant to what you are going to do:
If you want to ask an usage question, be sure to look first into some places as it may hold the answers:
Issues have to be reported on issues tracker, please:
Code contributions are welcome. Please read the following sections carefully. In any case, feel free to join us on the gitter chat to ask questions about contributing!
The license is GPLv3 for all the parts of SpaceVim. This includes:
For files not belonging to SpaceVim like local packages and libraries, refer to the header file. Those files should not have an empty header, we may not accept code without a proper header file.
SpaceVim is based on conventions, mainly for naming functions, keybindings definition and writing documentation. Please read the conventions before your first contribution to get to know them.
A git commit message consists a three distinct parts separated by black line.
Type (scope): Subject
body
footer
feat
: A new featurefix
: A bug fixdocs
: Changes to documentationstyle
: Formatting, missing semi colons, etc; no code changerefactor
: Refactoring production codetest
: Adding tests, refactoring test; no production code changechore
: Updating build tasks, package manager configs, etc; no production code changelayer
api
plugin
Subjects should be no greater than 50 characters, should begin with a capital letter and do not end with a period.
Use an imperative tone to describe what a commit does, rather than what it did. For example, use change; not changed or changes.
Not all commits are complex enough to warrant a body body, therefore it is optional and only used when a commit requires a bit of explanation and context.
The footer is optional and is used to reference issue tracker IDs.
Pull request titles should contain one of these prefix:
Add:
Adding new features.Change:
Change default behaviors or the existing features.Fix:
Fix some bugs.Remove:
Remove some existing features.Doc:
Update the help files.Website:
Update the content of website.Here is an example:
Website: Update the lang#c layer page.
git clone ${YOUR_OWN_REPOSITORY_URL}
git remote add upstream https://github.com/SpaceVim/SpaceVim.git
git fetch upstream
git rebase upstream/master
master
Squash only the commits with uninteresting changes like typos, syntax fixes, etc. And keep the important and isolated steps in different commits.
Those PRs are merged and explicitly not fast-forwarded.
Please read the layers documentation first.
Layer with no associated configuration will be rejected. For instance a layer with just a package and a hook can be easily replaced by the usage of the variable custom_plugins
.
The file header for Vim script should look like the following template:
"=============================================================================
" FILENAME --- NAME layer file for SpaceVim
" Copyright (c) 2016-2020 Wang Shidong & Contributors
" Author: Wang Shidong < [email protected] >
" URL: https://spacevim.org
" License: GPLv3
"=============================================================================
You should replace FILENAME by the name of the file (e.g. foo.vim) and NAME by the name of the layer you are creating, don’t forget to replace YOUR NAME and YOUR EMAIL neighter.
In the files header, replace the default author name (Shidong Wang) with your name.
The following example shows how to create a new layer names foo
:
autoload/SpaceVim/layers/foo.vim
for foo
layer."=============================================================================
" foo.vim --- foo Layer file for SpaceVim
" Copyright (c) 2012-2016 Shidong Wang & Contributors
" Author: Shidong Wang < wsdjeg at 163.com >
" URL: https://spacevim.org
" License: GPLv3
"=============================================================================
""
" @section foo, layer-foo
" @parentsection layers
" This the doc for this layer:
"
" @subsection Key Bindings
" >
" Mode Key Function
" -------------------------------------------------------------
" normal <leader>jA generate accessors
" normal <leader>js generate setter accessor
" <
" @subsection Layer options
" >
" Name Description Default
" -------------------------------------------------------------
" option1 Set option1 for foo layer ''
" option2 Set option2 for foo layer []
" option3 Set option3 for foo layer {}
" <
" @subsection Global options
" >
" Name Description Default
" -------------------------------------------------------------
" g:pluginA_opt1 Set opt1 for plugin A ''
" g:pluginB_opt2 Set opt2 for plugin B []
" <
function! SpaceVim#layers#foo#plugins() abort
let plugins = []
call add(plugins, ['Shougo/foo.vim', {'option' : 'value'}])
call add(plugins, ['Shougo/foo_test.vim', {'option' : 'value'}])
return plugins
endfunction
function! SpaceVim#layers#foo#config() abort
let g:foo_option1 = get(g:, 'foo_option1', 1)
let g:foo_option2 = get(g:, 'foo_option2', 2)
let g:foo_option3 = get(g:, 'foo_option3', 3)
" ...
endfunction
" add layer options:
let s:layer_option = 'default var'
function! SpaceVim#layers#foo#set_variable(var) abort
let s:layer_option = get(a:var, 'layer_option', s:layer_option)
endfunction
" completion function for layer options:
function! SpaceVim#layers#foo#get_options() abort
return ['layer_option']
endfunction
docs/layers/foo.md
for foo
layer.docs/layers/index.md
, run :call SpaceVim#dev#layers#update()
to update layer list.If you want to contribute to an already existing layer, you should not modify any header file.
Mappings are an important part of SpaceVim.
First if you want to have some personal mappings. This can be done in your bootstrap function.
If you think it worth contributing new mappings, be sure to read the documentation to find the best mappings, then create a Pull-Request with your mappings.
ALWAYS document your new mappings or mappings changes inside the relevant documentation file. It should be the layername.md and the documentation.
All language specified key bindings prefix SPC l
.
We recommend to keep same language specified key bindings for different languages:
Key Binding | Description |
---|---|
SPC l r |
start a runner for current file |
SPC l e |
rename symbol |
SPC l d |
show doc |
SPC l i r |
remove unused imports |
SPC l i s |
sort imports with isort |
SPC l s i |
Start a language specified inferior REPL process |
SPC l s b |
send buffer and keep code buffer focused |
SPC l s l |
send line and keep code buffer focused |
SPC l s s |
send selection text and keep code buffer focused |
All above key bindings are just recommended as default, but they also base on the language layer itself.
The startup banner is by default the SpaceVim logo but there are also ASCII banners available in the core/banner layer.
If you have some ASCII skills you can submit your artwork!
You are free to choose a reasonable height size but the width size should be around 75 characters.
SpaceVim provide a lot of public APIs, you can create plugins base on this APIs. Also you can add a badge to the README.md of your plugin.
markdown
[](https://spacevim.org)
We know exactly what is the purpose of SpaceVim, and we keep trying to get it, never get lost, never give up...
A new hope: turn vim/neovim to be an IDE for most languages
SpaceVim release v1.6.0 with four new language layers and floating window support.
SpaceVim release v1.5.0 with four new language layers and floating window support.
SpaceVim released V1.4.0 with eight new language layers and an asynchronous task management plugin
SpaceVim release v1.3.0 with ten new language layers and several functional improvements
SpaceVim release v1.2.0 with 12 new programming language layers and ton of bug fixs and new features.
SpaceVim v1.1.0 introduced new floating window mapping guide, and a disk management for Windows, as well as improved the fzf layer.
V1.0.0 is the first stable version of SpaceVim, which is mainly about experience and user documentation.
SpaceVim release v0.9.0 with 15+ new language layers and frequency support for colorscheme layer.
Use toml as default configuration file for SpaceVim
Highlight symbol mode and iedit mode come out with v0.7.0
Many new features come out with v0.6.0, including c/cpp suport and code runner
SpaceVim v0.5.0 comes out with five new language layer and many new features
New release v0.4.0 provides a new UI for plugin manager and built-in flygrep plugin
New release v0.3.1 provides better key binding guide for buffer and file, including z and g prefix guide.
The major change happend in v0.3.0 is new mapping guide and custom mapping prefix SPC.
Mnemonic key bindings in SpaceVim
First public release of SpaceVim with IDE-like UI, most language support, modular configuration
Powered by Jekyll,
Help improve this page