oil.code
Edit your filesystem like a normal file.
Provides an oil.nvim like experience for VSCode.
This plugin works best with VSCodeVim or vscode-neovim but can still be used without a Vim plugin.
Shortcuts
To open oil.code:
- Vim users - With a file focused and in normal mode press
-.
- All users - Press
alt+-.
| Vim Shortcut (normal mode) |
Default Shortcut |
Command |
Description |
Enter |
alt+Enter |
oil-code.select |
Open file or enter directory |
| -- No Default -- |
alt+c |
oil-code.close |
Close active oil file and open previous file |
- |
alt+- |
oil-code.openParent |
Navigate to parent directory |
ctrl+p |
alt+p |
oil-code.preview |
Toggle preview window of entry under the cursor |
If you're using vscode-neovim and want to customize the keymaps for oil.code:
- Set
oil-code.disableDefaultKeymaps to true in your VSCode settings
- Add the following to your
init.lua and customize as you like:
-- Default oil.code keymaps
if vim.g.vscode then
local vscode = require('vscode')
local map = vim.keymap.set
vim.api.nvim_create_autocmd({'BufEnter', 'BufWinEnter'}, {
pattern = {"*"},
callback = function()
map("n", "-", function() vscode.action('oil-code.open') end)
end,
})
vim.api.nvim_create_autocmd({'FileType'}, {
pattern = {"oil"},
callback = function()
map("n", "-", function() vscode.action('oil-code.openParent') end)
map("n", "<CR>", function() vscode.action('oil-code.select') end)
end,
})
end
If you're using VSCodeVim and want to customize the keymaps for oil.code:
- Set
oil-code.disableDefaultKeymaps to true in your VSCode settings
- Add the following to your
settings.json and customize as you like:
"vim.normalModeKeyBindings": [
{
"before": ["-"],
"commands": [
{
"command": "oil-code.open"
}
]
},
{
"before": ["<CR>"],
"commands": [
{
"command": "oil-code.select"
}
]
}
]
Why oil.code?
Oil.nvim is a favorite plugin of mine and I find myself going back and forth between Neovim and VSCode for various projects. Being able to quickly rename or move a file is an experience I want everywhere and I want to share with the great community of VSCode and Codium users.
Odds are good that if you found this plugin, you are like me and have experienced Oil.nvim and have found yourself back in VSCode and miss oil dearly.
oil.nvim feature comparison
The goal of this project isn't to be an exact implementation of oil.nvim for VSCode but rather to provide the most used and useful parts of it. If you use something that hasn't been implemented, please open an issue and let me know what is missing and how you typically use it.
Below is a list of features and keymaps that oil.nvim has and their status in oil.code. The implementation between the two projects is very different so some features may not be possible to match exactly.
Key:
- ✅ Implemented
- ❌ Not Implemented
- ❓ Not Planned
| feature |
oil.code |
| Use as default file explorer |
✅[^1] |
| Create new file |
✅ |
| Delete file |
✅ |
| Move file |
✅ |
| Rename file |
✅ |
| Move and Rename file |
✅ |
| Create new directory |
✅ |
| Delete directory |
✅ |
| Move directory |
✅ |
| Rename directory |
✅ |
| Move and Rename directory |
✅ |
| Open oil in multiple splits at once |
❌ |
| ["g?"] = { "actions.show_help", mode = "n" } |
❌ |
| ["<CR>"] = "actions.select" |
✅ |
| ["<C-s>"] = { "actions.select", opts = { vertical = true } } |
❌ |
| ["<C-h>"] = { "actions.select", opts = { horizontal = true } } |
❌ |
| ["<C-t>"] = { "actions.select", opts = { tab = true } } |
❌ |
| ["<C-p>"] = "actions.preview" |
✅[^2] |
| ["<C-c>"] = { "actions.close", mode = "n" } |
✅[^3] |
| ["<C-l>"] = "actions.refresh" |
❌ |
| ["-"] = { "actions.parent", mode = "n" } |
✅ |
| ["_"] = { "actions.open_cwd", mode = "n" } |
❌ |
| ["`"] = { "actions.cd", mode = "n" } |
❓ |
| ["~"] = { "actions.cd", opts = { scope = "tab" }, mode = "n" } |
❓ |
| ["gs"] = { "actions.change_sort", mode = "n" } |
❌ |
| ["gx"] = "actions.open_external" |
❓ |
| ["g."] = { "actions.toggle_hidden", mode = "n" } |
❌ |
| ["g\"] = { "actions.toggle_trash", mode = "n" } |
❓ |
[^1]: If VSCode is opened and no files are opened, the oil window will open. This can be disabled in settings.
[^2]: "<C-p>" keymap might have conflicts with Vim plugins and may require additional config
[^3]: oil-code.close is implemented but I was not able to set the default keymap of "<C-c>"
Nerd Fonts
Nerd font provide standard text characters along with a collection of icons.
You can set the VSCode text editor to use an installed Nerd Font by setting "editor.fontFamily": "JetBrainsMono Nerd Font" where "JetBrainsMono Nerd Font" is an example of a Nerd Font.
Once you have a Nerd Font set for your editor font, to use these icons in your oil view, set "oil-code.hasNerdFont": true.
Other great extensions
- vsnetrw: Another great option for a split file explorer.
- VSCodeVim: Vim emulation for VSCode.
- vscode-neovim: Fully embedded neovim instance, no vim emulation.
Special thanks
Special thanks goes to oil.nvim. I still use this every day and it has way more features and is much more extensible than this plugin. If there is something Oil.nvim does that is missing here and you find it useful, let me know in the issues or open a PR.
