doomemacs/modules/ui/treemacs/README.org

ui/treemacs

• Description
  • Maintainers
  • Module Flags
  • Plugins
• Prerequisites
• Features
• Configuration
• Troubleshooting

Description

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.

Maintainers

• This module has no dedicated maintainers.

Module Flags

• +lsp Enable lsp-treemacs integration and add shortcuts for common commands.

Plugins

• treemacs
• treemacs-evil
• treemacs-projectile
• treemacs-magit
• treemacs-persp
• lsp-treemacs

Prerequisites

If +treemacs-git-mode is set to extended or deferred you will need to have python3 installed

Features

Configuration

the variable +treemacs-git-mode sets the type of git integration for treemacs

There are 3 possible values:

1. simple, which highlights only files based on their git status, and is slightly faster,
2. extended, which highlights both files and directories, but requires python,
3. deferred, same as extended, but highlights asynchronously.

the default being simple

This must be set before treemacs has loaded.

TODO Troubleshooting