TakeV/spacemacs
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
spacemacs/layers/+filetree/treemacs/README.org

175 lines
12 KiB
Org Mode
Raw Normal View History

Add treemacs layer.
2017-08-07 06:37:47 +00:00
#+TITLE: Treemacs layer
Add more tags
2019-05-02 21:49:30 +00:00
#+TAGS: file tree|layer
treemacs: move to +filetree category and add can-shadow relation Add shadow relation between neotree and treemacs sort packages in treemacs packages.el file
2017-10-08 16:01:48 +00:00
[[file:img/treemacs.png]]
Switch to the new layers generator
2019-05-07 20:05:06 +00:00
* Table of Contents :TOC_5_gh:noexport:
Add treemacs layer.
2017-08-07 06:37:47 +00:00
- [[#description][Description]]
- [[#features][Features:]]
treemacs: update README.org to be more conventional Layer READMEs don't list the configuration of the package so this commit removes the mentions of treemacs package readme. Reformat the documentation of layer variables Reformat key bindings in table Respect 80 chars max per line.
2017-10-08 16:20:03 +00:00
- [[#install][Install]]
Add treemacs layer.
2017-08-07 06:37:47 +00:00
- [[#configuration][Configuration]]
treemacs: update README.org to be more conventional Layer READMEs don't list the configuration of the package so this commit removes the mentions of treemacs package readme. Reformat the documentation of layer variables Reformat key bindings in table Respect 80 chars max per line.
2017-10-08 16:20:03 +00:00
- [[#follow-mode][Follow mode]]
- [[#file-watch][File watch]]
Add document for option treemacs-use-git-mode This option has been implemented but was not documented.
2019-10-04 02:47:57 +00:00
- [[#git-mode][Git mode]]
[treemacs] Improve documentation This is a squash commit, below are the original messages [treemacs] documentation; locking width section. [treemacs] documentation; change wording in description. [treemacs] documentation; improve install section. [treemacs] documentation; Git mode section. [treemacs] documentation; flatten directories section.
2020-01-30 17:36:14 +00:00
- [[#flattening-of-directories][Flattening of directories]]
treemacs layer: make treemacs resizable by default
2018-10-04 10:01:49 +00:00
- [[#locking-width][Locking width]]
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
- [[#key-bindings][Key bindings]]
Add treemacs layer.
2017-08-07 06:37:47 +00:00
- [[#global][Global]]
- [[#inside-treemacs][Inside Treemacs]]
* Description
Make treemacs the default file browser.
2019-01-19 15:25:26 +00:00
This layer sets up a file navigation and project explorer side-window via [[https://github.com/Alexander-Miller/treemacs][Treemacs]].
treemacs: update README.org to be more conventional Layer READMEs don't list the configuration of the package so this commit removes the mentions of treemacs package readme. Reformat the documentation of layer variables Reformat key bindings in table Respect 80 chars max per line.
2017-10-08 16:20:03 +00:00
Add treemacs layer.
2017-08-07 06:37:47 +00:00
** Features:
[treemacs] Improve documentation This is a squash commit, below are the original messages [treemacs] documentation; locking width section. [treemacs] documentation; change wording in description. [treemacs] documentation; improve install section. [treemacs] documentation; Git mode section. [treemacs] documentation; flatten directories section.
2020-01-30 17:36:14 +00:00
A detailed overview of the features of Treemacs is available in [[https://github.com/Alexander-Miller/treemacs#detailed-feature-list][the Treemacs
readme]]. In short, Treemacs offers:
neotree: fix list of feature Also respect 80 chars max per line in treemacs feature list.
2017-10-08 22:18:23 +00:00
- Simple and powerful navigation and ability to detail exactly how and where a
[treemacs] Improve documentation This is a squash commit, below are the original messages [treemacs] documentation; locking width section. [treemacs] documentation; change wording in description. [treemacs] documentation; improve install section. [treemacs] documentation; Git mode section. [treemacs] documentation; flatten directories section.
2020-01-30 17:36:14 +00:00
file should be opened.
- Good looking icons.
treemacs: correct typos
2018-11-23 12:37:48 +00:00
- Display of multiple file trees organized as projects residing in a workspace.
[treemacs] Improve documentation This is a squash commit, below are the original messages [treemacs] documentation; locking width section. [treemacs] documentation; change wording in description. [treemacs] documentation; improve install section. [treemacs] documentation; Git mode section. [treemacs] documentation; flatten directories section.
2020-01-30 17:36:14 +00:00
- Ability to show tags contained in files. Tags are provided by [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Imenu.html][Imenu]], so nearly
every filetype is supported.
- Mouse interface for single and double left clicks in line with modern GUI
standards (clicking on an icon will also display the file's tags).
- Location awareness: commands like ~find-file~ or ~magit-status~ will use the
location of the node at point (with =$HOME= as fallback).
- Optional fontifying of files based on their git status.
- Optional collapsing of /single-dir-child/ directories into one.
neotree: fix list of feature Also respect 80 chars max per line in treemacs feature list.
2017-10-08 22:18:23 +00:00
- Doing both asynchronously for an imperceptible performance cost.
Allow users to enable treemacs-tag-follow-mode as initial setup.
2019-10-05 19:47:12 +00:00
- Optional =follow-mode= to automatically focus the currently selected file or tag.
neotree: fix list of feature Also respect 80 chars max per line in treemacs feature list.
2017-10-08 22:18:23 +00:00
- Optional =filewatch-mode= to automatically refresh the view after (and only
after) changes to the shown filesystem.
Add treemacs layer.
2017-08-07 06:37:47 +00:00
treemacs: update README.org to be more conventional Layer READMEs don't list the configuration of the package so this commit removes the mentions of treemacs package readme. Reformat the documentation of layer variables Reformat key bindings in table Respect 80 chars max per line.
2017-10-08 16:20:03 +00:00
* Install
[treemacs] Improve documentation This is a squash commit, below are the original messages [treemacs] documentation; locking width section. [treemacs] documentation; change wording in description. [treemacs] documentation; improve install section. [treemacs] documentation; Git mode section. [treemacs] documentation; flatten directories section.
2020-01-30 17:36:14 +00:00
To use this layer, add =treemacs= to =dotspacemacs-configuration-layers= in your
=dotspacemacs= file.
treemacs: update README.org to be more conventional Layer READMEs don't list the configuration of the package so this commit removes the mentions of treemacs package readme. Reformat the documentation of layer variables Reformat key bindings in table Respect 80 chars max per line.
2017-10-08 16:20:03 +00:00
* Configuration
** Follow mode
Allow users to enable treemacs-tag-follow-mode as initial setup.
2019-10-05 19:47:12 +00:00
To have Treemacs automatically sync with your current:
- Buffer's file, set the layer variable =treemacs-use-follow-mode= to =t=.
- Tag, set the layer variable =treemacs-use-follow-mode= to =tag=.
treemacs: update README.org to be more conventional Layer READMEs don't list the configuration of the package so this commit removes the mentions of treemacs package readme. Reformat the documentation of layer variables Reformat key bindings in table Respect 80 chars max per line.
2017-10-08 16:20:03 +00:00
#+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers '(
Allow users to enable treemacs-tag-follow-mode as initial setup.
2019-10-05 19:47:12 +00:00
(treemacs :variables treemacs-use-follow-mode 'tag)))
treemacs: update README.org to be more conventional Layer READMEs don't list the configuration of the package so this commit removes the mentions of treemacs package readme. Reformat the documentation of layer variables Reformat key bindings in table Respect 80 chars max per line.
2017-10-08 16:20:03 +00:00
#+END_SRC
treemacs layer: make treemacs resizable by default
2018-10-04 10:01:49 +00:00
Default is =t=.
treemacs: update README.org to be more conventional Layer READMEs don't list the configuration of the package so this commit removes the mentions of treemacs package readme. Reformat the documentation of layer variables Reformat key bindings in table Respect 80 chars max per line.
2017-10-08 16:20:03 +00:00
** File watch
treemacs: Fix typo and keybinds table and improve description in README.
2017-10-09 06:26:04 +00:00
To automatically refresh the Treemacs buffer when there is a change in the
part of the file system shown by treemacs set the layer variable
=treemacs-use-filewatch-mode= to non-nil.
treemacs: update README.org to be more conventional Layer READMEs don't list the configuration of the package so this commit removes the mentions of treemacs package readme. Reformat the documentation of layer variables Reformat key bindings in table Respect 80 chars max per line.
2017-10-08 16:20:03 +00:00
#+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers '(
(treemacs :variables treemacs-use-filewatch-mode t)))
#+END_SRC
Add treemacs layer.
2017-08-07 06:37:47 +00:00
treemacs layer: make treemacs resizable by default
2018-10-04 10:01:49 +00:00
Default is =t=.
Add treemacs layer.
2017-08-07 06:37:47 +00:00
Add document for option treemacs-use-git-mode This option has been implemented but was not documented.
2019-10-04 02:47:57 +00:00
** Git mode
[treemacs] Improve documentation This is a squash commit, below are the original messages [treemacs] documentation; locking width section. [treemacs] documentation; change wording in description. [treemacs] documentation; improve install section. [treemacs] documentation; Git mode section. [treemacs] documentation; flatten directories section.
2020-01-30 17:36:14 +00:00
To enable Treemacs to check for the git status information of files and directories
Add document for option treemacs-use-git-mode This option has been implemented but was not documented.
2019-10-04 02:47:57 +00:00
and highlight them accordingly, set the layer variable =treemacs-use-git-mode=
[treemacs] Improve documentation This is a squash commit, below are the original messages [treemacs] documentation; locking width section. [treemacs] documentation; change wording in description. [treemacs] documentation; improve install section. [treemacs] documentation; Git mode section. [treemacs] documentation; flatten directories section.
2020-01-30 17:36:14 +00:00
to =simple=, =extended=, or =deferred=. See the [[https://github.com/Alexander-Miller/treemacs#git-mode][Treemacs documentation]] for a more detailed
Add document for option treemacs-use-git-mode This option has been implemented but was not documented.
2019-10-04 02:47:57 +00:00
explanation.
#+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers '(
(treemacs :variables treemacs-use-git-mode 'deferred)))
#+END_SRC
Default is =nil=.
[treemacs] Improve documentation This is a squash commit, below are the original messages [treemacs] documentation; locking width section. [treemacs] documentation; change wording in description. [treemacs] documentation; improve install section. [treemacs] documentation; Git mode section. [treemacs] documentation; flatten directories section.
2020-01-30 17:36:14 +00:00
** Flattening of directories
*This feature requires Python to be installed*.
treemacs: Take into account that python may not be installed.
2017-10-09 15:20:44 +00:00
[treemacs] Deprecate treemacs-use-collapsed-directories. Also contains below squashed commit [treemacs] Make sure width (un)locking message won't appear on every start.
2019-11-19 05:59:13 +00:00
Treemacs tries to flatten empty directory names into one name. It is possible
treemacs: update README.org to be more conventional Layer READMEs don't list the configuration of the package so this commit removes the mentions of treemacs package readme. Reformat the documentation of layer variables Reformat key bindings in table Respect 80 chars max per line.
2017-10-08 16:20:03 +00:00
to control how deep Treemacs will search for empty directories by settings the
[treemacs] Deprecate treemacs-use-collapsed-directories. Also contains below squashed commit [treemacs] Make sure width (un)locking message won't appear on every start.
2019-11-19 05:59:13 +00:00
layer variable =treemacs-collapse-dirs= to a positive number.
Add treemacs layer.
2017-08-07 06:37:47 +00:00
#+BEGIN_SRC emacs-lisp
treemacs: update README.org to be more conventional Layer READMEs don't list the configuration of the package so this commit removes the mentions of treemacs package readme. Reformat the documentation of layer variables Reformat key bindings in table Respect 80 chars max per line.
2017-10-08 16:20:03 +00:00
(setq-default dotspacemacs-configuration-layers '(
[treemacs] Deprecate treemacs-use-collapsed-directories. Also contains below squashed commit [treemacs] Make sure width (un)locking message won't appear on every start.
2019-11-19 05:59:13 +00:00
(treemacs :variables treemacs-collapse-dirs 3)))
Add treemacs layer.
2017-08-07 06:37:47 +00:00
#+END_SRC
[treemacs] Improve documentation This is a squash commit, below are the original messages [treemacs] documentation; locking width section. [treemacs] documentation; change wording in description. [treemacs] documentation; improve install section. [treemacs] documentation; Git mode section. [treemacs] documentation; flatten directories section.
2020-01-30 17:36:14 +00:00
Default is 3 (or 0 when Python is not installed).
treemacs layer: make treemacs resizable by default
2018-10-04 10:01:49 +00:00
** Locking width
[treemacs] Improve documentation This is a squash commit, below are the original messages [treemacs] documentation; locking width section. [treemacs] documentation; change wording in description. [treemacs] documentation; improve install section. [treemacs] documentation; Git mode section. [treemacs] documentation; flatten directories section.
2020-01-30 17:36:14 +00:00
To have the width of the treemacs window locked by default, so that it is not manually
treemacs layer: make treemacs resizable by default
2018-10-04 10:01:49 +00:00
resizable, set the variable =treemacs-lock-width= to non-nil. It will still be
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
resizable through Treemacs commands and key bindings.
treemacs layer: make treemacs resizable by default
2018-10-04 10:01:49 +00:00
#+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers '(
(treemacs :variables treemacs-lock-width t)))
#+END_SRC
Default is =nil=.
Add treemacs layer.
2017-08-07 06:37:47 +00:00
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
* Key bindings
Add treemacs layer.
2017-08-07 06:37:47 +00:00
** Global
documentation formatting: Wed Dec 5 03:03:03 UTC 2018
2018-12-05 03:03:03 +00:00
| Key binding | Description |
Add treemacs layer.
2017-08-07 06:37:47 +00:00
|-------------+------------------------------------------------------------------------------------------------------------------------------------------------|
treemacs: sort key bindings
2018-05-19 03:41:03 +00:00
| ~M-0~ | Selected the treemacs window. Actually selects window #10, which is always assigned to treemacs. |
filetree: Press ~SPC 0~ to open the neotree and treemacs windows Resolve #9313 Window 0 is reserved for file trees. Let's open the file tree window using ~SPC 0~ instead of ~SPC f T~ since it's less key strokes.
2017-11-26 15:00:04 +00:00
| ~SPC 0~ | Open treemacs in the current directory. When not visiting a file use $HOME as fallback. With a prefix arg manually select the root instead. |
documentation formatting: Sun May 26 20:58:52 UTC 2019
2019-05-26 20:58:52 +00:00
| ~SPC f B~ | Find and select a bookmark. If it cannot be found rebuild view with the bookmark's location as root. Also open the bookmark with a prefix arg. |
treemacs: sort key bindings
2018-05-19 03:41:03 +00:00
| ~SPC f t~ | Hide/show existing treemacs buffer. Create one for the current directory if no buffer exists. |
| ~SPC f T~ | Manually focus the treemacs view on the currently selected file. Not needed when =treemacs-follow-mode= is enabled. |
filetree: Update treemacs layer.
2018-05-25 05:39:15 +00:00
| ~SPC f M-t~ | Manually focus the treemacs view on the currently selected file and tag. |
treemacs: Add missing key binding description and fix some typo
2018-09-17 02:24:00 +00:00
| ~SPC p t~ | Hide/show existing treemacs buffer. Add the current project to treemacs if not already added. |
Add treemacs layer.
2017-08-07 06:37:47 +00:00
** Inside Treemacs
treemacs: update README.org to be more conventional Layer READMEs don't list the configuration of the package so this commit removes the mentions of treemacs package readme. Reformat the documentation of layer variables Reformat key bindings in table Respect 80 chars max per line.
2017-10-08 16:20:03 +00:00
Treemacs will use either ~j/k~ or ~n/p~ to go to the next/previous line,
depending on whether vim/hybrid editing style is used. Likewise refresh is only
bound to g when emacs editing style is used, since under vim g is a prefix for
many other commands.
Add treemacs layer.
2017-08-07 06:37:47 +00:00
Update references to macOS Apple renamed "Mac OS X" to "OS X" in 2012 and then to "macOS" in 2016. Update references to use the current name.
2019-10-13 05:27:17 +00:00
| Key binding | Description |
|-------------+------------------------------------------------------------------------------------------------------------------|
| ~?~ | Summon the helpful hydra to show you the treemacs keymap. |
| ~M-j/M-n~ | Select next node at the same depth as currently selected node, if possible. |
| ~j/n~ | Goto next line. |
| ~k/p~ | Goto previous line. |
| ~M-J/N~ | Go to the next line in ~next-window~. |
| ~M-K/P~ | Go to the previous line in ~next-window~.. |
| ~M-j/M-n~ | Select next node at the same depth as currently selected node, if possible. |
| ~M-k/M-p~ | Select previous node at the same depth as currently selected node, if possible. |
| ~C-c C-p a~ | Select a new project to add to the treemacs workspace. |
| ~C-c C-p p~ | Select a projectile project to add to the workspace. |
| ~C-c C-p d~ | Remove project at point from the workspace. |
| ~C-c C-p r~ | Rename project at point. |
| ~th~ | Toggle the hiding and displaying of dotfiles. |
| ~tw~ | Toggle whether the treemacs buffer should have a fixed width. |
| ~tf~ | Toggle treemacs-follow-mode. |
| ~ta~ | treemacs-filewatch-mode. |
| ~w~ | Set a new value for the width of the treemacs window. |
| ~TAB~ | Do what I mean (as defined in ~treemacs-TAB-actions-config~). Prefers expanding nodes by default. |
| ~RET~ | Do what I mean (as defined in ~treemacs-RET-actions-config~). Prefers visiting nodes by default. |
| ~mouse1~ | Move point to clicked line |
| ~2x mouse1~ | Do what I mean (as defined in ~treemacs-doubleclick-actions-config~). Behaves like ~RET~ by default. |
| ~g/r/gr~ | Refresh and rebuild the treemacs buffer. |
| ~d~ | Delete node at point. A delete action must always be confirmed. Directories are deleted recursively. |
| ~cf~ | Create a file. |
| ~cd~ | Create a directory. |
| ~R~ | Rename the currently selected node. Reload buffers visiting renamed files or files in renamed directories. |
| ~u~ | Select parent of selected node, if possible. |
| ~q~ | Hide/show an existing treemacs buffer. |
| ~Q~ | Kill the treemacs buffer. |
| ~ov~ | Open current file or tag by vertically splitting ~next-window~. |
| ~oh~ | Open current file or tag by horizontally splitting ~next-window~. |
| ~oo~ | Open current file or tag, performing no split and using ~next-window~ directly. |
| ~oaa~ | Open current file or tag, using ace-window to decide which window to open the file in. |
| ~oah~ | Open current file or tag by horizontally splitting a window selected by ace-window. |
| ~oav~ | Open current file or tag by vertically splitting a window selected by ace-window. |
| ~ox~ | Open current file according to its mime type in an external application. Linux, Windows and macOS are supported. |
| ~ta~ | Toggle ~treemacs-filewatch-mode~. |
| ~tf~ | Toggle ~treemacs-follow-mode~. |
| ~th~ | Toggle the hiding and displaying of dotfiles. |
| ~tw~ | Toggle whether the treemacs buffer should have a fixed width. |
| ~yr~ | Copy the absolute path of the nearest project node at point. |
| ~yy~ | Copy the absolute path of the node at point. |
Reference in a new issue Copy permalink