Compare commits
35 Commits
v1.0
...
compat-nvi
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2bc725a3eb | ||
|
|
340d3a9795 | ||
|
|
edd4e25fd4 | ||
|
|
78c4c083ed | ||
|
|
acffab931a | ||
|
|
64f61e4c91 | ||
|
|
347e1eb352 | ||
|
|
76db7ed0da | ||
|
|
5a18b98274 | ||
|
|
62008e5cf2 | ||
|
|
ae8e46e8fa | ||
|
|
81eb8d5192 | ||
|
|
d8d3a1590a | ||
|
|
ddd1d6eb21 | ||
|
|
0aca0920f4 | ||
|
|
308f2fcec2 | ||
|
|
2d97059661 | ||
|
|
e508bdc418 | ||
|
|
e20966ae55 | ||
|
|
85c502e907 | ||
|
|
b1bbd4f7dc | ||
|
|
f7c09bd72e | ||
|
|
707b24af91 | ||
|
|
76b98109f6 | ||
|
|
cfea5bd080 | ||
|
|
1fd9c98960 | ||
|
|
164f11db4f | ||
|
|
8f2a50f1cd | ||
|
|
c64becf80c | ||
|
|
3c4267eb50 | ||
|
|
041dbd18f4 | ||
|
|
efafd73efa | ||
|
|
d52fdeb0a3 | ||
|
|
7efaa339d3 | ||
|
|
030defdb65 |
4
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
4
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
@@ -59,9 +59,9 @@ body:
|
||||
|
||||
If not provided it is very unlikely that the nvim-tree team will be able to address your issue.
|
||||
|
||||
See [wiki: Clean Room Replication](https://github.com/nvim-tree/nvim-tree.lua/wiki/Troubleshooting#clean-room-replication) for instructions.
|
||||
See [wiki: Clean Room Replication](https://github.com/nvim-tree/nvim-tree.lua/wiki/Troubleshooting#clean-room-replication) for instructions and paste the contents of your `/tmp/nvt-min.lua` here.
|
||||
|
||||
Please paste the contents of your `/tmp/nvt-min.lua` here."
|
||||
Please do NOT post a configuration that uses other plugin managers such as lazy, see [wiki: Lazy Loading](https://github.com/nvim-tree/nvim-tree.lua/wiki/Installation#lazy-loading)"
|
||||
render: lua
|
||||
validations:
|
||||
required: true
|
||||
|
||||
14
.github/workflows/ci.yml
vendored
14
.github/workflows/ci.yml
vendored
@@ -2,6 +2,8 @@ name: CI
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
push:
|
||||
branches: [master]
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
@@ -11,6 +13,10 @@ jobs:
|
||||
lint:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ matrix.lua_version }}-${{ github.head_ref || github.ref_name }}
|
||||
cancel-in-progress: true
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
lua_version: [ 5.1 ]
|
||||
@@ -31,6 +37,10 @@ jobs:
|
||||
style:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ matrix.stylua_version }}-${{ github.head_ref || github.ref_name }}
|
||||
cancel-in-progress: true
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
stylua_version: [ 0.19.1 ]
|
||||
@@ -50,6 +60,10 @@ jobs:
|
||||
check:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ matrix.nvim_version }}-${{ matrix.luals_version }}-${{ github.head_ref || github.ref_name }}
|
||||
cancel-in-progress: true
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
nvim_version: [ stable, nightly ]
|
||||
|
||||
37
.github/workflows/luarocks.yml
vendored
Normal file
37
.github/workflows/luarocks.yml
vendored
Normal file
@@ -0,0 +1,37 @@
|
||||
name: Release
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- 'v[0-9]+.[0-9]+.[0-9]+'
|
||||
workflow_dispatch:
|
||||
jobs:
|
||||
luarocks-upload:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: LuaRocks Upload
|
||||
uses: nvim-neorocks/luarocks-tag-release@v5
|
||||
env:
|
||||
LUAROCKS_API_KEY: ${{ secrets.LUAROCKS_API_KEY }}
|
||||
with:
|
||||
summary: A File Explorer For Neovim
|
||||
detailed_description: |
|
||||
Automatic updates
|
||||
|
||||
File type icons
|
||||
|
||||
Git integration
|
||||
|
||||
Diagnostics integration - LSP and COC
|
||||
|
||||
(Live) filtering
|
||||
|
||||
Cut, copy, paste, rename, delete, create etc.
|
||||
|
||||
Highly customisable
|
||||
|
||||
Rich API
|
||||
license: "GPL-3.0"
|
||||
labels: neovim
|
||||
dependencies: |
|
||||
nvim-web-devicons
|
||||
4
.github/workflows/release-please.yml
vendored
4
.github/workflows/release-please.yml
vendored
@@ -3,7 +3,9 @@ on:
|
||||
branches:
|
||||
- master
|
||||
workflow_dispatch:
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}
|
||||
cancel-in-progress: true
|
||||
name: release-please
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
6
.github/workflows/semantic-pr-subject.yml
vendored
6
.github/workflows/semantic-pr-subject.yml
vendored
@@ -7,11 +7,13 @@ on:
|
||||
- edited
|
||||
- synchronize
|
||||
workflow_dispatch:
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.head_ref }}
|
||||
cancel-in-progress: true
|
||||
jobs:
|
||||
semantic-pr-subject:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: amannn/action-semantic-pull-request@v5.4.0
|
||||
- uses: amannn/action-semantic-pull-request@v5.5.2
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
{
|
||||
".": "1.0.0"
|
||||
".": "1.3.3"
|
||||
}
|
||||
|
||||
67
CHANGELOG.md
67
CHANGELOG.md
@@ -1,5 +1,72 @@
|
||||
# Changelog
|
||||
|
||||
## [1.3.3](https://github.com/nvim-tree/nvim-tree.lua/compare/nvim-tree-v1.3.2...nvim-tree-v1.3.3) (2024-05-14)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* nil access exception with git integration when changing branches ([#2774](https://github.com/nvim-tree/nvim-tree.lua/issues/2774)) ([340d3a9](https://github.com/nvim-tree/nvim-tree.lua/commit/340d3a9795e06bdd1814228de398cd510f9bfbb0))
|
||||
|
||||
## [1.3.2](https://github.com/nvim-tree/nvim-tree.lua/compare/nvim-tree-v1.3.1...nvim-tree-v1.3.2) (2024-05-12)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **#2758:** use nvim-webdevicons default file icon, not renderer.icons.glyphs.default, as per :help ([#2759](https://github.com/nvim-tree/nvim-tree.lua/issues/2759)) ([347e1eb](https://github.com/nvim-tree/nvim-tree.lua/commit/347e1eb35264677f66a79466bb5e3d111968e12c))
|
||||
* **#2758:** use nvim-webdevicons default for default files ([347e1eb](https://github.com/nvim-tree/nvim-tree.lua/commit/347e1eb35264677f66a79466bb5e3d111968e12c))
|
||||
* **#925:** handle newlines in file names ([#2754](https://github.com/nvim-tree/nvim-tree.lua/issues/2754)) ([64f61e4](https://github.com/nvim-tree/nvim-tree.lua/commit/64f61e4c913047a045ff90bd188dd3b54ee443cf))
|
||||
|
||||
## [1.3.1](https://github.com/nvim-tree/nvim-tree.lua/compare/nvim-tree-v1.3.0...nvim-tree-v1.3.1) (2024-04-25)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **#2535:** TextYankPost event sends vim.v.event ([#2734](https://github.com/nvim-tree/nvim-tree.lua/issues/2734)) ([d8d3a15](https://github.com/nvim-tree/nvim-tree.lua/commit/d8d3a1590a05b2d8b5eb26e2ed1c6052b1b47a77))
|
||||
* **#2733:** escape trash path ([#2735](https://github.com/nvim-tree/nvim-tree.lua/issues/2735)) ([81eb8d5](https://github.com/nvim-tree/nvim-tree.lua/commit/81eb8d519233c105f30dc0a278607e62b20502fd))
|
||||
|
||||
## [1.3.0](https://github.com/nvim-tree/nvim-tree.lua/compare/nvim-tree-v1.2.0...nvim-tree-v1.3.0) (2024-03-30)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add update_focused_file.exclude ([#2673](https://github.com/nvim-tree/nvim-tree.lua/issues/2673)) ([e20966a](https://github.com/nvim-tree/nvim-tree.lua/commit/e20966ae558524f8d6f93dc37f5d2a8605f893e2))
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **#2658:** change SpellCap groups to reduce confusion: ExecFile->Question, ImageFile->Question, SpecialFile->Title, Symlink->Underlined; add all other highlight groups to :NvimTreeHiTest ([#2732](https://github.com/nvim-tree/nvim-tree.lua/issues/2732)) ([0aca092](https://github.com/nvim-tree/nvim-tree.lua/commit/0aca0920f44b12a8383134bcb52da9faec123608))
|
||||
* bookmark filter shows marked directory children ([#2719](https://github.com/nvim-tree/nvim-tree.lua/issues/2719)) ([2d97059](https://github.com/nvim-tree/nvim-tree.lua/commit/2d97059661c83787372c8c003e743c984ba3ac50))
|
||||
|
||||
## [1.2.0](https://github.com/nvim-tree/nvim-tree.lua/compare/nvim-tree-v1.1.1...nvim-tree-v1.2.0) (2024-03-24)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add api.tree.toggle_enable_filters ([#2706](https://github.com/nvim-tree/nvim-tree.lua/issues/2706)) ([f7c09bd](https://github.com/nvim-tree/nvim-tree.lua/commit/f7c09bd72e50e1795bd3afb9e2a2b157b4bfb3c3))
|
||||
|
||||
## [1.1.1](https://github.com/nvim-tree/nvim-tree.lua/compare/nvim-tree-v1.1.0...nvim-tree-v1.1.1) (2024-03-15)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **#2395:** marks.bulk.move defaults to directory at cursor ([#2688](https://github.com/nvim-tree/nvim-tree.lua/issues/2688)) ([cfea5bd](https://github.com/nvim-tree/nvim-tree.lua/commit/cfea5bd0806aab41bef6014c6cf5a510910ddbdb))
|
||||
* **#2705:** change NvimTreeWindowPicker cterm background from Cyan to more visible DarkBlue ([#2708](https://github.com/nvim-tree/nvim-tree.lua/issues/2708)) ([1fd9c98](https://github.com/nvim-tree/nvim-tree.lua/commit/1fd9c98960463d2d5d400916c0633b2df016941d))
|
||||
* bookmark filter should include parent directory ([#2704](https://github.com/nvim-tree/nvim-tree.lua/issues/2704)) ([76b9810](https://github.com/nvim-tree/nvim-tree.lua/commit/76b98109f62caa12b2f1dff472060b2233ea2e90))
|
||||
|
||||
## [1.1.0](https://github.com/nvim-tree/nvim-tree.lua/compare/nvim-tree-v1.0.0...nvim-tree-v1.1.0) (2024-03-14)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **#2630:** file renames can now create directories ([#2657](https://github.com/nvim-tree/nvim-tree.lua/issues/2657)) ([efafd73](https://github.com/nvim-tree/nvim-tree.lua/commit/efafd73efa9bc8c26282aed563ba0f01c7465b06))
|
||||
* add api.fs.copy.basename, default mapping ge ([#2698](https://github.com/nvim-tree/nvim-tree.lua/issues/2698)) ([8f2a50f](https://github.com/nvim-tree/nvim-tree.lua/commit/8f2a50f1cd0c64003042364cf317c8788eaa6c8c))
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **#2695:** git toplevel guard against missing paths ([#2696](https://github.com/nvim-tree/nvim-tree.lua/issues/2696)) ([3c4267e](https://github.com/nvim-tree/nvim-tree.lua/commit/3c4267eb5045fa86b67fe40c0c63d31efc801e77))
|
||||
* searchcount exception on invalid search regex ([#2693](https://github.com/nvim-tree/nvim-tree.lua/issues/2693)) ([041dbd1](https://github.com/nvim-tree/nvim-tree.lua/commit/041dbd18f440207ad161503a384e7c82d575db66))
|
||||
|
||||
## [1.0.0](https://github.com/nvim-tree/nvim-tree.lua/compare/nvim-tree-v0.100.0...nvim-tree-v1.0.0) (2024-02-18)
|
||||
|
||||
|
||||
|
||||
@@ -69,15 +69,43 @@ Once you did, you should run `make help-update`
|
||||
|
||||
# Documentation
|
||||
|
||||
## Opts
|
||||
|
||||
When adding new options, you should declare the defaults in the main `nvim-tree.lua` file.
|
||||
|
||||
Documentation for options should also be added to `nvim-tree-opts` in `doc/nvim-tree-lua.txt`
|
||||
|
||||
## API
|
||||
|
||||
When adding or changing API please update :help nvim-tree-api
|
||||
|
||||
# Pull Request
|
||||
|
||||
Please reference any issues in the description e.g. "resolves #1234".
|
||||
Please reference any issues in the description e.g. "resolves #1234", which will be closed upon merge.
|
||||
|
||||
Please check "allow edits by maintainers" to allow nvim-tree developers to make small changes such as documentation tweaks.
|
||||
|
||||
A test case to reproduce the issue is required. A ["Clean Room" Replication](https://github.com/nvim-tree/nvim-tree.lua/wiki/Troubleshooting#clean-room-replication) is preferred.
|
||||
## Subject
|
||||
|
||||
The merge commit message will be the subject of the PR.
|
||||
|
||||
A [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0) subject will be validated by the Semantic Pull Request Subject CI job. Reference the issue to be used in the release notes e.g.
|
||||
|
||||
`fix(#2395): marks.bulk.move defaults to directory at cursor`
|
||||
|
||||
Available types:
|
||||
* feat: A new feature
|
||||
* fix: A bug fix
|
||||
* docs: Documentation only changes
|
||||
* style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
|
||||
* refactor: A code change that neither fixes a bug nor adds a feature
|
||||
* perf: A code change that improves performance
|
||||
* test: Adding missing tests or correcting existing tests
|
||||
* build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
|
||||
* ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
|
||||
* chore: Other changes that don't modify src or test files
|
||||
* revert: Reverts a previous commit
|
||||
|
||||
If in doubt, look at previous commits.
|
||||
|
||||
See also [The Conventional Commits ultimate cheatsheet](https://gist.github.com/gabrielecanepa/fa6cca1a8ae96f77896fe70ddee65527)
|
||||
|
||||
19
README.md
19
README.md
@@ -24,7 +24,7 @@
|
||||
|
||||
Take a look at the [wiki](https://github.com/nvim-tree/nvim-tree.lua/wiki) for Showcases, Tips, Recipes and more.
|
||||
|
||||
Community support: [matrix](https://matrix.to/#/#nvim-tree:matrix.org)
|
||||
Questions and general support: [Discussions](https://github.com/nvim-tree/nvim-tree.lua/discussions)
|
||||
|
||||
## Requirements
|
||||
|
||||
@@ -112,6 +112,23 @@ require("nvim-tree").setup {
|
||||
}
|
||||
```
|
||||
|
||||
### Highlight
|
||||
|
||||
Run `:NvimTreeHiTest` to show all the highlights that nvim-tree uses.
|
||||
|
||||
They can be customised before or after setup is called and will be immediately
|
||||
applied at runtime. e.g.
|
||||
|
||||
```lua
|
||||
vim.cmd([[
|
||||
:hi NvimTreeExecFile guifg=#ffa0a0
|
||||
:hi NvimTreeSpecialFile guifg=#ff80ff gui=underline
|
||||
:hi NvimTreeSymlink guifg=Yellow gui=italic
|
||||
:hi link NvimTreeImageFile Title
|
||||
]])
|
||||
```
|
||||
See [:help nvim-tree-highlight](doc/nvim-tree-lua.txt) for details.
|
||||
|
||||
## Commands
|
||||
|
||||
See [:help nvim-tree-commands](doc/nvim-tree-lua.txt)
|
||||
|
||||
@@ -48,12 +48,18 @@ CONTENTS *nvim-tree*
|
||||
7. Mappings |nvim-tree-mappings|
|
||||
7.1 Mappings: Default |nvim-tree-mappings-default|
|
||||
8. Highlight |nvim-tree-highlight|
|
||||
8.1 Highlight Default |nvim-tree-highlight-default|
|
||||
8.2 Highlight Overhaul |nvim-tree-highlight-overhaul|
|
||||
8.1 Highlight: Default |nvim-tree-highlight-default|
|
||||
8.2 Highlight: Overhaul |nvim-tree-highlight-overhaul|
|
||||
9. Events |nvim-tree-events|
|
||||
10. Prompts |nvim-tree-prompts|
|
||||
11. OS Specific Restrictions |nvim-tree-os-specific|
|
||||
12. Netrw |nvim-tree-netrw|
|
||||
13. Legacy |nvim-tree-legacy|
|
||||
13.1 Legacy: Opts |nvim-tree-legacy-opts|
|
||||
13.2 Legacy: Highlight |nvim-tree-legacy-highlight|
|
||||
14. Index |nvim-tree-index|
|
||||
14.1 Index: Opts |nvim-tree-index-opts|
|
||||
14.2 Index: API |nvim-tree-index-api|
|
||||
|
||||
==============================================================================
|
||||
1. INTRODUCTION *nvim-tree-introduction*
|
||||
@@ -179,6 +185,7 @@ Show the mappings: `g?`
|
||||
`f` Live Filter: Start |nvim-tree-api.live_filter.start()|
|
||||
`g?` Help |nvim-tree-api.tree.toggle_help()|
|
||||
`gy` Copy Absolute Path |nvim-tree-api.fs.copy.absolute_path()|
|
||||
`ge` Copy Basename |nvim-tree-api.fs.copy.basename()|
|
||||
`H` Toggle Filter: Dotfiles |nvim-tree-api.tree.toggle_hidden_filter()|
|
||||
`I` Toggle Filter: Git Ignore |nvim-tree-api.tree.toggle_gitignore_filter()|
|
||||
`J` Last Sibling |nvim-tree-api.node.navigate.sibling.last()|
|
||||
@@ -238,8 +245,15 @@ via |nvim-tree.on_attach| e.g. >
|
||||
Run |:NvimTreeHiTest| to show all the highlights that nvim-tree uses.
|
||||
|
||||
They can be customised before or after setup is called and will be immediately
|
||||
applied at runtime.
|
||||
applied at runtime. e.g. >
|
||||
|
||||
vim.cmd([[
|
||||
:hi NvimTreeExecFile guifg=#ffa0a0
|
||||
:hi NvimTreeSpecialFile guifg=#ff80ff gui=underline
|
||||
:hi NvimTreeSymlink guifg=Yellow gui=italic
|
||||
:hi link NvimTreeImageFile Title
|
||||
]])
|
||||
<
|
||||
See |nvim-tree-highlight| for details.
|
||||
|
||||
==============================================================================
|
||||
@@ -486,9 +500,12 @@ Following is the default configuration. See |nvim-tree-opts| for details.
|
||||
},
|
||||
update_focused_file = {
|
||||
enable = false,
|
||||
update_root = false,
|
||||
update_root = {
|
||||
enable = false,
|
||||
ignore_list = {},
|
||||
},
|
||||
exclude = false,
|
||||
},
|
||||
system_open = {
|
||||
cmd = "",
|
||||
args = {},
|
||||
@@ -523,6 +540,7 @@ Following is the default configuration. See |nvim-tree-opts| for details.
|
||||
show_on_open_dirs = true,
|
||||
},
|
||||
filters = {
|
||||
enable = true,
|
||||
git_ignored = true,
|
||||
dotfiles = false,
|
||||
git_clean = false,
|
||||
@@ -665,7 +683,7 @@ Prefer startup root directory when updating root directory of the tree.
|
||||
Only relevant when `update_focused_file.update_root` is `true`
|
||||
Type: `boolean`, Default: `false`
|
||||
|
||||
*nvim-tree.sync_root_with_cwd* (previously `update_cwd`)
|
||||
*nvim-tree.sync_root_with_cwd*
|
||||
Changes the tree root directory on `DirChanged` and refreshes the tree.
|
||||
Type: `boolean`, Default: `false`
|
||||
|
||||
@@ -687,7 +705,7 @@ Type: `boolean`, Default: `false`
|
||||
|
||||
File and folder sorting options.
|
||||
|
||||
*nvim-tree.sort.sorter* (previously `sort_by`)
|
||||
*nvim-tree.sort.sorter*
|
||||
Changes how files within the same directory are sorted.
|
||||
Can be one of `"name"`, `"case_sensitive"`, `"modification_time"`, `"extension"`,
|
||||
`"suffix"`, `"filetype"` or a function.
|
||||
@@ -766,7 +784,7 @@ Show |signcolumn|. Value can be `"yes"`, `"auto"`, `"no"`.
|
||||
Width of the window: can be a `%` string, a number representing columns, a
|
||||
function or a table.
|
||||
A table indicates that the view should be dynamically sized based on the
|
||||
longest line (previously `view.adaptive_size`).
|
||||
longest line.
|
||||
Type: `string | number | table | function()` returning a number
|
||||
Default: `30`
|
||||
|
||||
@@ -1086,20 +1104,26 @@ Enable this feature.
|
||||
Type: `boolean`, Default: `false`
|
||||
|
||||
*nvim-tree.update_focused_file.update_root*
|
||||
(previously `update_focused_file.update_cwd`)
|
||||
Update the root directory of the tree if the file is not under current
|
||||
root directory. It prefers vim's cwd and `root_dirs`.
|
||||
Otherwise it falls back to the folder containing the file.
|
||||
Only relevant when `update_focused_file.enable` is `true`
|
||||
|
||||
*nvim-tree.update_focused_file.update_root.enable*
|
||||
Type: `boolean`, Default: `false`
|
||||
|
||||
*nvim-tree.update_focused_file.ignore_list*
|
||||
*nvim-tree.update_focused_file.update_root.ignore_list*
|
||||
List of buffer names and filetypes that will not update the root dir
|
||||
of the tree if the file isn't found under the current root directory.
|
||||
Only relevant when `update_focused_file.update_root` and
|
||||
Only relevant when `update_focused_file.update_root.enable` and
|
||||
`update_focused_file.enable` are `true`.
|
||||
Type: {string}, Default: `{}`
|
||||
|
||||
*nvim-tree.update_focused_file.exclude*
|
||||
A function that returns true if the file should not be focused when opening.
|
||||
Takes the `BufEnter` event as an argument. see |autocmd-events|
|
||||
Type: {function}, Default: `false`
|
||||
|
||||
==============================================================================
|
||||
5.6 OPTS: SYSTEM OPEN *nvim-tree-opts-system-open*
|
||||
|
||||
@@ -1229,7 +1253,12 @@ Only relevant when |modified.show_on_dirs| is `true`.
|
||||
|
||||
File / folder filters that may be toggled.
|
||||
|
||||
*nvim-tree.filters.git_ignored* (previously `git.ignore`)
|
||||
*nvim-tree.filters.enable*
|
||||
Enable / disable all filters including live filter.
|
||||
Toggle via |nvim-tree-api.tree.toggle_enable_filters()|
|
||||
Type: `boolean`, Default: `true`
|
||||
|
||||
*nvim-tree.filters.git_ignored*
|
||||
Ignore files based on `.gitignore`. Requires |git.enable| `= true`
|
||||
Toggle via |nvim-tree-api.tree.toggle_gitignore_filter()|, default `I`
|
||||
Type: `boolean`, Default: `true`
|
||||
@@ -1376,7 +1405,7 @@ Configuration options for opening a file from nvim-tree.
|
||||
Prevent new opened file from opening in the same window as the tree.
|
||||
Type: `boolean`, Default: `true`
|
||||
|
||||
*nvim-tree.actions.open_file.resize_window* (previously `view.auto_resize`)
|
||||
*nvim-tree.actions.open_file.resize_window*
|
||||
Resizes the tree when opening a file.
|
||||
Type: `boolean`, Default: `true`
|
||||
|
||||
@@ -1444,7 +1473,7 @@ Windows default `"trash"` requires `trash-cli` or similar
|
||||
*nvim-tree.tab.sync*
|
||||
Configuration for syncing nvim-tree across tabs.
|
||||
|
||||
*nvim-tree.tab.sync.open* (previously `nvim-tree.open_on_tab`)
|
||||
*nvim-tree.tab.sync.open*
|
||||
Opens the tree automatically when switching tabpage or opening a new
|
||||
tabpage if the tree was previously open.
|
||||
Type: `boolean`, Default: `false`
|
||||
@@ -1453,7 +1482,7 @@ Configuration for syncing nvim-tree across tabs.
|
||||
Closes the tree across all tabpages when the tree is closed.
|
||||
Type: `boolean`, Default: `false`
|
||||
|
||||
*nvim-tree.tab.sync.ignore* (previously `nvim-tree.ignore_buf_on_tab_change`)
|
||||
*nvim-tree.tab.sync.ignore*
|
||||
List of filetypes or buffer names on new tab that will prevent
|
||||
|nvim-tree.tab.sync.open| and |nvim-tree.tab.sync.close|
|
||||
Type: {string}, Default: `{}`
|
||||
@@ -1493,7 +1522,7 @@ Confirmation prompts.
|
||||
Prompt before removing.
|
||||
Type: `boolean`, Default: `true`
|
||||
|
||||
*nvim-tree.ui.confirm.trash* (previously `trash.require_confirm`)
|
||||
*nvim-tree.ui.confirm.trash*
|
||||
Prompt before trashing.
|
||||
Type: `boolean`, Default: `true`
|
||||
|
||||
@@ -1689,6 +1718,10 @@ tree.expand_all() *nvim-tree-api.tree.expand_all()*
|
||||
Recursively expand all nodes in the tree.
|
||||
Folder: only the nodes underneath that folder.
|
||||
|
||||
*nvim-tree-api.tree.toggle_enable_filters()*
|
||||
tree.toggle_enable_filters()
|
||||
Toggle |nvim-tree.filters.enable| all filters.
|
||||
|
||||
*nvim-tree-api.tree.toggle_gitignore_filter()*
|
||||
tree.toggle_gitignore_filter()
|
||||
Toggle |nvim-tree.filters.git_ignored| filter.
|
||||
@@ -2228,6 +2261,7 @@ You are encouraged to copy these to your own |nvim-tree.on_attach| function.
|
||||
vim.keymap.set('n', 'f', api.live_filter.start, opts('Live Filter: Start'))
|
||||
vim.keymap.set('n', 'g?', api.tree.toggle_help, opts('Help'))
|
||||
vim.keymap.set('n', 'gy', api.fs.copy.absolute_path, opts('Copy Absolute Path'))
|
||||
vim.keymap.set('n', 'ge', api.fs.copy.basename, opts('Copy Basename'))
|
||||
vim.keymap.set('n', 'H', api.tree.toggle_hidden_filter, opts('Toggle Filter: Dotfiles'))
|
||||
vim.keymap.set('n', 'I', api.tree.toggle_gitignore_filter, opts('Toggle Filter: Git Ignore'))
|
||||
vim.keymap.set('n', 'J', api.node.navigate.sibling.last, opts('Last Sibling'))
|
||||
@@ -2301,7 +2335,7 @@ To prevent usage of a highlight:
|
||||
`:hi! link NvimTreeExecFile NONE`
|
||||
|
||||
==============================================================================
|
||||
8.1 HIGHLIGHT DEFAULT *nvim-tree-highlight-default*
|
||||
8.1 HIGHLIGHT: DEFAULT *nvim-tree-highlight-default*
|
||||
|
||||
|:highlight-link| `default` or |:highlight-default| define the groups on setup:
|
||||
|
||||
@@ -2419,7 +2453,9 @@ Diagnostics Folder Highlight: >
|
||||
NvimTreeDiagnosticHintFolderHL NvimTreeDiagnosticHintFileHL
|
||||
<
|
||||
==============================================================================
|
||||
8.1 HIGHLIGHT OVERHAUL *nvim-tree-highlight-overhaul*
|
||||
8.2 HIGHLIGHT: OVERHAUL *nvim-tree-highlight-overhaul*
|
||||
|
||||
See |nvim-tree-legacy-highlight| for old highlight group compatibility.
|
||||
|
||||
2024-01-20: significant highlighting changes, some breaking:
|
||||
|
||||
@@ -2444,51 +2480,14 @@ Diagnostics Folder Highlight: >
|
||||
- NvimTreeSpecialFile PreProc -> SpellCap
|
||||
- NvimTreeSymlink Statement -> SpellCap
|
||||
|
||||
Legacy highlight group are still obeyed when they are defined and the current
|
||||
highlight group is not, hard linking as follows: >
|
||||
Approximate pre-overhaul values for the `SpellCap` groups may be set via: >
|
||||
|
||||
NvimTreeModifiedIcon NvimTreeModifiedFile
|
||||
NvimTreeOpenedHL NvimTreeOpenedFile
|
||||
NvimTreeBookmarkIcon NvimTreeBookmark
|
||||
|
||||
NvimTreeGitDeletedIcon NvimTreeGitDeleted
|
||||
NvimTreeGitDirtyIcon NvimTreeGitDirty
|
||||
NvimTreeGitIgnoredIcon NvimTreeGitIgnored
|
||||
NvimTreeGitMergeIcon NvimTreeGitMerge
|
||||
NvimTreeGitNewIcon NvimTreeGitNew
|
||||
NvimTreeGitRenamedIcon NvimTreeGitRenamed
|
||||
NvimTreeGitStagedIcon NvimTreeGitStaged
|
||||
|
||||
NvimTreeGitFileDeletedHL NvimTreeFileDeleted
|
||||
NvimTreeGitFileDirtyHL NvimTreeFileDirty
|
||||
NvimTreeGitFileIgnoredHL NvimTreeFileIgnored
|
||||
NvimTreeGitFileMergeHL NvimTreeFileMerge
|
||||
NvimTreeGitFileNewHL NvimTreeFileNew
|
||||
NvimTreeGitFileRenamedHL NvimTreeFileRenamed
|
||||
NvimTreeGitFileStagedHL NvimTreeFileStaged
|
||||
|
||||
NvimTreeGitFolderDeletedHL NvimTreeFolderDeleted
|
||||
NvimTreeGitFolderDirtyHL NvimTreeFolderDirty
|
||||
NvimTreeGitFolderIgnoredHL NvimTreeFolderIgnored
|
||||
NvimTreeGitFolderMergeHL NvimTreeFolderMerge
|
||||
NvimTreeGitFolderNewHL NvimTreeFolderNew
|
||||
NvimTreeGitFolderRenamedHL NvimTreeFolderRenamed
|
||||
NvimTreeGitFolderStagedHL NvimTreeFolderStaged
|
||||
|
||||
NvimTreeLspDiagnosticsError NvimTreeDiagnosticErrorIcon
|
||||
NvimTreeLspDiagnosticsWarning NvimTreeDiagnosticWarnIcon
|
||||
NvimTreeLspDiagnosticsInformation NvimTreeDiagnosticInfoIcon
|
||||
NvimTreeLspDiagnosticsHint NvimTreeDiagnosticHintIcon
|
||||
|
||||
NvimTreeLspDiagnosticsErrorText NvimTreeDiagnosticErrorFileHL
|
||||
NvimTreeLspDiagnosticsWarningText NvimTreeDiagnosticWarnFileHL
|
||||
NvimTreeLspDiagnosticsInformationText NvimTreeDiagnosticInfoFileHL
|
||||
NvimTreeLspDiagnosticsHintText NvimTreeDiagnosticHintFileHL
|
||||
|
||||
NvimTreeLspDiagnosticsErrorFolderText NvimTreeDiagnosticErrorFolderHL
|
||||
NvimTreeLspDiagnosticsWarningFolderText NvimTreeDiagnosticWarnFolderHL
|
||||
NvimTreeLspDiagnosticsInformationFolderText NvimTreeDiagnosticInfoFolderHL
|
||||
NvimTreeLspDiagnosticsHintFolderText NvimTreeDiagnosticHintFolderHL
|
||||
vim.cmd([[
|
||||
:hi NvimTreeExecFile gui=bold guifg=#ffa0a0
|
||||
:hi NvimTreeSymlink gui=bold guifg=#ffff60
|
||||
:hi NvimTreeSpecialFile gui=bold,underline guifg=#ff80ff
|
||||
:hi NvimTreeImageFile gui=bold guifg=#ff80ff
|
||||
]])
|
||||
<
|
||||
==============================================================================
|
||||
9. EVENTS *nvim-tree-events*
|
||||
@@ -2662,4 +2661,343 @@ keep using |netrw| without its browser features please ensure:
|
||||
|nvim-tree.disable_netrw| `= false`
|
||||
|nvim-tree.hijack_netrw| ` = true`
|
||||
|
||||
==============================================================================
|
||||
13. LEGACY *nvim-tree-legacy*
|
||||
|
||||
Breaking refactors have been made however the legacy versions will be silently
|
||||
migrated and used.
|
||||
There are no plans to remove this migration.
|
||||
|
||||
==============================================================================
|
||||
13.1 LEGACY: OPTS *nvim-tree-legacy-opts*
|
||||
|
||||
Legacy options are translated to the current, making type and value changes as
|
||||
needed.
|
||||
|
||||
`update_cwd` |nvim-tree.sync_root_with_cwd|
|
||||
`update_focused_file.update_cwd` |nvim-tree.update_focused_file.update_root|
|
||||
`open_on_tab` |nvim-tree.tab.sync.open|
|
||||
`ignore_buf_on_tab_change` |nvim-tree.tab.sync.ignore|
|
||||
`renderer.root_folder_modifier` |nvim-tree.renderer.root_folder_label|
|
||||
`update_focused_file.debounce_delay` |nvim-tree.view.debounce_delay|
|
||||
`trash.require_confirm` |nvim-tree.ui.confirm.trash|
|
||||
`view.adaptive_size` |nvim-tree.view.width|
|
||||
`sort_by` |nvim-tree.sort.sorter|
|
||||
`git.ignore` |nvim-tree.filters.git_ignored|
|
||||
`renderer.icons.webdev_colors` |nvim-tree.renderer.icons.web_devicons.file.color|
|
||||
|
||||
==============================================================================
|
||||
13.2 LEGACY: HIGHLIGHT *nvim-tree-legacy-highlight*
|
||||
|
||||
Legacy highlight group are still obeyed when they are defined and the current
|
||||
highlight group is not, hard linking as follows: >
|
||||
|
||||
NvimTreeModifiedIcon NvimTreeModifiedFile
|
||||
NvimTreeOpenedHL NvimTreeOpenedFile
|
||||
NvimTreeBookmarkIcon NvimTreeBookmark
|
||||
|
||||
NvimTreeGitDeletedIcon NvimTreeGitDeleted
|
||||
NvimTreeGitDirtyIcon NvimTreeGitDirty
|
||||
NvimTreeGitIgnoredIcon NvimTreeGitIgnored
|
||||
NvimTreeGitMergeIcon NvimTreeGitMerge
|
||||
NvimTreeGitNewIcon NvimTreeGitNew
|
||||
NvimTreeGitRenamedIcon NvimTreeGitRenamed
|
||||
NvimTreeGitStagedIcon NvimTreeGitStaged
|
||||
|
||||
NvimTreeGitFileDeletedHL NvimTreeFileDeleted
|
||||
NvimTreeGitFileDirtyHL NvimTreeFileDirty
|
||||
NvimTreeGitFileIgnoredHL NvimTreeFileIgnored
|
||||
NvimTreeGitFileMergeHL NvimTreeFileMerge
|
||||
NvimTreeGitFileNewHL NvimTreeFileNew
|
||||
NvimTreeGitFileRenamedHL NvimTreeFileRenamed
|
||||
NvimTreeGitFileStagedHL NvimTreeFileStaged
|
||||
|
||||
NvimTreeGitFolderDeletedHL NvimTreeFolderDeleted
|
||||
NvimTreeGitFolderDirtyHL NvimTreeFolderDirty
|
||||
NvimTreeGitFolderIgnoredHL NvimTreeFolderIgnored
|
||||
NvimTreeGitFolderMergeHL NvimTreeFolderMerge
|
||||
NvimTreeGitFolderNewHL NvimTreeFolderNew
|
||||
NvimTreeGitFolderRenamedHL NvimTreeFolderRenamed
|
||||
NvimTreeGitFolderStagedHL NvimTreeFolderStaged
|
||||
|
||||
NvimTreeLspDiagnosticsError NvimTreeDiagnosticErrorIcon
|
||||
NvimTreeLspDiagnosticsWarning NvimTreeDiagnosticWarnIcon
|
||||
NvimTreeLspDiagnosticsInformation NvimTreeDiagnosticInfoIcon
|
||||
NvimTreeLspDiagnosticsHint NvimTreeDiagnosticHintIcon
|
||||
|
||||
NvimTreeLspDiagnosticsErrorText NvimTreeDiagnosticErrorFileHL
|
||||
NvimTreeLspDiagnosticsWarningText NvimTreeDiagnosticWarnFileHL
|
||||
NvimTreeLspDiagnosticsInformationText NvimTreeDiagnosticInfoFileHL
|
||||
NvimTreeLspDiagnosticsHintText NvimTreeDiagnosticHintFileHL
|
||||
|
||||
NvimTreeLspDiagnosticsErrorFolderText NvimTreeDiagnosticErrorFolderHL
|
||||
NvimTreeLspDiagnosticsWarningFolderText NvimTreeDiagnosticWarnFolderHL
|
||||
NvimTreeLspDiagnosticsInformationFolderText NvimTreeDiagnosticInfoFolderHL
|
||||
NvimTreeLspDiagnosticsHintFolderText NvimTreeDiagnosticHintFolderHL
|
||||
<
|
||||
==============================================================================
|
||||
14 INDEX *nvim-tree-index*
|
||||
|
||||
==============================================================================
|
||||
14.1 INDEX: OPTS *nvim-tree-index-opts*
|
||||
|
||||
|nvim-tree.actions.change_dir|
|
||||
|nvim-tree.actions.change_dir.enable|
|
||||
|nvim-tree.actions.change_dir.global|
|
||||
|nvim-tree.actions.change_dir.restrict_above_cwd|
|
||||
|nvim-tree.actions.expand_all|
|
||||
|nvim-tree.actions.expand_all.exclude|
|
||||
|nvim-tree.actions.expand_all.max_folder_discovery|
|
||||
|nvim-tree.actions.file_popup|
|
||||
|nvim-tree.actions.file_popup.open_win_config|
|
||||
|nvim-tree.actions.open_file|
|
||||
|nvim-tree.actions.open_file.eject|
|
||||
|nvim-tree.actions.open_file.quit_on_open|
|
||||
|nvim-tree.actions.open_file.resize_window|
|
||||
|nvim-tree.actions.open_file.window_picker|
|
||||
|nvim-tree.actions.open_file.window_picker.chars|
|
||||
|nvim-tree.actions.open_file.window_picker.enable|
|
||||
|nvim-tree.actions.open_file.window_picker.exclude|
|
||||
|nvim-tree.actions.open_file.window_picker.picker|
|
||||
|nvim-tree.actions.remove_file.close_window|
|
||||
|nvim-tree.actions.use_system_clipboard|
|
||||
|nvim-tree.auto_reload_on_write|
|
||||
|nvim-tree.diagnostics.debounce_delay|
|
||||
|nvim-tree.diagnostics.enable|
|
||||
|nvim-tree.diagnostics.icons|
|
||||
|nvim-tree.diagnostics.severity|
|
||||
|nvim-tree.diagnostics.severity.max|
|
||||
|nvim-tree.diagnostics.severity.min|
|
||||
|nvim-tree.diagnostics.show_on_dirs|
|
||||
|nvim-tree.diagnostics.show_on_open_dirs|
|
||||
|nvim-tree.disable_netrw|
|
||||
|nvim-tree.experimental|
|
||||
|nvim-tree.filesystem_watchers.debounce_delay|
|
||||
|nvim-tree.filesystem_watchers.enable|
|
||||
|nvim-tree.filesystem_watchers.ignore_dirs|
|
||||
|nvim-tree.filters.custom|
|
||||
|nvim-tree.filters.dotfiles|
|
||||
|nvim-tree.filters.enable|
|
||||
|nvim-tree.filters.exclude|
|
||||
|nvim-tree.filters.git_clean|
|
||||
|nvim-tree.filters.git_ignored|
|
||||
|nvim-tree.filters.no_bookmark|
|
||||
|nvim-tree.filters.no_buffer|
|
||||
|nvim-tree.git.cygwin_support|
|
||||
|nvim-tree.git.disable_for_dirs|
|
||||
|nvim-tree.git.enable|
|
||||
|nvim-tree.git.show_on_dirs|
|
||||
|nvim-tree.git.show_on_open_dirs|
|
||||
|nvim-tree.git.timeout|
|
||||
|nvim-tree.help.sort_by|
|
||||
|nvim-tree.hijack_cursor|
|
||||
|nvim-tree.hijack_directories.auto_open|
|
||||
|nvim-tree.hijack_directories.enable|
|
||||
|nvim-tree.hijack_netrw|
|
||||
|nvim-tree.hijack_unnamed_buffer_when_opening|
|
||||
|nvim-tree.live_filter.always_show_folders|
|
||||
|nvim-tree.live_filter.prefix|
|
||||
|nvim-tree.log.enable|
|
||||
|nvim-tree.log.truncate|
|
||||
|nvim-tree.log.types|
|
||||
|nvim-tree.log.types.all|
|
||||
|nvim-tree.log.types.config|
|
||||
|nvim-tree.log.types.copy_paste|
|
||||
|nvim-tree.log.types.dev|
|
||||
|nvim-tree.log.types.diagnostics|
|
||||
|nvim-tree.log.types.git|
|
||||
|nvim-tree.log.types.profile|
|
||||
|nvim-tree.log.types.watcher|
|
||||
|nvim-tree.modified.enable|
|
||||
|nvim-tree.modified.show_on_dirs|
|
||||
|nvim-tree.modified.show_on_open_dirs|
|
||||
|nvim-tree.notify.threshold|
|
||||
|nvim-tree.on_attach|
|
||||
|nvim-tree.prefer_startup_root|
|
||||
|nvim-tree.reload_on_bufenter|
|
||||
|nvim-tree.renderer.add_trailing|
|
||||
|nvim-tree.renderer.full_name|
|
||||
|nvim-tree.renderer.group_empty|
|
||||
|nvim-tree.renderer.highlight_bookmarks|
|
||||
|nvim-tree.renderer.highlight_clipboard|
|
||||
|nvim-tree.renderer.highlight_diagnostics|
|
||||
|nvim-tree.renderer.highlight_git|
|
||||
|nvim-tree.renderer.highlight_modified|
|
||||
|nvim-tree.renderer.highlight_opened_files|
|
||||
|nvim-tree.renderer.icons|
|
||||
|nvim-tree.renderer.icons.bookmarks_placement|
|
||||
|nvim-tree.renderer.icons.diagnostics_placement|
|
||||
|nvim-tree.renderer.icons.git_placement|
|
||||
|nvim-tree.renderer.icons.glyphs|
|
||||
|nvim-tree.renderer.icons.glyphs.default|
|
||||
|nvim-tree.renderer.icons.glyphs.folder|
|
||||
|nvim-tree.renderer.icons.glyphs.git|
|
||||
|nvim-tree.renderer.icons.glyphs.modified|
|
||||
|nvim-tree.renderer.icons.glyphs.symlink|
|
||||
|nvim-tree.renderer.icons.modified_placement|
|
||||
|nvim-tree.renderer.icons.padding|
|
||||
|nvim-tree.renderer.icons.show|
|
||||
|nvim-tree.renderer.icons.show.bookmarks|
|
||||
|nvim-tree.renderer.icons.show.diagnostics|
|
||||
|nvim-tree.renderer.icons.show.file|
|
||||
|nvim-tree.renderer.icons.show.folder|
|
||||
|nvim-tree.renderer.icons.show.folder_arrow|
|
||||
|nvim-tree.renderer.icons.show.git|
|
||||
|nvim-tree.renderer.icons.show.modified|
|
||||
|nvim-tree.renderer.icons.symlink_arrow|
|
||||
|nvim-tree.renderer.icons.web_devicons|
|
||||
|nvim-tree.renderer.icons.web_devicons.file|
|
||||
|nvim-tree.renderer.icons.web_devicons.file.color|
|
||||
|nvim-tree.renderer.icons.web_devicons.file.enable|
|
||||
|nvim-tree.renderer.icons.web_devicons.folder|
|
||||
|nvim-tree.renderer.icons.web_devicons.folder.color|
|
||||
|nvim-tree.renderer.icons.web_devicons.folder.enable|
|
||||
|nvim-tree.renderer.indent_markers|
|
||||
|nvim-tree.renderer.indent_markers.enable|
|
||||
|nvim-tree.renderer.indent_markers.icons|
|
||||
|nvim-tree.renderer.indent_markers.inline_arrows|
|
||||
|nvim-tree.renderer.indent_width|
|
||||
|nvim-tree.renderer.root_folder_label|
|
||||
|nvim-tree.renderer.special_files|
|
||||
|nvim-tree.renderer.symlink_destination|
|
||||
|nvim-tree.respect_buf_cwd|
|
||||
|nvim-tree.root_dirs|
|
||||
|nvim-tree.select_prompts|
|
||||
|nvim-tree.sort.files_first|
|
||||
|nvim-tree.sort.folders_first|
|
||||
|nvim-tree.sort.sorter|
|
||||
|nvim-tree.sync_root_with_cwd|
|
||||
|nvim-tree.system_open.args|
|
||||
|nvim-tree.system_open.cmd|
|
||||
|nvim-tree.tab.sync|
|
||||
|nvim-tree.tab.sync.close|
|
||||
|nvim-tree.tab.sync.ignore|
|
||||
|nvim-tree.tab.sync.open|
|
||||
|nvim-tree.trash.cmd|
|
||||
|nvim-tree.ui.confirm|
|
||||
|nvim-tree.ui.confirm.default_yes|
|
||||
|nvim-tree.ui.confirm.remove|
|
||||
|nvim-tree.ui.confirm.trash|
|
||||
|nvim-tree.update_focused_file.enable|
|
||||
|nvim-tree.update_focused_file.exclude|
|
||||
|nvim-tree.update_focused_file.update_root|
|
||||
|nvim-tree.update_focused_file.update_root.enable|
|
||||
|nvim-tree.update_focused_file.update_root.ignore_list|
|
||||
|nvim-tree.view.centralize_selection|
|
||||
|nvim-tree.view.cursorline|
|
||||
|nvim-tree.view.debounce_delay|
|
||||
|nvim-tree.view.float|
|
||||
|nvim-tree.view.float.enable|
|
||||
|nvim-tree.view.float.open_win_config|
|
||||
|nvim-tree.view.float.quit_on_focus_loss|
|
||||
|nvim-tree.view.number|
|
||||
|nvim-tree.view.preserve_window_proportions|
|
||||
|nvim-tree.view.relativenumber|
|
||||
|nvim-tree.view.side|
|
||||
|nvim-tree.view.signcolumn|
|
||||
|nvim-tree.view.width|
|
||||
|nvim-tree.view.width.max|
|
||||
|nvim-tree.view.width.min|
|
||||
|nvim-tree.view.width.padding|
|
||||
|
||||
==============================================================================
|
||||
14.2 INDEX: API *nvim-tree-index-api*
|
||||
|
||||
|nvim-tree-api.commands.get()|
|
||||
|nvim-tree-api.config.mappings.default_on_attach()|
|
||||
|nvim-tree-api.config.mappings.get_keymap()|
|
||||
|nvim-tree-api.config.mappings.get_keymap_default()|
|
||||
|nvim-tree-api.diagnostics.hi_test()|
|
||||
|nvim-tree-api.events.subscribe()|
|
||||
|nvim-tree-api.fs.clear_clipboard()|
|
||||
|nvim-tree-api.fs.copy.absolute_path()|
|
||||
|nvim-tree-api.fs.copy.filename()|
|
||||
|nvim-tree-api.fs.copy.node()|
|
||||
|nvim-tree-api.fs.copy.relative_path()|
|
||||
|nvim-tree-api.fs.create()|
|
||||
|nvim-tree-api.fs.cut()|
|
||||
|nvim-tree-api.fs.paste()|
|
||||
|nvim-tree-api.fs.print_clipboard()|
|
||||
|nvim-tree-api.fs.remove()|
|
||||
|nvim-tree-api.fs.rename()|
|
||||
|nvim-tree-api.fs.rename_basename()|
|
||||
|nvim-tree-api.fs.rename_full()|
|
||||
|nvim-tree-api.fs.rename_node()|
|
||||
|nvim-tree-api.fs.rename_sub()|
|
||||
|nvim-tree-api.fs.trash()|
|
||||
|nvim-tree-api.git.reload()|
|
||||
|nvim-tree-api.live_filter.clear()|
|
||||
|nvim-tree-api.live_filter.start()|
|
||||
|nvim-tree-api.marks.bulk.delete()|
|
||||
|nvim-tree-api.marks.bulk.move()|
|
||||
|nvim-tree-api.marks.bulk.trash()|
|
||||
|nvim-tree-api.marks.clear()|
|
||||
|nvim-tree-api.marks.get()|
|
||||
|nvim-tree-api.marks.list()|
|
||||
|nvim-tree-api.marks.navigate.next()|
|
||||
|nvim-tree-api.marks.navigate.prev()|
|
||||
|nvim-tree-api.marks.navigate.select()|
|
||||
|nvim-tree-api.marks.toggle()|
|
||||
|nvim-tree-api.node.navigate.diagnostics.next()|
|
||||
|nvim-tree-api.node.navigate.diagnostics.next_recursive()|
|
||||
|nvim-tree-api.node.navigate.diagnostics.prev()|
|
||||
|nvim-tree-api.node.navigate.diagnostics.prev_recursive()|
|
||||
|nvim-tree-api.node.navigate.git.next()|
|
||||
|nvim-tree-api.node.navigate.git.next_recursive()|
|
||||
|nvim-tree-api.node.navigate.git.next_skip_gitignored()|
|
||||
|nvim-tree-api.node.navigate.git.prev()|
|
||||
|nvim-tree-api.node.navigate.git.prev_recursive()|
|
||||
|nvim-tree-api.node.navigate.git.prev_skip_gitignored()|
|
||||
|nvim-tree-api.node.navigate.opened.next()|
|
||||
|nvim-tree-api.node.navigate.opened.prev()|
|
||||
|nvim-tree-api.node.navigate.parent()|
|
||||
|nvim-tree-api.node.navigate.parent_close()|
|
||||
|nvim-tree-api.node.navigate.sibling.first()|
|
||||
|nvim-tree-api.node.navigate.sibling.last()|
|
||||
|nvim-tree-api.node.navigate.sibling.next()|
|
||||
|nvim-tree-api.node.navigate.sibling.prev()|
|
||||
|nvim-tree-api.node.open.drop()|
|
||||
|nvim-tree-api.node.open.edit()|
|
||||
|nvim-tree-api.node.open.horizontal()|
|
||||
|nvim-tree-api.node.open.no_window_picker()|
|
||||
|nvim-tree-api.node.open.preview()|
|
||||
|nvim-tree-api.node.open.preview_no_picker()|
|
||||
|nvim-tree-api.node.open.replace_tree_buffer()|
|
||||
|nvim-tree-api.node.open.tab()|
|
||||
|nvim-tree-api.node.open.tab_drop()|
|
||||
|nvim-tree-api.node.open.toggle_group_empty()|
|
||||
|nvim-tree-api.node.open.vertical()|
|
||||
|nvim-tree-api.node.run.cmd()|
|
||||
|nvim-tree-api.node.run.system()|
|
||||
|nvim-tree-api.node.show_info_popup()|
|
||||
|nvim-tree-api.tree.change_root()|
|
||||
|nvim-tree-api.tree.change_root_to_node()|
|
||||
|nvim-tree-api.tree.change_root_to_parent()|
|
||||
|nvim-tree-api.tree.close()|
|
||||
|nvim-tree-api.tree.close_in_all_tabs()|
|
||||
|nvim-tree-api.tree.close_in_this_tab()|
|
||||
|nvim-tree-api.tree.collapse_all()|
|
||||
|nvim-tree-api.tree.expand_all()|
|
||||
|nvim-tree-api.tree.find_file()|
|
||||
|nvim-tree-api.tree.focus()|
|
||||
|nvim-tree-api.tree.get_nodes()|
|
||||
|nvim-tree-api.tree.get_node_under_cursor()|
|
||||
|nvim-tree-api.tree.is_tree_buf()|
|
||||
|nvim-tree-api.tree.is_visible()|
|
||||
|nvim-tree-api.tree.open()|
|
||||
|nvim-tree-api.tree.reload()|
|
||||
|nvim-tree-api.tree.search_node()|
|
||||
|nvim-tree-api.tree.toggle()|
|
||||
|nvim-tree-api.tree.toggle_custom_filter()|
|
||||
|nvim-tree-api.tree.toggle_enable_filters()|
|
||||
|nvim-tree-api.tree.toggle_git_clean_filter()|
|
||||
|nvim-tree-api.tree.toggle_gitignore_filter()|
|
||||
|nvim-tree-api.tree.toggle_help()|
|
||||
|nvim-tree-api.tree.toggle_hidden_filter()|
|
||||
|nvim-tree-api.tree.toggle_no_bookmark_filter()|
|
||||
|nvim-tree-api.tree.toggle_no_buffer_filter()|
|
||||
|nvim-tree-api.tree.winid()|
|
||||
|
||||
==============================================================================
|
||||
|
||||
vim:tw=78:ts=4:sw=4:et:ft=help:norl:
|
||||
|
||||
@@ -27,7 +27,7 @@ function M.change_root(path, bufnr)
|
||||
-- skip if current file is in ignore_list
|
||||
if type(bufnr) == "number" then
|
||||
local ft = vim.api.nvim_buf_get_option(bufnr, "filetype") or ""
|
||||
for _, value in pairs(_config.update_focused_file.ignore_list) do
|
||||
for _, value in pairs(_config.update_focused_file.update_root.ignore_list) do
|
||||
if utils.str_find(path, value) or utils.str_find(ft, value) then
|
||||
return
|
||||
end
|
||||
@@ -105,8 +105,8 @@ function M.open_on_directory()
|
||||
end
|
||||
|
||||
function M.place_cursor_on_node()
|
||||
local search = vim.fn.searchcount()
|
||||
if search and search.exact_match == 1 then
|
||||
local ok, search = pcall(vim.fn.searchcount)
|
||||
if ok and search and search.exact_match == 1 then
|
||||
return
|
||||
end
|
||||
|
||||
@@ -149,7 +149,7 @@ function M.change_dir(name)
|
||||
actions.root.change_dir.fn(name)
|
||||
end
|
||||
|
||||
if _config.update_focused_file.enable then
|
||||
if _config.update_focused_file.update_root.enable then
|
||||
actions.tree.find_file.fn()
|
||||
end
|
||||
end
|
||||
@@ -247,7 +247,11 @@ local function setup_autocommands(opts)
|
||||
end
|
||||
if opts.update_focused_file.enable then
|
||||
create_nvim_tree_autocmd("BufEnter", {
|
||||
callback = function()
|
||||
callback = function(event)
|
||||
local exclude = opts.update_focused_file.exclude
|
||||
if type(exclude) == "function" and exclude(event) then
|
||||
return
|
||||
end
|
||||
utils.debounce("BufEnter:find_file", opts.view.debounce_delay, function()
|
||||
actions.tree.find_file.fn()
|
||||
end)
|
||||
@@ -462,9 +466,12 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
|
||||
},
|
||||
update_focused_file = {
|
||||
enable = false,
|
||||
update_root = false,
|
||||
update_root = {
|
||||
enable = false,
|
||||
ignore_list = {},
|
||||
},
|
||||
exclude = false,
|
||||
},
|
||||
system_open = {
|
||||
cmd = "",
|
||||
args = {},
|
||||
@@ -499,6 +506,7 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
|
||||
show_on_open_dirs = true,
|
||||
},
|
||||
filters = {
|
||||
enable = true,
|
||||
git_ignored = true,
|
||||
dotfiles = false,
|
||||
git_clean = false,
|
||||
@@ -623,6 +631,9 @@ local ACCEPTED_TYPES = {
|
||||
group_empty = { "boolean", "function" },
|
||||
root_folder_label = { "function", "string", "boolean" },
|
||||
},
|
||||
update_focused_file = {
|
||||
exclude = { "function" },
|
||||
},
|
||||
filters = {
|
||||
custom = { "function" },
|
||||
},
|
||||
|
||||
@@ -36,12 +36,13 @@ local function search(search_dir, input_path)
|
||||
while name do
|
||||
path = dir .. "/" .. name
|
||||
|
||||
---@type uv.fs_stat.result|nil
|
||||
stat, _ = vim.loop.fs_stat(path)
|
||||
if not stat then
|
||||
break
|
||||
end
|
||||
|
||||
if not filters.should_filter(path, filter_status) then
|
||||
if not filters.should_filter(path, stat, filter_status) then
|
||||
if string.find(path, "/" .. input_path .. "$") then
|
||||
return path
|
||||
end
|
||||
|
||||
@@ -276,17 +276,24 @@ end
|
||||
---@param content string
|
||||
local function copy_to_clipboard(content)
|
||||
local clipboard_name
|
||||
local reg
|
||||
if M.config.actions.use_system_clipboard == true then
|
||||
vim.fn.setreg("+", content)
|
||||
vim.fn.setreg('"', content)
|
||||
clipboard_name = "system"
|
||||
reg = "+"
|
||||
else
|
||||
vim.fn.setreg('"', content)
|
||||
vim.fn.setreg("1", content)
|
||||
clipboard_name = "neovim"
|
||||
reg = "1"
|
||||
end
|
||||
|
||||
vim.api.nvim_exec_autocmds("TextYankPost", {})
|
||||
-- manually firing TextYankPost does not set vim.v.event
|
||||
-- workaround: create a scratch buffer with the clipboard contents and send a yank command
|
||||
local temp_buf = vim.api.nvim_create_buf(false, true)
|
||||
vim.api.nvim_buf_set_text(temp_buf, 0, 0, 0, 0, { content })
|
||||
vim.api.nvim_buf_call(temp_buf, function()
|
||||
vim.cmd(string.format('normal! "%sy$', reg))
|
||||
end)
|
||||
vim.api.nvim_buf_delete(temp_buf, {})
|
||||
|
||||
notify.info(string.format("Copied %s to %s clipboard!", content, clipboard_name))
|
||||
end
|
||||
|
||||
@@ -295,6 +302,12 @@ function M.copy_filename(node)
|
||||
copy_to_clipboard(node.name)
|
||||
end
|
||||
|
||||
---@param node Node
|
||||
function M.copy_basename(node)
|
||||
local basename = vim.fn.fnamemodify(node.name, ":r")
|
||||
copy_to_clipboard(basename)
|
||||
end
|
||||
|
||||
---@param node Node
|
||||
function M.copy_path(node)
|
||||
local absolute_path = node.absolute_path
|
||||
|
||||
@@ -9,6 +9,16 @@ local M = {
|
||||
config = {},
|
||||
}
|
||||
|
||||
---@param iter function iterable
|
||||
---@return integer
|
||||
local function get_num_nodes(iter)
|
||||
local i = 0
|
||||
for _ in iter do
|
||||
i = i + 1
|
||||
end
|
||||
return i
|
||||
end
|
||||
|
||||
local ALLOWED_MODIFIERS = {
|
||||
[":p"] = true,
|
||||
[":p:h"] = true,
|
||||
@@ -31,16 +41,47 @@ function M.rename(node, to)
|
||||
return
|
||||
end
|
||||
|
||||
-- create a folder for each path element if the folder does not exist
|
||||
local idx = 0
|
||||
local path_to_create = ""
|
||||
|
||||
local num_nodes = get_num_nodes(utils.path_split(utils.path_remove_trailing(to)))
|
||||
local is_error = false
|
||||
for path in utils.path_split(to) do
|
||||
idx = idx + 1
|
||||
|
||||
local p = utils.path_remove_trailing(path)
|
||||
if #path_to_create == 0 and vim.fn.has "win32" == 1 then
|
||||
path_to_create = utils.path_join { p, path_to_create }
|
||||
else
|
||||
path_to_create = utils.path_join { path_to_create, p }
|
||||
end
|
||||
|
||||
if idx == num_nodes then
|
||||
events._dispatch_will_rename_node(node.absolute_path, to)
|
||||
local success, err = vim.loop.fs_rename(node.absolute_path, to)
|
||||
|
||||
if not success then
|
||||
notify.warn(err_fmt(notify_from, notify_to, err))
|
||||
return
|
||||
end
|
||||
elseif not utils.file_exists(path_to_create) then
|
||||
local success = vim.loop.fs_mkdir(path_to_create, 493)
|
||||
if not success then
|
||||
notify.error("Could not create folder " .. notify.render_path(path_to_create))
|
||||
is_error = true
|
||||
break
|
||||
end
|
||||
is_error = false
|
||||
end
|
||||
end
|
||||
|
||||
if not is_error then
|
||||
notify.info(string.format("%s -> %s", notify_from, notify_to))
|
||||
utils.rename_loaded_buffers(node.absolute_path, to)
|
||||
events._dispatch_node_renamed(node.absolute_path, to)
|
||||
end
|
||||
end
|
||||
|
||||
---@param default_modifier string|nil
|
||||
---@return fun(node: Node, modifier: string)
|
||||
|
||||
@@ -42,7 +42,7 @@ function M.remove(node)
|
||||
-- trashes a path (file or folder)
|
||||
local function trash_path(on_exit)
|
||||
local need_sync_wait = utils.is_windows
|
||||
local job = vim.fn.jobstart(M.config.trash.cmd .. ' "' .. node.absolute_path .. '"', {
|
||||
local job = vim.fn.jobstart(M.config.trash.cmd .. " " .. vim.fn.shellescape(node.absolute_path), {
|
||||
detach = not need_sync_wait,
|
||||
on_exit = on_exit,
|
||||
on_stderr = on_stderr,
|
||||
|
||||
@@ -6,6 +6,14 @@ local M = {}
|
||||
---@return table
|
||||
local function get_formatted_lines(node)
|
||||
local stats = node.fs_stat
|
||||
if stats == nil then
|
||||
return {
|
||||
"",
|
||||
" Can't retrieve file information",
|
||||
"",
|
||||
}
|
||||
end
|
||||
|
||||
local fpath = " fullpath: " .. node.absolute_path
|
||||
local created_at = " created: " .. os.date("%x %X", stats.birthtime.sec)
|
||||
local modified_at = " modified: " .. os.date("%x %X", stats.mtime.sec)
|
||||
|
||||
@@ -268,13 +268,14 @@ local function open_in_new_window(filename, mode)
|
||||
local fname = vim.fn.fnameescape(filename)
|
||||
fname = utils.escape_special_chars(fname)
|
||||
|
||||
local cmd
|
||||
local command
|
||||
if create_new_window then
|
||||
cmd = string.format("%s vsplit %s", new_window_side, fname)
|
||||
-- generated from vim.api.nvim_parse_cmd("belowright vsplit foo", {})
|
||||
command = { cmd = "vsplit", mods = { split = new_window_side }, args = { fname } }
|
||||
elseif mode:match "split$" then
|
||||
cmd = string.format("%s %s", mode, fname)
|
||||
command = { cmd = mode, args = { fname } }
|
||||
else
|
||||
cmd = string.format("edit %s", fname)
|
||||
command = { cmd = "edit", args = { fname } }
|
||||
end
|
||||
|
||||
if (mode == "preview" or mode == "preview_no_picker") and view.View.float.enable then
|
||||
@@ -286,7 +287,7 @@ local function open_in_new_window(filename, mode)
|
||||
set_current_win_no_autocmd(target_winid, { "BufEnter" })
|
||||
end
|
||||
|
||||
pcall(vim.cmd, cmd)
|
||||
pcall(vim.cmd, command)
|
||||
lib.set_target_win()
|
||||
end
|
||||
|
||||
|
||||
@@ -55,7 +55,7 @@ function M.fn(opts)
|
||||
end
|
||||
|
||||
-- update root
|
||||
if opts.update_root or M.config.update_focused_file.update_root then
|
||||
if opts.update_root or M.config.update_focused_file.update_root.enable then
|
||||
require("nvim-tree").change_root(path, bufnr)
|
||||
end
|
||||
|
||||
|
||||
@@ -41,4 +41,9 @@ function M.dotfiles()
|
||||
reload()
|
||||
end
|
||||
|
||||
function M.enable()
|
||||
filters.config.enable = not filters.config.enable
|
||||
reload()
|
||||
end
|
||||
|
||||
return M
|
||||
|
||||
@@ -128,6 +128,7 @@ Api.tree.find_file = wrap(actions.tree.find_file.fn)
|
||||
Api.tree.search_node = wrap(actions.finders.search_node.fn)
|
||||
Api.tree.collapse_all = wrap(actions.tree.modifiers.collapse_all.fn)
|
||||
Api.tree.expand_all = wrap_node(actions.tree.modifiers.expand_all.fn)
|
||||
Api.tree.toggle_enable_filters = wrap(actions.tree.modifiers.toggles.enable)
|
||||
Api.tree.toggle_gitignore_filter = wrap(actions.tree.modifiers.toggles.git_ignored)
|
||||
Api.tree.toggle_git_clean_filter = wrap(actions.tree.modifiers.toggles.git_clean)
|
||||
Api.tree.toggle_no_buffer_filter = wrap(actions.tree.modifiers.toggles.no_buffer)
|
||||
@@ -163,6 +164,7 @@ Api.fs.print_clipboard = wrap(actions.fs.copy_paste.print_clipboard)
|
||||
Api.fs.copy.node = wrap_node(actions.fs.copy_paste.copy)
|
||||
Api.fs.copy.absolute_path = wrap_node(actions.fs.copy_paste.copy_absolute_path)
|
||||
Api.fs.copy.filename = wrap_node(actions.fs.copy_paste.copy_filename)
|
||||
Api.fs.copy.basename = wrap_node(actions.fs.copy_paste.copy_basename)
|
||||
Api.fs.copy.relative_path = wrap_node(actions.fs.copy_paste.copy_path)
|
||||
|
||||
---@param mode string
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
local appearance = require "nvim-tree.appearance"
|
||||
|
||||
-- others with name and links less than this arbitrary value are short
|
||||
local SHORT_LEN = 50
|
||||
|
||||
local M = {}
|
||||
|
||||
---@class HighlightDisplay for :NvimTreeHiTest
|
||||
@@ -8,7 +11,7 @@ local M = {}
|
||||
---@field def string :hi concrete definition after following any links
|
||||
local HighlightDisplay = {}
|
||||
|
||||
---@param group string nvim-tree highlight group
|
||||
---@param group string nvim-tree highlight group name
|
||||
---@return HighlightDisplay
|
||||
function HighlightDisplay:new(group)
|
||||
local o = {}
|
||||
@@ -39,38 +42,91 @@ function HighlightDisplay:new(group)
|
||||
return o
|
||||
end
|
||||
|
||||
---Render one group.
|
||||
---@param bufnr number to render in
|
||||
---@param fmt string format string for group, links, def
|
||||
---@param l number line number to render at
|
||||
---@return number l next line number
|
||||
function HighlightDisplay:render(bufnr, fmt, l)
|
||||
local text = string.format(fmt, self.group, self.links, self.def)
|
||||
|
||||
vim.api.nvim_buf_set_lines(bufnr, l, -1, true, { text })
|
||||
vim.api.nvim_buf_add_highlight(bufnr, -1, self.group, l, 0, #self.group)
|
||||
|
||||
return l + 1
|
||||
end
|
||||
|
||||
---Run a test similar to :so $VIMRUNTIME/syntax/hitest.vim
|
||||
---Display all nvim-tree highlight groups, their link chain and actual definition
|
||||
function M.hi_test()
|
||||
local displays = {}
|
||||
---Render many groups.
|
||||
---@param header string before with underline line
|
||||
---@param displays HighlightDisplay[] highlight group
|
||||
---@param bufnr number to render in
|
||||
---@param l number line number to start at
|
||||
---@return number l next line number
|
||||
local function render_displays(header, displays, bufnr, l)
|
||||
local max_group_len = 0
|
||||
local max_links_len = 0
|
||||
|
||||
-- build all highlight groups, name only
|
||||
for _, highlight_group in ipairs(appearance.HIGHLIGHT_GROUPS) do
|
||||
local display = HighlightDisplay:new(highlight_group.group)
|
||||
table.insert(displays, display)
|
||||
-- build all highlight groups, using name only
|
||||
for _, display in ipairs(displays) do
|
||||
max_group_len = math.max(max_group_len, #display.group)
|
||||
max_links_len = math.max(max_links_len, #display.links)
|
||||
end
|
||||
|
||||
-- header
|
||||
vim.api.nvim_buf_set_lines(bufnr, l, -1, true, { header, (header:gsub(".", "-")) })
|
||||
l = l + 2
|
||||
|
||||
-- render and highlight
|
||||
local fmt = string.format("%%-%d.%ds %%-%d.%ds %%s", max_group_len, max_group_len, max_links_len, max_links_len)
|
||||
for _, display in ipairs(displays) do
|
||||
l = display:render(bufnr, fmt, l)
|
||||
end
|
||||
|
||||
return l
|
||||
end
|
||||
|
||||
---Run a test similar to :so $VIMRUNTIME/syntax/hitest.vim
|
||||
---Display all nvim-tree and neovim highlight groups, their link chain and actual definition
|
||||
function M.hi_test()
|
||||
-- create a buffer
|
||||
local bufnr = vim.api.nvim_create_buf(false, true)
|
||||
|
||||
-- render and highlight
|
||||
local l = 0
|
||||
local fmt = string.format("%%-%d.%ds %%-%d.%ds %%s", max_group_len, max_group_len, max_links_len, max_links_len)
|
||||
for _, display in ipairs(displays) do
|
||||
display:render(bufnr, fmt, l)
|
||||
l = l + 1
|
||||
|
||||
-- nvim-tree groups, ordered
|
||||
local displays = {}
|
||||
for _, highlight_group in ipairs(appearance.HIGHLIGHT_GROUPS) do
|
||||
local display = HighlightDisplay:new(highlight_group.group)
|
||||
table.insert(displays, display)
|
||||
end
|
||||
l = render_displays("nvim-tree", displays, bufnr, l)
|
||||
|
||||
vim.api.nvim_buf_set_lines(bufnr, l, -1, true, { "" })
|
||||
l = l + 1
|
||||
|
||||
-- built in groups, ordered opaquely by nvim
|
||||
local displays_short, displays_long = {}, {}
|
||||
local ok, out = pcall(vim.api.nvim_cmd, { cmd = "highlight" }, { output = true })
|
||||
if ok then
|
||||
for group in string.gmatch(out, "(%w*)%s+xxx") do
|
||||
if group:find("NvimTree", 1, true) ~= 1 then
|
||||
local display = HighlightDisplay:new(group)
|
||||
if #display.group + #display.links > SHORT_LEN then
|
||||
table.insert(displays_long, display)
|
||||
else
|
||||
table.insert(displays_short, display)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
-- short ones first
|
||||
l = render_displays("other, short", displays_short, bufnr, l)
|
||||
vim.api.nvim_buf_set_lines(bufnr, l, -1, true, { "" })
|
||||
l = l + 1
|
||||
|
||||
-- long
|
||||
render_displays("other, long", displays_long, bufnr, l)
|
||||
|
||||
-- finalise and focus the buffer
|
||||
vim.api.nvim_buf_set_option(bufnr, "modifiable", false)
|
||||
|
||||
@@ -1,5 +1,11 @@
|
||||
local M = {}
|
||||
|
||||
---@class HighlightGroup
|
||||
---@field group string
|
||||
---@field link string|nil
|
||||
---@field def string|nil
|
||||
|
||||
---@type HighlightGroup[]
|
||||
-- All highlight groups: linked or directly defined.
|
||||
-- Please add new groups to help and preserve order.
|
||||
-- Please avoid directly defined groups to preserve accessibility for TUI.
|
||||
@@ -24,10 +30,10 @@ M.HIGHLIGHT_GROUPS = {
|
||||
{ group = "NvimTreeStatusLineNC", link = "StatusLineNC" },
|
||||
|
||||
-- File Text
|
||||
{ group = "NvimTreeExecFile", link = "SpellCap" },
|
||||
{ group = "NvimTreeImageFile", link = "SpellCap" },
|
||||
{ group = "NvimTreeSpecialFile", link = "SpellCap" },
|
||||
{ group = "NvimTreeSymlink", link = "SpellCap" },
|
||||
{ group = "NvimTreeExecFile", link = "Question" },
|
||||
{ group = "NvimTreeImageFile", link = "Question" },
|
||||
{ group = "NvimTreeSpecialFile", link = "Title" },
|
||||
{ group = "NvimTreeSymlink", link = "Underlined" },
|
||||
|
||||
-- Folder Text
|
||||
{ group = "NvimTreeRootFolder", link = "Title" },
|
||||
@@ -51,7 +57,7 @@ M.HIGHLIGHT_GROUPS = {
|
||||
{ group = "NvimTreeIndentMarker", link = "NvimTreeFolderIcon" },
|
||||
|
||||
-- Picker
|
||||
{ group = "NvimTreeWindowPicker", def = "guifg=#ededed guibg=#4493c8 gui=bold ctermfg=White ctermbg=Cyan" },
|
||||
{ group = "NvimTreeWindowPicker", def = "guifg=#ededed guibg=#4493c8 gui=bold ctermfg=White ctermbg=DarkBlue" },
|
||||
|
||||
-- LiveFilter
|
||||
{ group = "NvimTreeLiveFilterPrefix", link = "PreProc" },
|
||||
|
||||
@@ -11,13 +11,6 @@ local Watcher = require "nvim-tree.watcher"
|
||||
|
||||
local M = {}
|
||||
|
||||
---@param type_ string|nil
|
||||
---@param cwd string
|
||||
---@return any
|
||||
local function get_type_from(type_, cwd)
|
||||
return type_ or (vim.loop.fs_stat(cwd) or {}).type
|
||||
end
|
||||
|
||||
---@param handle uv.uv_fs_t
|
||||
---@param cwd string
|
||||
---@param node Node
|
||||
@@ -33,18 +26,19 @@ local function populate_children(handle, cwd, node, git_status)
|
||||
end
|
||||
|
||||
local abs = utils.path_join { cwd, name }
|
||||
|
||||
local profile = log.profile_start("explore populate_children %s", abs)
|
||||
|
||||
t = get_type_from(t, abs)
|
||||
if not filters.should_filter(abs, filter_status) and not nodes_by_path[abs] and Watcher.is_fs_event_capable(abs) then
|
||||
---@type uv.fs_stat.result|nil
|
||||
local stat = vim.loop.fs_stat(abs)
|
||||
|
||||
if not filters.should_filter(abs, stat, filter_status) and not nodes_by_path[abs] and Watcher.is_fs_event_capable(abs) then
|
||||
local child = nil
|
||||
if t == "directory" and vim.loop.fs_access(abs, "R") then
|
||||
child = builders.folder(node, abs, name)
|
||||
child = builders.folder(node, abs, name, stat)
|
||||
elseif t == "file" then
|
||||
child = builders.file(node, abs, name)
|
||||
child = builders.file(node, abs, name, stat)
|
||||
elseif t == "link" then
|
||||
local link = builders.link(node, abs, name)
|
||||
local link = builders.link(node, abs, name, stat)
|
||||
if link.link_to ~= nil then
|
||||
child = link
|
||||
end
|
||||
|
||||
@@ -71,9 +71,39 @@ local function dotfile(path)
|
||||
end
|
||||
|
||||
---@param path string
|
||||
---@param bookmarks table<string, boolean> absolute paths bookmarked
|
||||
local function bookmark(path, bookmarks)
|
||||
return M.config.filter_no_bookmark and not bookmarks[path]
|
||||
---@param path_type string|nil filetype of path
|
||||
---@param bookmarks table<string, string|nil> path, filetype table of bookmarked files
|
||||
local function bookmark(path, path_type, bookmarks)
|
||||
if not M.config.filter_no_bookmark then
|
||||
return false
|
||||
end
|
||||
-- if bookmark is empty, we should see a empty filetree
|
||||
if next(bookmarks) == nil then
|
||||
return true
|
||||
end
|
||||
|
||||
local mark_parent = utils.path_add_trailing(path)
|
||||
for mark, mark_type in pairs(bookmarks) do
|
||||
if path == mark then
|
||||
return false
|
||||
end
|
||||
|
||||
if path_type == "directory" then
|
||||
-- check if path is mark's parent
|
||||
if vim.fn.stridx(mark, mark_parent) == 0 then
|
||||
return false
|
||||
end
|
||||
end
|
||||
if mark_type == "directory" then
|
||||
-- check if mark is path's parent
|
||||
local path_parent = utils.path_add_trailing(mark)
|
||||
if vim.fn.stridx(path, path_parent) == 0 then
|
||||
return false
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
return true
|
||||
end
|
||||
|
||||
---@param path string
|
||||
@@ -126,7 +156,7 @@ function M.prepare(git_status)
|
||||
end
|
||||
|
||||
for _, node in pairs(marks.get_marks()) do
|
||||
status.bookmarks[node.absolute_path] = true
|
||||
status.bookmarks[node.absolute_path] = node.type
|
||||
end
|
||||
|
||||
return status
|
||||
@@ -134,19 +164,29 @@ end
|
||||
|
||||
---Check if the given path should be filtered.
|
||||
---@param path string Absolute path
|
||||
---@param fs_stat uv.fs_stat.result|nil fs_stat of file
|
||||
---@param status table from prepare
|
||||
---@return boolean
|
||||
function M.should_filter(path, status)
|
||||
function M.should_filter(path, fs_stat, status)
|
||||
if not M.config.enable then
|
||||
return false
|
||||
end
|
||||
|
||||
-- exclusions override all filters
|
||||
if is_excluded(path) then
|
||||
return false
|
||||
end
|
||||
|
||||
return git(path, status.git_status) or buf(path, status.bufinfo) or dotfile(path) or custom(path) or bookmark(path, status.bookmarks)
|
||||
return git(path, status.git_status)
|
||||
or buf(path, status.bufinfo)
|
||||
or dotfile(path)
|
||||
or custom(path)
|
||||
or bookmark(path, fs_stat and fs_stat.type, status.bookmarks)
|
||||
end
|
||||
|
||||
function M.setup(opts)
|
||||
M.config = {
|
||||
enable = opts.filters.enable,
|
||||
filter_custom = true,
|
||||
filter_dotfiles = opts.filters.dotfiles,
|
||||
filter_git_ignored = opts.filters.git_ignored,
|
||||
|
||||
@@ -6,15 +6,16 @@ local M = {}
|
||||
---@param parent Node
|
||||
---@param absolute_path string
|
||||
---@param name string
|
||||
---@param fs_stat uv.fs_stat.result|nil
|
||||
---@return Node
|
||||
function M.folder(parent, absolute_path, name)
|
||||
function M.folder(parent, absolute_path, name, fs_stat)
|
||||
local handle = vim.loop.fs_scandir(absolute_path)
|
||||
local has_children = handle and vim.loop.fs_scandir_next(handle) ~= nil
|
||||
|
||||
local node = {
|
||||
type = "directory",
|
||||
absolute_path = absolute_path,
|
||||
fs_stat = vim.loop.fs_stat(absolute_path),
|
||||
fs_stat = fs_stat,
|
||||
group_next = nil, -- If node is grouped, this points to the next child dir/link node
|
||||
has_children = has_children,
|
||||
name = name,
|
||||
@@ -43,8 +44,9 @@ end
|
||||
---@param parent Node
|
||||
---@param absolute_path string
|
||||
---@param name string
|
||||
---@param fs_stat uv.fs_stat.result|nil
|
||||
---@return Node
|
||||
function M.file(parent, absolute_path, name)
|
||||
function M.file(parent, absolute_path, name, fs_stat)
|
||||
local ext = string.match(name, ".?[^.]+%.(.*)") or ""
|
||||
|
||||
return {
|
||||
@@ -52,7 +54,7 @@ function M.file(parent, absolute_path, name)
|
||||
absolute_path = absolute_path,
|
||||
executable = M.is_executable(absolute_path),
|
||||
extension = ext,
|
||||
fs_stat = vim.loop.fs_stat(absolute_path),
|
||||
fs_stat = fs_stat,
|
||||
name = name,
|
||||
parent = parent,
|
||||
}
|
||||
@@ -66,8 +68,9 @@ end
|
||||
---@param parent Node
|
||||
---@param absolute_path string
|
||||
---@param name string
|
||||
---@param fs_stat uv.fs_stat.result|nil
|
||||
---@return Node
|
||||
function M.link(parent, absolute_path, name)
|
||||
function M.link(parent, absolute_path, name, fs_stat)
|
||||
--- I dont know if this is needed, because in my understanding, there isn't hard links in windows, but just to be sure i changed it.
|
||||
local link_to = vim.loop.fs_realpath(absolute_path)
|
||||
local open, nodes, has_children
|
||||
@@ -84,7 +87,7 @@ function M.link(parent, absolute_path, name)
|
||||
local node = {
|
||||
type = "link",
|
||||
absolute_path = absolute_path,
|
||||
fs_stat = vim.loop.fs_stat(absolute_path),
|
||||
fs_stat = fs_stat,
|
||||
group_next = nil, -- If node is grouped, this points to the next child dir/link node
|
||||
has_children = has_children,
|
||||
link_to = link_to,
|
||||
|
||||
@@ -29,7 +29,7 @@ end
|
||||
---@param absolute_path string
|
||||
---@return GitStatus
|
||||
local function get_git_status(parent_ignored, status, absolute_path)
|
||||
local file_status = parent_ignored and "!!" or status.files and status.files[absolute_path]
|
||||
local file_status = parent_ignored and "!!" or (status and status.files and status.files[absolute_path])
|
||||
return { file = file_status }
|
||||
end
|
||||
|
||||
|
||||
@@ -85,9 +85,10 @@ function M.reload(node, git_status)
|
||||
node.group_next = nil
|
||||
end
|
||||
|
||||
local child_names = {}
|
||||
local remain_childs = {}
|
||||
|
||||
local node_ignored = explorer_node.is_git_ignored(node)
|
||||
---@type table<string, Node>
|
||||
local nodes_by_path = utils.key_by(node.nodes, "absolute_path")
|
||||
while true do
|
||||
local name, t = vim.loop.fs_scandir_next(handle, cwd)
|
||||
@@ -95,20 +96,12 @@ function M.reload(node, git_status)
|
||||
break
|
||||
end
|
||||
|
||||
local stat
|
||||
local function fs_stat_cached(path)
|
||||
if stat ~= nil then
|
||||
return stat
|
||||
end
|
||||
|
||||
stat = vim.loop.fs_stat(path)
|
||||
return stat
|
||||
end
|
||||
|
||||
local abs = utils.path_join { cwd, name }
|
||||
t = t or (fs_stat_cached(abs) or {}).type
|
||||
if not filters.should_filter(abs, filter_status) then
|
||||
child_names[abs] = true
|
||||
---@type uv.fs_stat.result|nil
|
||||
local stat = vim.loop.fs_stat(abs)
|
||||
|
||||
if not filters.should_filter(abs, stat, filter_status) then
|
||||
remain_childs[abs] = true
|
||||
|
||||
-- Recreate node if type changes.
|
||||
if nodes_by_path[abs] then
|
||||
@@ -122,26 +115,26 @@ function M.reload(node, git_status)
|
||||
end
|
||||
|
||||
if not nodes_by_path[abs] then
|
||||
local new_child = nil
|
||||
if t == "directory" and vim.loop.fs_access(abs, "R") and Watcher.is_fs_event_capable(abs) then
|
||||
local folder = builders.folder(node, abs, name)
|
||||
nodes_by_path[abs] = folder
|
||||
table.insert(node.nodes, folder)
|
||||
new_child = builders.folder(node, abs, name, stat)
|
||||
elseif t == "file" then
|
||||
local file = builders.file(node, abs, name)
|
||||
nodes_by_path[abs] = file
|
||||
table.insert(node.nodes, file)
|
||||
new_child = builders.file(node, abs, name, stat)
|
||||
elseif t == "link" then
|
||||
local link = builders.link(node, abs, name)
|
||||
local link = builders.link(node, abs, name, stat)
|
||||
if link.link_to ~= nil then
|
||||
nodes_by_path[abs] = link
|
||||
table.insert(node.nodes, link)
|
||||
new_child = link
|
||||
end
|
||||
end
|
||||
if new_child then
|
||||
table.insert(node.nodes, new_child)
|
||||
nodes_by_path[abs] = new_child
|
||||
end
|
||||
else
|
||||
local n = nodes_by_path[abs]
|
||||
if n then
|
||||
n.executable = builders.is_executable(abs)
|
||||
n.fs_stat = fs_stat_cached(abs)
|
||||
n.executable = builders.is_executable(abs) or false
|
||||
n.fs_stat = stat
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -150,8 +143,8 @@ function M.reload(node, git_status)
|
||||
node.nodes = vim.tbl_map(
|
||||
update_status(nodes_by_path, node_ignored, git_status),
|
||||
vim.tbl_filter(function(n)
|
||||
if child_names[n.absolute_path] then
|
||||
return child_names[n.absolute_path]
|
||||
if remain_childs[n.absolute_path] then
|
||||
return remain_childs[n.absolute_path]
|
||||
else
|
||||
explorer_node.node_destroy(n)
|
||||
return false
|
||||
|
||||
@@ -136,6 +136,10 @@ end
|
||||
---@param path string absolute
|
||||
---@return string|nil
|
||||
function M.get_toplevel(path)
|
||||
if not path then
|
||||
return nil
|
||||
end
|
||||
|
||||
if not M.config.git.enable then
|
||||
return nil
|
||||
end
|
||||
|
||||
@@ -68,6 +68,7 @@ function M.default_on_attach(bufnr)
|
||||
vim.keymap.set('n', 'f', api.live_filter.start, opts('Live Filter: Start'))
|
||||
vim.keymap.set('n', 'g?', api.tree.toggle_help, opts('Help'))
|
||||
vim.keymap.set('n', 'gy', api.fs.copy.absolute_path, opts('Copy Absolute Path'))
|
||||
vim.keymap.set('n', 'ge', api.fs.copy.basename, opts('Copy Basename'))
|
||||
vim.keymap.set('n', 'H', api.tree.toggle_hidden_filter, opts('Toggle Filter: Dotfiles'))
|
||||
vim.keymap.set('n', 'I', api.tree.toggle_gitignore_filter, opts('Toggle Filter: Git Ignore'))
|
||||
vim.keymap.set('n', 'J', api.node.navigate.sibling.last, opts('Last Sibling'))
|
||||
|
||||
@@ -3,6 +3,7 @@ local notify = require "nvim-tree.notify"
|
||||
|
||||
local M = {}
|
||||
|
||||
-- silently move, please add to help nvim-tree-legacy-opts
|
||||
local function refactored(opts)
|
||||
-- 2022/06/20
|
||||
utils.move_missing_val(opts, "update_focused_file", "update_cwd", opts, "update_focused_file", "update_root", true)
|
||||
@@ -51,6 +52,14 @@ local function refactored(opts)
|
||||
if type(opts.renderer) == "table" and type(opts.renderer.highlight_git) == "boolean" then
|
||||
opts.renderer.highlight_git = opts.renderer.highlight_git and "name" or "none"
|
||||
end
|
||||
|
||||
-- 2024/02/15
|
||||
if type(opts.update_focused_file) == "table" then
|
||||
if type(opts.update_focused_file.update_root) ~= "table" then
|
||||
opts.update_focused_file.update_root = { enable = opts.update_focused_file.update_root }
|
||||
end
|
||||
end
|
||||
utils.move_missing_val(opts, "update_focused_file", "ignore_list", opts, "update_focused_file.update_root", "ignore_list", true)
|
||||
end
|
||||
|
||||
local function deprecated(opts)
|
||||
@@ -61,12 +70,12 @@ end
|
||||
|
||||
local function removed(opts)
|
||||
if opts.auto_close then
|
||||
notify.warn "auto close feature has been removed, see note in the README (tips & reminder section)"
|
||||
notify.warn "auto close feature has been removed: https://github.com/nvim-tree/nvim-tree.lua/wiki/Auto-Close"
|
||||
opts.auto_close = nil
|
||||
end
|
||||
|
||||
if opts.focus_empty_on_setup then
|
||||
notify.warn "focus_empty_on_setup has been removed and will be replaced by a new startup configuration. Please remove this option. See https://bit.ly/3yJch2T"
|
||||
notify.warn "focus_empty_on_setup has been removed: https://github.com/nvim-tree/nvim-tree.lua/wiki/Open-At-Startup"
|
||||
opts.focus_empty_on_setup = nil
|
||||
end
|
||||
|
||||
|
||||
@@ -57,6 +57,7 @@ local function clone_node(node)
|
||||
name = node.name,
|
||||
open = node.open,
|
||||
type = node.type,
|
||||
fs_stat = node.fs_stat,
|
||||
}
|
||||
|
||||
if type(node.nodes) == "table" then
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
local view = require "nvim-tree.view"
|
||||
local utils = require "nvim-tree.utils"
|
||||
local Iterator = require "nvim-tree.iterators.node-iterator"
|
||||
local filters = require "nvim-tree.explorer.filters"
|
||||
|
||||
local M = {
|
||||
filter = nil,
|
||||
@@ -56,6 +57,10 @@ end
|
||||
---@param node Node
|
||||
---@return boolean
|
||||
local function matches(node)
|
||||
if not filters.config.enable then
|
||||
return true
|
||||
end
|
||||
|
||||
local path = node.absolute_path
|
||||
local name = vim.fn.fnamemodify(path, ":t")
|
||||
return vim.regex(M.filter):match_str(name) ~= nil
|
||||
|
||||
@@ -3,6 +3,7 @@ local core = require "nvim-tree.core"
|
||||
local utils = require "nvim-tree.utils"
|
||||
local rename_file = require "nvim-tree.actions.fs.rename-file"
|
||||
local notify = require "nvim-tree.notify"
|
||||
local lib = require "nvim-tree.lib"
|
||||
|
||||
local M = {
|
||||
config = {},
|
||||
@@ -14,9 +15,18 @@ function M.bulk_move()
|
||||
return
|
||||
end
|
||||
|
||||
local node_at_cursor = lib.get_node_at_cursor()
|
||||
local default_path = core.get_cwd()
|
||||
|
||||
if node_at_cursor and node_at_cursor.type == "directory" then
|
||||
default_path = node_at_cursor.absolute_path
|
||||
elseif node_at_cursor and node_at_cursor.parent then
|
||||
default_path = node_at_cursor.parent.absolute_path
|
||||
end
|
||||
|
||||
local input_opts = {
|
||||
prompt = "Move to: ",
|
||||
default = core.get_cwd(),
|
||||
default = default_path,
|
||||
completion = "dir",
|
||||
}
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
---@class BaseNode
|
||||
---@field absolute_path string
|
||||
---@field executable boolean
|
||||
---@field fs_stat uv.uv_fs_t
|
||||
---@field fs_stat uv.fs_stat.result|nil
|
||||
---@field git_status GitStatus|nil
|
||||
---@field hidden boolean
|
||||
---@field name string
|
||||
|
||||
@@ -422,11 +422,21 @@ function Builder:build_header()
|
||||
end
|
||||
end
|
||||
|
||||
---Sanitize lines for rendering.
|
||||
---Replace newlines with literal \n
|
||||
---@private
|
||||
function Builder:sanitize_lines()
|
||||
self.lines = vim.tbl_map(function(line)
|
||||
return line and line:gsub("\n", "\\n") or ""
|
||||
end, self.lines)
|
||||
end
|
||||
|
||||
---Build all lines with highlights and signs
|
||||
---@return Builder
|
||||
function Builder:build()
|
||||
self:build_header()
|
||||
self:build_lines()
|
||||
self:sanitize_lines()
|
||||
return self
|
||||
end
|
||||
|
||||
|
||||
@@ -64,10 +64,15 @@ local function get_file_icon_webdev(fname, extension)
|
||||
elseif string.match(extension, "%.(.*)") then
|
||||
-- If there are more extensions to the file, try to grab the icon for them recursively
|
||||
return get_file_icon_webdev(fname, string.match(extension, "%.(.*)"))
|
||||
else
|
||||
local devicons_default = M.devicons.get_default_icon()
|
||||
if devicons_default and type(devicons_default.icon) == "string" and type(devicons_default.name) == "string" then
|
||||
return devicons_default.icon, "DevIcon" .. devicons_default.name
|
||||
else
|
||||
return get_file_icon_default()
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
local function config_file_icon()
|
||||
if M.config.show.file then
|
||||
|
||||
@@ -21,6 +21,39 @@ sed -e "s/^ / /" /tmp/DEFAULT_OPTS.2.lua > /tmp/DEFAULT_OPTS.6.lua
|
||||
sed -i -e "/${begin}/,/${end}/{ /${begin}/{p; r /tmp/DEFAULT_OPTS.6.lua
|
||||
}; /${end}/p; d; }" doc/nvim-tree-lua.txt
|
||||
|
||||
|
||||
#
|
||||
# opts index
|
||||
#
|
||||
begin="nvim-tree-index-opts\*"
|
||||
end="====================="
|
||||
|
||||
printf '\n' > /tmp/index-opts.txt
|
||||
sed -E "
|
||||
/^ *\*(nvim-tree\..*)\*$/! d ;
|
||||
s/^.*\*(.*)\*/|\1|/g
|
||||
" doc/nvim-tree-lua.txt | sort -d >> /tmp/index-opts.txt
|
||||
printf '\n' >> /tmp/index-opts.txt
|
||||
|
||||
sed -i -e "/${begin}/,/${end}/{ /${begin}/{p; r /tmp/index-opts.txt
|
||||
}; /${end}/p; d; }" doc/nvim-tree-lua.txt
|
||||
|
||||
#
|
||||
# api index
|
||||
#
|
||||
begin="nvim-tree-index-api\*"
|
||||
end="====================="
|
||||
|
||||
printf '\n' > /tmp/index-api.txt
|
||||
sed -E "
|
||||
/\*(nvim-tree-api.*\(\))\*/! d ;
|
||||
s/^.*\*(.*)\*/|\1|/g
|
||||
" doc/nvim-tree-lua.txt | sort -d >> /tmp/index-api.txt
|
||||
printf '\n' >> /tmp/index-api.txt
|
||||
|
||||
sed -i -e "/${begin}/,/${end}/{ /${begin}/{p; r /tmp/index-api.txt
|
||||
}; /${end}/p; d; }" doc/nvim-tree-lua.txt
|
||||
|
||||
#
|
||||
# DEFAULT_ON_ATTACH
|
||||
#
|
||||
|
||||
Reference in New Issue
Block a user