Step 1: Install the plugin with your preferred plugin manager
Plugin Manager | Install with... |
---|---|
Dein | call dein#add('PratikBhusal/vim-osplugin') |
Pathogen | git clone https://github.com/PratikBhusal/vim-osplugin ~/.vim/bundle/vim-osplugin |
Plug | Plug 'PratikBhusal/vim-osplugin' |
Vundle | Plugin 'PratikBhusal/vim-osplugin' |
Manual | Put the files into your ~/.vim directory |
Step 2: Put your os-specific configurations into a *.vim file
By default, the filenames will be windows.vim, macOS.vim, and linux.vim. If you want to change the names or have the files automatically generated for you to edit out of the box, see the options section.
Step 3: Put your OS-specific *.vim file into the designated directory
The default directory is $HOME/.vim/osplugin
on Unix systems and
$HOME/vimfiles/osplugin
on Windows. If you want to change the directory or
have it automatically generated for you, see the options section.
Step 4: ???
Do vim stuff?
Step 5: Contribute
It's always a good idea to give back!
After following the installation instructions and (hopefully) don't have any problems, you should be good to go. If you do face issues or want to customize how the plugin works, see the rest of this section.
If for some reason you do face issues, you should consider enabling this. Otherwise, leave it to it's default value. With it enabled, you will see messages telling you how about any potential issues osplugin faced when sourcing files.
Default:
let g:osplugin_verbose = 0
Location of osplugin directory.
Default On Windows:
let g:osplugin_dir = expand("$HOME/vimfiles/osplugin")
Default On anything else:
let g:osplugin_dir = expand("$HOME/.vim/osplugin")
By default the user would have to manually create the directory. If you want the
plugin to automatically create the directory, set this to 1
.
Default:
let g:osplugin_auto_create_dir = 0
By default the user would have to manually create the file(s) for osplugin to
source the configurations. If you want the plugin to automatically create the
file(s), set this to 1
.
Default:
let g:osplugin_auto_create_os_file = 0
By default the user would have to manually create the folder(s) for osplugin to
source the configurations. If you want the plugin to automatically create the
folder(s), set this to 1
.
Default:
let g:osplugin_auto_create_os_folder = 0
Adds {os_filename} to the list of configuration files to source. If
g:osplugin_auto_create_file
is enabled and {os_filename} is unreadable, then
it also creates a blank file.
For example, if you want to load cygwin and linux specific configurations:
if g:cygwin
call osplugin#init('cygwin')
call osplugin#init('linux')
endif
None (so far).
- Bugfix on Linux
- After after/ directory support
MIT License. Copyright © 2017-2018 Pratik Bhusal