Closed
Conversation
Problem: the old URL specifications.freedesktop.org/trash-spec/1.0/ is dead and redirects or 404s. Solution: update to the current URL trash/1.0/ in docs, source, and the generation script. Cherry-picked from: stevearc#722
Problem: the async fork of oil-git.nvim with directory highlighting was not listed in the README. Solution: add it to the third-party extensions list, disambiguating both oil-git.nvim entries by author name. Cherry-picked from: stevearc#717
Problem: get_current_dir returns nil in several cases that were not documented, causing confusion when used in keymaps that open pickers like Telescope (stevearc#682). Also, posix_to_os_path could crash on Windows when no drive letter is found. Solution: expand get_current_dir docs to explain nil return cases, add a Telescope recipe with nil guards, and add a defensive nil check in posix_to_os_path. Cherry-picked from: stevearc#727
Problem: there was no example showing how to register and sort by a custom column. Solution: add a recipe demonstrating an "extension" column with natural-order sorting. Cherry-picked from: stevearc#697
Problem: user keymap overrides like <c-t> failed to replace the default <C-t> because the keys were compared as raw strings during merge, leaving both entries in the table. Solution: use nvim_replace_termcodes to compare keymap keys by their internal representation, removing any default entry that normalizes to the same key as the user-provided one before inserting it. Closes stevearc#692 Cherry-picked from: stevearc#725
Problem: the BufAdd autocmd that hijacks directory buffers was always created, even when default_file_explorer was false. The guard inside maybe_hijack_directory_buffer made it a no-op, but the autocmd still fired on every BufAdd event. Solution: wrap the BufAdd autocmd creation and initial buffer hijack in a config.default_file_explorer conditional. The guard inside maybe_hijack_directory_buffer is kept as defense-in-depth. Based on: stevearc#720
Problem: third-party plugins like oil-git-status.nvim had no way to know when an oil buffer was re-rendered after a filesystem change, causing their decorations to be cleared with no signal to refresh. Solution: emit a User OilReadPost autocmd after every successful render_buffer_async call. Also document all oil user events (OilEnter, OilReadPost, OilMutationComplete) in oil.txt since none were previously documented. Cherry-picked from: stevearc#723
Problem: when close() is triggered from visual or operator-pending mode (e.g. pressing q after d in an oil buffer), the buffer closes instead of canceling the pending operation. This happens because keymaps without an explicit mode default to "" which covers normal, visual, select, and operator-pending modes. Solution: check the current mode at the top of close() and send <Esc> to cancel the mode instead of proceeding with the close. The check covers all visual modes (v, V, CTRL-V), select modes (s, S, CTRL-S), and operator-pending submodes (no, nov, noV, noCTRL-V). Based on: stevearc#495
Problem: the is_hidden_file and is_always_hidden config callbacks only received (name, bufnr), making it impossible to filter by entry type, permissions, or other metadata without reimplementing entry lookup. Solution: pass the full oil.Entry as a third argument to both callbacks. Existing configs that only accept (name, bufnr) are unaffected since Lua silently ignores extra arguments. The internal should_display function signature changes from (name, bufnr) to (bufnr, entry) to reflect its new contract. Cherry-picked from: stevearc#644
Problem: the fork used master as the default branch name. Solution: rename to main and update all CI workflow triggers, ref checks, and the pre-push hook fallback.
skip-checks: true
Problem: executable files were visually indistinguishable from regular files in oil buffers. Solution: add OilExecutable highlight group (linked to DiagnosticOk) that detects executables via Unix permission bits (S_IXUSR|S_IXGRP| S_IXOTH) and Windows executable extensions (.exe, .bat, .cmd, .com, .ps1). Applied to both regular files and symlink targets. Based on: stevearc#698 Closes stevearc#679
Problem: files without standard extensions (e.g. scripts with shebangs, Makefile, Dockerfile) got incorrect or default icons since icon providers match by filename or extension only. Solution: add use_slow_filetype_detection option to the icon column config. When enabled, reads the first 16 lines of each file and passes them to vim.filetype.match for content-based detection. The detected filetype is forwarded to mini.icons or nvim-web-devicons as a trailing parameter, preserving backwards compatibility with existing icon provider implementations. Based on: stevearc#618
Problem: files were always created with mode 0644 and directories with 0755, hardcoded in fs.touch and uv.fs_mkdir. Users who need different defaults (e.g. 0600 for security) had no config option. Solution: add new_file_mode (default 420 = 0644) and new_dir_mode (default 493 = 0755) config options, passed through to fs.touch and uv.fs_mkdir in the files and mac trash adapters. The fs.touch signature accepts an optional mode parameter with backwards compatibility (detects function argument to support old callers). Local cache directories (SSH, S3) continue using standard system permissions rather than the user-configured mode. Based on: stevearc#537
Problem: when Neovim is started with -R (read-only), all buffers get readonly=true. Oil's render_buffer toggles modifiable to write directory listings, which triggers "W10: Warning: Changing a readonly file" on every directory navigation. Solution: clear readonly on oil buffers during initialization. Oil buffers are buftype=acwrite — readonly has no meaning for them since writes go through BufWriteCmd, not the filesystem. Resolves: stevearc#642
Problem: when a symlink target path contains a newline character, the
rendered line passed to nvim_buf_set_lines includes that newline,
causing the error "'replacement string' item contains newlines".
Solution: apply the same gsub("\n", "") sanitization to meta.link in
get_link_text that is already used for entry names at line 791.
Resolves: stevearc#673
Problem: the rendering code constructs "OilExecutable" .. "Hidden" for hidden executables, but that group was never defined. Hidden executables silently lose all highlighting instead of being dimmed like every other hidden entry type. Solution: add OilExecutableHidden linked to OilHidden, consistent with OilFileHidden, OilDirHidden, and all other hidden variants. Based on: stevearc#698
Problem: when nvim-web-devicons returns no highlight for an unrecognized file extension, the icon gets nil for its highlight group. Directories have OilDirIcon as a targetable fallback, but files have nothing. Solution: define OilFileIcon (linked to nil, matching OilFile) and use it as the fallback in the devicons provider when get_icon returns a nil highlight. The mini.icons provider already returns highlights for all files so only the devicons path needs this. Resolves: stevearc#690
Problem: users who bind <Esc> to close oil in floating windows also accidentally close oil in split or fullscreen windows. There is no action that closes only a floating oil window and is a no-op otherwise. Solution: add a close_float action that checks vim.w.is_oil_win (the same window-local variable oil.close already uses to identify its own floating windows) before delegating to oil.close. Resolves: stevearc#645
Problem: hidden files are dimmed via OilHidden -> Comment, and there is no clean way to make them look identical to visible entries. Clearing OilHidden alone causes all hidden types to lose their type-specific coloring. Solution: add a recipe that iterates _get_highlights() and relinks each Oil*Hidden group to its non-hidden base. The Lua pattern "^(Oil.+)Hidden$" naturally skips OilHidden itself and automatically covers any future entry types. Resolves: stevearc#578
Problem: CI typecheck fails with 13 warnings — 11 need-check-nil in util.render_text (opts param annotated nil|table but guaranteed non-nil after tbl_deep_extend), 1 undefined-doc-param in view.render_buffer_async (annotation says "callback" but param is "caller_callback"), and 1 need-check-nil on opts in the same function. Solution: add ---@cast opts -nil after the tbl_deep_extend call, fix the param name in the doc annotation, and add opts = opts or {} guard.
Problem: the docgen workflow pushes to main using GITHUB_TOKEN, which authenticates as github-actions[bot]. The bot cannot bypass repository rulesets on personal repos, so the push is rejected by required PR, status check, and signature rules. Solution: prefer a PUSH_TOKEN secret (a PAT authenticated as the repo admin, who has bypass permissions) with fallback to GITHUB_TOKEN so the workflow does not break before the secret is created.
Problem: LuaLS still warns at opts.refetch access because it does not
track narrowing through opts = opts or {}.
Solution: add ---@cast opts -nil after the guard, matching the same
pattern used in util.render_text.
Problem: the ---@cast opts -nil was placed after the first opts guard but LuaLS loses narrowing at the second tbl_deep_extend on line 928, causing a persistent need-check-nil warning at opts.refetch. Solution: remove the redundant first opts = opts or {} guard (the tbl_deep_extend already handles nil) and place the cast after the second tbl_deep_extend where opts is actually used.
Problem: the docgen workflow pushed directly to main, which is blocked by repository rulesets. No token-based push from GitHub Actions can bypass ruleset rules on personal repos. Solution: replace the push step with a git diff --exit-code check that fails if generated docs are out of date. Docs must now be committed by the developer via make doc. Also regenerates docs to reflect batch 4 changes (close_float, OilFileIcon, OilExecutableHidden, recipe link).
Problem: oil sets buftype='acwrite' inside view.initialize(), which runs in an async finish() callback after adapter.normalize_url(). BufEnter fires before finish() completes, so user autocmds that check buftype on oil buffers see an empty string instead of 'acwrite'. Solution: set buftype='acwrite' early in load_oil_buffer() alongside the existing early filetype='oil' assignment, before the async gap. The redundant set in view.initialize() is harmless (idempotent). Closes: stevearc#710
Problem: when neovim is opened with multiple directory arguments (e.g. nvim dir1/ dir2/), only the first directory gets handled by oil. The BufAdd autocmd that renames directory buffers to oil:// URLs is registered inside setup(), but neovim creates all argument buffers before setup() runs. The initial hijack block only processes nvim_get_current_buf(), so additional directory buffers are never renamed and remain as plain empty buffers. Solution: iterate all existing buffers at setup time instead of only the current one. Each directory buffer gets renamed to an oil:// URL so that BufReadCmd fires when the user switches to it. Closes: stevearc#670
…rs (#12) Problem: when the preview window opens a directory that already has a loaded oil buffer with unsaved edits, open_preview() unconditionally calls load_oil_buffer() on it. This re-initializes the buffer via view.initialize() -> render_buffer_async(), which re-fetches the directory listing from disk and replaces all buffer lines, destroying the user's pending edits. The mutation parser then can't see the deleted entry in the source buffer, so it produces a COPY action instead of a MOVE. Solution: guard the load_oil_buffer() call in open_preview() with a check for vim.b[filebufnr].oil_ready. Buffers that are already initialized and rendered are not re-loaded, preserving any unsaved modifications the user has made. Closes: stevearc#632
* fix(test): resolve busted migration test isolation issues Problem: Two issues introduced during the plenary-to-busted migration (6be0148). First, altbuf_spec waited for two BufEnter events but oil:// → file resolution only fires one async BufEnter (the synchronous one from vim.cmd.edit fires before wait_for_autocmd is registered). Second, reset_editor kept the first window which could be a preview window with stale oil_preview/oil_source_win state, causing close_preview_window_if_not_in_oil to close the wrong window in subsequent tests. Solution: Wait for a single BufEnter in the altbuf test. Replace the window-keeping logic in reset_editor with vim.cmd.new() + vim.cmd.only() to guarantee a fresh window with no inherited state. This also fixes the preview_spec.lua:30 timeout which had the same root cause. 114/114 tests pass. * fix(ci): fix nightly tests and remove unused Makefile Problem: Neovim nightly's ftplugin/markdown.lua now calls vim.treesitter.start() unconditionally, which crashes in CI where the markdown parser is not installed. The Makefile is unused — CI runs selene, stylua, and nvim-busted-action directly. Solution: Change filetype plugin indent on to filetype on in minimal_init.lua. Tests only need filetype detection for vim.bo.filetype assertions, not ftplugin or indent loading. Remove the Makefile.
* build: clean up gitignore and remove empty gitmodules Problem: .gitignore contained 48 lines of C/shared-object boilerplate irrelevant to a Lua Neovim plugin. .gitmodules was tracked but empty. Solution: replace .gitignore with minimal entries covering only files this project actually produces. Delete the vestigial .gitmodules. * build: add editorconfig and prettierrc Problem: no editor or formatter configuration, inconsistent with cp.nvim and diffs.nvim conventions. Solution: add .editorconfig (2-space Lua indent, utf-8, final newline) and .prettierrc (prose wrap, 80 cols, single quotes, no semi) matching the other repos. * build: add Makefile for lint and test targets Problem: .github/pre-commit calls `make fastlint` and .github/pre-push calls `make lint && make test`, but no Makefile existed, so the git hooks failed. Solution: add Makefile with lint (stylua + selene), fastlint (pre-commit), and test (luarocks test) targets. * docs: add fork copyright to LICENSE Problem: LICENSE only contained the original author's copyright notice. Solution: add a second copyright line for the fork maintainer. MIT requires retaining the original notice; adding a line for derivative work is standard practice. * ci: restructure workflows to quality/test/luarocks pattern Problem: CI used a single tests.yml for linting, typechecking, and testing. No conditional path filtering, no markdown format check, and a stale mirror_upstream_prs.yml and duplicate luarocks.yml existed. Solution: replace tests.yml with quality.yaml (stylua, selene, lua-typecheck, prettier with dorny/paths-filter) and test.yaml (nvim-busted, stable+nightly matrix). Update luarocks.yaml to reference quality.yaml. Delete mirror_upstream_prs.yml and duplicate luarocks.yml. Fix automation workflow sender check. * build: rewrite issue templates Problem: issue templates used upstream stevearc references, severity dropdowns, outdated lazy.nvim bootstrap, and the .yml extension inconsistent with other repos. Solution: replace with .yaml templates matching cp.nvim/diffs.nvim style. Bug report uses prerequisites checkboxes, checkhealth output, modern lazy.nvim bootstrap with vim.g.oil pattern. Feature request uses problem/solution/alternatives format. Add config.yaml to disable blank issues and link discussions. * docs: rewrite README Problem: README contained upstream triage tables, severity dropdowns, the old setup() pattern, a tree view question, and references to stevearc/oil.nvim as the primary source. Solution: full rewrite matching cp.nvim/diffs.nvim style with bold tagline, features list, requirements, installation, documentation, FAQ (lazy.nvim setup with vim.g.oil, migration guide, alternatives), and acknowledgements crediting the original author. * revert: remove Makefile Problem: Makefile was added in b9279b5 but was previously deleted intentionally. Solution: remove it.
Problem: mrcjkb/lua-typecheck-action runs lua-language-server in a bare nix sandbox without neovim installed, causing 71 type errors for all vim.* and uv.* types. LuaLS 3.17.x also introduced stricter type checking that flags uv.aliases.fs_types mismatches not present in 3.16.4. The .luarc.json workspace.library entries conflicted with the action's auto-appended luvit-meta, producing duplicate uv type unions. Solution: switch to stevearc/nvim-typecheck-action@v2 (matching upstream), pin LuaLS to 3.16.4, convert .luarc.json to nested format without workspace.library (let the action provide VIMRUNTIME and luvit-meta), and add .direnv/* to selene.toml exclude for local use.
* feat(icons): add nonicons.nvim icon provider support
Problem: oil.nvim only recognizes mini.icons and nvim-web-devicons as
icon providers. nonicons.nvim works when paired with devicons (via its
apply() monkey-patch), but has no standalone support.
Solution: add a nonicons.nvim fallback in get_icon_provider(), placed
after devicons so the patched devicons path is preferred when both are
installed. The standalone path handles directories via
nonicons.get('file-directory'), files via filetype/extension lookup with
a generic file icon fallback.
* fix(doc): improve readme phrasing
Problem: nonicons.nvim exposes a public get_icon/get_icon_by_filetype API, but oil.nvim can only use nonicons glyphs indirectly through the devicons monkey-patch. This couples oil to devicons even when nonicons is available standalone. Solution: add a nonicons provider in get_icon_provider() between mini.icons and devicons. Feature-gated on nonicons.get_icon existing so old nonicons versions fall through to devicons. Uses OilDirIcon and OilFileIcon highlight groups.
Problem: the fork shared the same name as upstream, making it difficult to distinguish and discover independently. Solution: rename the repository to canola.nvim — a type of oil, making the lineage obvious while establishing a distinct identity. Update all references in the README, rockspec, and issue templates.
Problem: the full upstream PR and issue triage was removed from the README during the repository modernization, leaving no user-facing record of what the fork addresses. Solution: restore the triage tables in a dedicated doc/upstream.md and link to it from the top of the README. Keeps the README clean while giving the full picture a permanent home.
Problem: when the nonicons direct API was detected, all icons were returned with the generic 'OilFileIcon' highlight group, losing per-filetype colors from nvim-web-devicons. Solution: resolve highlight groups from devicons when available so nonicons glyphs retain their per-filetype colors.
Problem: new upstream issues and PRs slip through because there's no mechanism to surface them — manual polling of stevearc/oil.nvim is required and easy to forget. Solution: add a Monday 9am UTC scheduled workflow that reads the highest stevearc/oil.nvim number from doc/upstream.md, fetches merged PRs and new open issues/PRs above that threshold via the gh CLI, and creates a structured digest issue in barrettruth/canola.nvim. No issue is created when there's nothing new. Falls back to a 30-day window if doc/upstream.md can't be parsed.
Problem: the initial approach created GitHub issues for new upstream activity, which accumulate and require a separate triage step outside the codebase. Solution: rewrite the script to append new rows directly to doc/upstream.md (open PRs and issues to their respective tables, merged PRs with "merged — not cherry-picked" status), then open a PR with auto-merge enabled. The workflow formats the markdown with prettier before committing so the markdown-format check passes.
Author
|
sigh... sorry! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.