spacemacs/layers/+tools/shell/config.el

;;; config.el --- shell configuration File for Spacemacs
;;
;; Copyright (c) 2012-2020 Sylvain Benner & Contributors
;;
;; Author: Sylvain Benner <sylvain.benner@gmail.com>
;; URL: https://github.com/syl20bnr/spacemacs
;;
;; This file is not part of GNU Emacs.
;;
;;; License: GPLv3

;; Emacs built-in variables

;; move point to the end of buffer on new output
(setq comint-move-point-for-output t)

;; allow moving around the buffer in emacs >= 26.1 in evil's normal mode
(setq term-char-mode-point-at-process-mark nil)

;; Variables
(defvar shell-default-shell (if (spacemacs/system-is-mswindows)
                                'eshell
                              'ansi-term)
  "Default shell to use in Spacemacs. Possible values are `eshell' (default),
`shell', `term', `ansi-term', `multi-term' and `vterm'.")

(spacemacs|defc shell-default-position 'bottom
  "Position of the shell. Possible values are `top', `bottom', `full',
  `left' and `right'."
  '(choice (const top) (const bottom) (const full) (const left) (const right)))

(spacemacs|defc shell-default-height 30
  "Height in percents for the shell window."
  'integer)

(defvar shell-default-width 30
  "Width in percents for the shell window.")

(defvar shell-default-term-shell shell-file-name
  "Default shell to use in `term', `ansi-term' and `vterm' shells.")

(defvar shell-enable-smart-eshell nil
  "If non-nil then `em-smart' is enabled. `em-smart' allows to quickly review
  commands, modify old commands or enter a new one.")

(defvar shell-protect-eshell-prompt t
  "If non-nil then eshell's prompt is protected. This means that
  movement to the prompt is inhibited like for `comint-mode'
  prompts and the prompt is made read-only")

(defvar shell-default-full-span t
  "If non-nil, the `shell' buffer spans full width of a frame.")

(defvar close-window-with-terminal nil
  "If non-nil, the window is closed when the terminal is stopped.
  This is only applied to `term' and `ansi-term' modes.")

(defvar spacemacs-vterm-history-file-location nil
  "Bash history full file name.")
new layer: shell 2015-05-21 02:39:14 +00:00			`;;; config.el --- shell configuration File for Spacemacs`
			`;;`
[purpose] Document how to properly declare and overwrite purposes Also refactor purpose config in shell layer to use the correct `post-init-window-purpose` function. 2020-06-25 23:10:17 +00:00			`;; Copyright (c) 2012-2020 Sylvain Benner & Contributors`
new layer: shell 2015-05-21 02:39:14 +00:00			`;;`
			`;; Author: Sylvain Benner <sylvain.benner@gmail.com>`
			`;; URL: https://github.com/syl20bnr/spacemacs`
			`;;`
			`;; This file is not part of GNU Emacs.`
			`;;`
			`;;; License: GPLv3`

shell: set comint-move-point-for-output to true Automatically scroll the buffer on new output 2015-10-12 14:00:57 +00:00			`;; Emacs built-in variables`

			`;; move point to the end of buffer on new output`
			`(setq comint-move-point-for-output t)`

shell: allow evil normal-mode movement in terminal buffer As mentioned in https://github.com/syl20bnr/spacemacs/issues/10779#issuecomment-427712967, emacs 26.1 changed the default behavior for term-char-mode to prevent cursor movement. This change restores consistent behavior on all versions of emacs and allows normal-mode motions to work again. Note that the buffer is still read-only while in normal-mode, so operators that change the line (such as `C`, `D`, `S`) still don't work. Fixes #10956 Fixes #10779 2019-08-04 22:20:19 +00:00			`;; allow moving around the buffer in emacs >= 26.1 in evil's normal mode`
			`(setq term-char-mode-point-at-process-mark nil)`

new layer: shell 2015-05-21 02:39:14 +00:00			`;; Variables`
[shell] add support for vterm Support for https://github.com/akermu/emacs-libvterm 2018-11-05 14:27:32 +00:00			`(defvar shell-default-shell (if (spacemacs/system-is-mswindows)`
Enhance shell-pop and term integration - Only set Eshell by default on Windows; in other OSes we use `ansi-term`, NOT `term`. The reason is that `ansi-term` can use Emacs key bindings such as C-x b, C-x 1... even editing commands such as M-u/M-l. `term` cannot and we have to use the default `C-c b` variants i.e. C-c b to switch buffer instead of "C-x b". `ansi-term` is currently the best terminal emulator in Emacs. - Allow ansi-term/term to close its shell-pop window when a user type "exit". - With shell-pop, we can allow ansi-term/term to track current directory of current buffer. It is a useful feature and it also makes ansi-term consistent with eshell/shell. - Swap "term" and "ansi-term" key bindings, since the old "ast" was used for multi-term, which is a wrapper around ansi-term. 2015-05-21 10:31:48 +00:00			`'eshell`
			`'ansi-term)`
[shell] add support for vterm Support for https://github.com/akermu/emacs-libvterm 2018-11-05 14:27:32 +00:00			"Default shell to use in Spacemacs. Possible values are `eshell' (default),
			`shell', `term', `ansi-term', `multi-term' and `vterm'.")
new layer: shell 2015-05-21 02:39:14 +00:00
Validate .spacemacs variables. 2021-02-11 17:41:39 +00:00			`(spacemacs\|defc shell-default-position 'bottom`
Update documentation for shell layer to support left or right position 2016-03-17 01:27:25 +00:00			"Position of the shell. Possible values are `top', `bottom', `full',
Validate .spacemacs variables. 2021-02-11 17:41:39 +00:00			`left' and `right'."
Enhance shell-default-position validation spec to match values listed in it's documentation. 2021-03-19 00:11:47 +00:00			`'(choice (const top) (const bottom) (const full) (const left) (const right)))`
new layer: shell 2015-05-21 02:39:14 +00:00
Validate .spacemacs variables. 2021-02-11 17:41:39 +00:00			`(spacemacs\|defc shell-default-height 30`
			`"Height in percents for the shell window."`
			`'integer)`
new layer: shell 2015-05-21 02:39:14 +00:00
Add shell-default-width configuration option for left/right side 2018-01-22 19:55:21 +00:00			`(defvar shell-default-width 30`
			`"Width in percents for the shell window.")`

Use login shell as term shell shell-file-name provides the "best" shell Emacs knows about, i.e. the login shell from $SHELL, or a system default, which is just about as arbitrary as the current default to /bin/bash. 2015-10-13 10:10:28 +00:00			`(defvar shell-default-term-shell shell-file-name`
[shell] Revise documentation 2019-10-19 20:34:49 +00:00			"Default shell to use in `term', `ansi-term' and `vterm' shells.")
shell layer: various improvements for eshell see below - move the magit, helm and other dependencies to their own init functions - remove all nested use-package forms and enable correct lazy-loading of eshell - import interesting features from trishume like auto-completion and automatic jump to prompt when switching to insert state - new layer variable `shell-enable-smart-eshell` to conditionally enable `em-smart` (default is not enabled) - document all the last additions to the layer in README.org 2015-07-08 04:57:15 +00:00
			`(defvar shell-enable-smart-eshell nil`
			"If non-nil then `em-smart' is enabled. `em-smart' allows to quickly review
Add support to start external terminal emulators in context. Integrated terminal emulators/integrated shells get the job done for quick-and-dirty shell commands, but a lot of people take great care to tweak their terminal workflow exactly to their liking. This makes it possible to switch to that workflow seamlessly, by opening their terminal emulator of choosing in the current directory or at the project root, and even supports working over `ssh` using `tramp`. 2019-02-06 08:55:49 +00:00			`commands, modify old commands or enter a new one.")`
shell layer: Add option to protect the Eshell prompt 2015-07-10 23:58:13 +00:00
shell layer: enable by default shell-protect-eshell-prompt 2015-07-26 06:41:26 +00:00			`(defvar shell-protect-eshell-prompt t`
shell layer: Add option to protect the Eshell prompt 2015-07-10 23:58:13 +00:00			`"If non-nil then eshell's prompt is protected. This means that`
Add support to start external terminal emulators in context. Integrated terminal emulators/integrated shells get the job done for quick-and-dirty shell commands, but a lot of people take great care to tweak their terminal workflow exactly to their liking. This makes it possible to switch to that workflow seamlessly, by opening their terminal emulator of choosing in the current directory or at the project root, and even supports working over `ssh` using `tramp`. 2019-02-06 08:55:49 +00:00			movement to the prompt is inhibited like for `comint-mode'
			`prompts and the prompt is made read-only")`
Add shell-default-full-span for shell window 2016-04-28 14:22:01 +00:00
shell: document layer variable shell-default-term-shell 2016-04-29 22:20:59 +00:00			`(defvar shell-default-full-span t`
			"If non-nil, the `shell' buffer spans full width of a frame.")
Add a layer variable to close window with terminal Currently, when a terminal is ended, its window is also closed. This behavior is not satisfying to all. Thus a layer variable is added to give an option whether to close window with terminal. 2019-05-19 23:09:14 +00:00
			`(defvar close-window-with-terminal nil`
			`"If non-nil, the window is closed when the terminal is stopped.`
Add support to start external terminal emulators in context. Integrated terminal emulators/integrated shells get the job done for quick-and-dirty shell commands, but a lot of people take great care to tweak their terminal workflow exactly to their liking. This makes it possible to switch to that workflow seamlessly, by opening their terminal emulator of choosing in the current directory or at the project root, and even supports working over `ssh` using `tramp`. 2019-02-06 08:55:49 +00:00			This is only applied to `term' and `ansi-term' modes.")
[shell] new helm/ivy functions to search vterm history Based on http://xenodium.com/search-bash-history-with-emacs-helm/ Add new helm/ivy functions `spacemacs/helm-vterm-search-history`, spacemacs/counsel-vterm-search-history to search bash history and insert to vterm/shell Bind this function to M-r for vterm New layer variable spacemacs-vterm-history-file-locatition to customize bash file Default is nil. Also bind add counsel-shell-history to `, H` for shell-mode in the same convention as helm counterpart. [shell] wip 2020-10-05 21:19:39 +00:00
			`(defvar spacemacs-vterm-history-file-location nil`
			`"Bash history full file name.")`