barrett/canola.nvim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

refactor: rename oil to canola across entire codebase

Browse source 
Problem: the codebase still used the upstream \`oil\` naming everywhere —
URL schemes, the \`:Oil\` command, highlight groups, user events, module
paths, filetypes, buffer/window variables, LuaCATS type annotations,
vimdoc help tags, syntax groups, and internal identifiers.

Solution: mechanical rename of every reference. URL schemes now use
\`canola://\` (plus \`canola-ssh://\`, \`canola-s3://\`, \`canola-sss://\`,
\`canola-trash://\`, \`canola-test://\`). The \`:Canola\` command replaces
\`:Oil\`. All highlight groups, user events, augroups, namespaces,
filetypes, require paths, type annotations, help tags, and identifiers
follow suit. The \`upstream\` remote to \`stevearc/oil.nvim\` has been
removed and the \`vim.g.oil\` deprecation shim dropped.
This commit is contained in:
Barrett Ruth 2026-03-05 14:43:30 -05:00
parent 67ad0632a6
commit e6b42168c9
Signed by: barrett
GPG key ID: A6C96C9349D2FC81
70 changed files with 1571 additions and 1555 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -46,9 +46,9 @@ luarocks install canola.nvim
**Q: How do I migrate from `stevearc/oil.nvim`?**
Change the plugin source and replace `setup()` with `vim.g.oil` in `init`. The
configuration table is identical — only the entry point changes. For example,
with [lazy.nvim](https://github.com/folke/lazy.nvim):
Change the plugin source and replace `setup()` with `vim.g.canola` in `init`.
The configuration table is identical — only the entry point changes. For
example, with [lazy.nvim](https://github.com/folke/lazy.nvim):
Before (`stevearc/oil.nvim`):
@ -57,7 +57,7 @@ Before (`stevearc/oil.nvim`):
'stevearc/oil.nvim',
opts = { ... },
config = function(_, opts)
require('oil').setup(opts)
require('canola').setup(opts)
end,
}
```
@ -68,16 +68,16 @@ After (`barrettruth/canola.nvim`):
{
'barrettruth/canola.nvim',
init = function()
vim.g.oil = { ... }
vim.g.canola = { ... }
end,
}
```
`init` runs before the plugin loads; `config` runs after. oil.nvim reads
`vim.g.oil` at load time, so `init` is the correct hook. Do not use `config`,
`vim.g.canola` at load time, so `init` is the correct hook. Do not use `config`,
`opts`, or `lazy` — oil.nvim loads itself when you open a directory.
**Q: Why "oil"?**
**Q: Why "canola"?**
From the [vim-vinegar](https://github.com/tpope/vim-vinegar) README, a quote by
Drew Neil:
@ -100,4 +100,5 @@ Drew Neil:
## Acknowledgements
- [stevearc](https://github.com/stevearc): [oil.nvim](https://github.com/stevearc/oil.nvim)
- [stevearc](https://github.com/stevearc):
[oil.nvim](https://github.com/stevearc/oil.nvim)