Variable: treemacs-ignored-file-predicates

treemacs-ignored-file-predicates is a customizable variable defined in treemacs-customization.el.

Value

(treemacs--std-ignore-file-predicate)

Documentation

List of predicates to test for files and directories ignored by treemacs.

Ignored files will *never* be shown in the treemacs buffer (unlike dotfiles whose presence is controlled by treemacs-show-hidden-files).

Each predicate is a function that takes 2 arguments: a file's name and its absolute path and returns t if the file should be ignored and nil otherwise. A file which returns t for *any* function in this list counts as ignored.

By default this list contains treemacs--std-ignore-file-predicate which filters out ".", "..", Emacs' lock files as well temp files created by flycheck. This means that this variable should *not* be set directly, but instead modified with functions like add-to-list.

Additionally treemacs--mac-ignore-file-predicate is also included on Mac-derived operating systems (when system-type is darwin).

Source Code

;; Defined in ~/.emacs.d/elpa/treemacs-20251226.1307/treemacs-customization.el
(defcustom treemacs-ignored-file-predicates
  (pcase system-type
    ('darwin '(treemacs--std-ignore-file-predicate treemacs--mac-ignore-file-predicate))
    (_       '(treemacs--std-ignore-file-predicate)))
  "List of predicates to test for files and directories ignored by treemacs.

Ignored files will *never* be shown in the treemacs buffer (unlike dotfiles
whose presence is controlled by `treemacs-show-hidden-files').

Each predicate is a function that takes 2 arguments: a file's name and its
absolute path and returns t if the file should be ignored and nil otherwise.  A
file which returns t for *any* function in this list counts as ignored.

By default this list contains `treemacs--std-ignore-file-predicate' which
filters out \".\", \"..\", Emacs' lock files as well temp files created by
flycheck.  This means that this variable should *not* be set directly, but
instead modified with functions like `add-to-list'.

Additionally `treemacs--mac-ignore-file-predicate' is also included on
Mac-derived operating systems (when `system-type' is `darwin')."
  :type '(list function)
  :group 'treemacs)