90f90fb34d
dec058ffixed the load order between treemacs-nerd-icons and lsp-treemacs, but lsp-treemacs still loads so late that folks will see a theme-less Treemacs until they visit their first lsp-mode-enabled file. This ensures that won't happen. Amend:dec058fabbAmend: #7519
:ui treemacs
Description unfold
Treemacs is a file and project explorer similar to NeoTree or vim's NerdTree, but largely inspired by the Project Explorer in Eclipse. It shows the file system outlines of your projects in a simple tree layout allowing quick navigation and exploration, while also possessing basic file management utilities. It includes:
- Integration with Git (if doom-module::tools magit is enabled)
- Integration with Evil (if doom-module::editor evil +everywhere is enabled)
- Workspace awareness (if doom-module::ui workspaces is enabled)
Maintainers
Module flags
- +lsp
-
Enable
lsp-treemacsintegration and add shortcuts for common commands.
Packages
- doom-package:lsp-treemacs if doom-module:+lsp
- doom-package:treemacs
- doom-package:treemacs-evil if doom-module::editor evil +everywhere
- doom-package:treemacs-magit if doom-module::tools magit
- doom-package:treemacs-persp if doom-module::ui workspaces
- doom-package:treemacs-projectile
Hacks
No hacks documented for this module.
TODO Changelog
This module does not have a changelog yet.
Installation
Enable this module in your doom! block.
If python3 is present on your $PATH, doom-package:treemacs will use it to display git
status for files.
TODO Usage
This module's usage documentation is incomplete. Complete it?
The project bar can be opened using SPC o p.
| Keybind | Description |
|---|---|
| o s | Open a horizontal dired buffer on the currently highlighted node |
| o v | Open a vertical dired buffer on the currently highlighted node |
TODO Configuration
This module's configuration documentation is incomplete. Complete it?
The variable +treemacs-git-mode sets the type of git integration that treemacs
has.
There are 3 possible values:
'simple(the default), which highlights only files based on their git status, and is slightly faster,'extended, which highlights both files and directories, but requires python,'deferred, same as extended, but highlights asynchronously.
+treemacs-git-modemust be set before treemacs is loaded.
Troubleshooting
There are no known problems with this module. Report one?
Frequently asked questions
This module has no FAQs yet. Ask one?
TODO Appendix
This module has no appendix yet. Write one?