emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
doomemacs/modules/lang/sh/config.el

100 lines
3.4 KiB
EmacsLisp
Raw Normal View History

Major optimization refactor, across the board + enable lexical-scope everywhere (lexical-binding = t): ~5-10% faster startup; ~5-20% general boost + reduce consing, function calls & garbage collection by preferring cl-loop & dolist over lambda closures (for mapc[ar], add-hook, and various cl-lib filter/map/reduce functions) -- where possible + prefer functions with dedicated opcodes, like assq (see byte-defop's in bytecomp.el for more) + prefer pcase & cond (faster) over cl-case + general refactor for code readability + ensure naming & style conventions are adhered to + appease byte-compiler by marking unused variables with underscore + defer minor mode activation to after-init, emacs-startup or window-setup hooks; a customization opportunity for users + ensures custom functionality won't interfere with startup.
2017-06-08 11:47:56 +02:00
;;; lang/sh/config.el -*- lexical-binding: t; -*-
Add module-sh
2015-09-28 14:22:26 -04:00
lang/sh: improve fontification for sh-mode + Fontify variables in double quotes (better) + Fontify command substitution in double quotes + Fontify built-in/common commands (see `+sh-builtin-keywords`)
2017-06-20 15:34:10 +02:00
(defvar +sh-builtin-keywords
Add ln to +sh-builtin-keywords
2019-08-28 00:15:33 +10:00
'("cat" "cd" "chmod" "chown" "cp" "curl" "date" "echo" "find" "git" "grep"
"kill" "less" "ln" "ls" "make" "mkdir" "mv" "pgrep" "pkill" "pwd" "rm"
"sleep" "sudo" "touch")
lang/sh: remove tail & tee from +sh-builtin-keywords
2017-11-05 21:25:01 +01:00
"A list of common shell commands to be fontified especially in `sh-mode'.")
lang/sh: improve fontification for sh-mode + Fontify variables in double quotes (better) + Fontify command substitution in double quotes + Fontify built-in/common commands (see `+sh-builtin-keywords`)
2017-06-20 15:34:10 +02:00
;;
Minor refactor & revision across the board
2019-09-03 00:59:17 -04:00
;;; Packages
lang/sh: improve fontification for sh-mode + Fontify variables in double quotes (better) + Fontify command substitution in double quotes + Fontify built-in/common commands (see `+sh-builtin-keywords`)
2017-06-20 15:34:10 +02:00
:boom: Rename def-package! -> use-package! Calling this pivotal macro "def-package!" has frequently been a source of confusion. It is a thin wrapper around use-package, and it should be obvious that it is so. For this reason, and to match the naming convention used with other convenience macros/wrappers, it is now use-package!. Also changes def-package-hook! -> use-package-hook! The old macros are now marked obsolete and will be removed when straight integration is merged.
2019-07-23 12:44:03 +02:00
(use-package! sh-script ; built-in
Define sh-mode for bats files bats is a superset of shell script for writing automated tests exected with TAP. sh-mode works very well with bats files.
2021-06-24 08:47:47 +02:00
:mode ("\\.bats\\'" . sh-mode)
Minor refactor & reformatting across the board
2020-04-08 15:29:29 -04:00
:mode ("\\.\\(?:zunit\\|env\\)\\'" . sh-mode)
Major refactor & optimization of how modules load their packages Now that we are loading package autoloads files (as part of the generated doom-package-autoload-file when running make autoloads), many :commands properties are redundant. In fact, many def-package! blocks are redundant. In some cases, we can do without a config.el file entirely, and can move into the autoloads file or rely entirely on package autoloads. Also, many settings have been moved in their module's autoloads files, which makes them available ASAP; their use no longer depends on module load order. This gained me a modest ~10% boost in startup speed.
2018-05-25 00:46:11 +02:00
:mode ("/bspwmrc\\'" . sh-mode)
Refactor sh-mode config
2016-05-13 00:29:07 -04:00
:config
Set sh-mode's docsets to '("Bash").
2021-03-02 18:24:31 +07:00
(set-docsets! 'sh-mode "Bash")
Replace :electric with set-electric-rules! And general refactor of the emacs/electric-indent module. Also updates (set! :electric ...) references in various :lang modules
2018-06-15 12:30:56 +02:00
(set-electric! 'sh-mode :words '("else" "elif" "fi" "done" "then" "do" "esac" ";;"))
lang/sh: make shfmt indent-style aware Fixes #2905
2021-06-04 12:44:23 -04:00
(set-formatter! 'shfmt
'("shfmt" "-ci"
("-i" "%d" (unless indent-tabs-mode tab-width))
("-ln" "%s" (pcase sh-shell (`bash "bash") (`mksh "mksh") (_ "posix")))))
Standardize REPL commands & improve SPC o r - SPC o r now prompts for a REPL to open when none was found for the current buffer. - REPL handlers must now follow the naming convention "*/open*-repl". e.g. +python/open-ipython-repl, +emacs-lisp/open-repl, etc. - +eval/open-repl has been split in two: - +eval/open-repl-other-window - +eval/open-repl-same-window
2019-02-18 01:56:38 -05:00
(set-repl-handler! 'sh-mode #'+sh/open-repl)
lang/sh: use (wo)man for docs lookup handler i.e. Press K to look symbol at point up in man pages.
2021-02-23 19:22:22 -05:00
(set-lookup-handlers! 'sh-mode :documentation #'+sh-lookup-documentation-handler)
Move :ui pretty-code to :ui ligatures Includes a major refactor of the module.
2020-08-12 18:52:14 -04:00
(set-ligatures! 'sh-mode
refactor!(tree-sitter): add +tree-sitter flag BREAKING CHANGE: break the global nature of the tree sitter module by adding a +tree-sitter flag to every applicable module In the background this hooks turn-on-tree-sitter-mode to the major-mode-hook of the language. This may also solve the eager loading of tree sitter
2021-10-19 01:54:17 +01:00
;; Functional
:def "function"
;; Types
:true "true" :false "false"
;; Flow
:not "!"
:and "&&" :or "||"
:in "in"
:for "for"
:return "return"
;; Other
:dot "." :dot "source")
lang/sh: improve fontification for sh-mode + Fontify variables in double quotes (better) + Fontify command substitution in double quotes + Fontify built-in/common commands (see `+sh-builtin-keywords`)
2017-06-20 15:34:10 +02:00
Add lsp support to sh-mode.
2020-01-07 14:50:13 +02:00
(when (featurep! +lsp)
tweak(:lang,:tools): start eglot/lsp-mode later To ensure lsp/eglot settings have precedence over local servers (e.g. cider and lookup handlers). Ref: clojure-emacs/cider#3170
2022-03-24 02:19:52 +01:00
(add-hook 'sh-mode-local-vars-hook #'lsp! 'append))
Add lsp support to sh-mode.
2020-01-07 14:50:13 +02:00
sh: refactor config
2016-04-20 01:50:55 -04:00
(setq sh-indent-after-continuation 'always)
Remove doom-major-mode-names & doom|set-mode-name And replace it with buffer-local mode-name setters. This is more explicit and less magical, which is easier for users to discover and change, if they'd like.
2018-09-18 11:48:16 -04:00
;; [pedantry intensifies]
(setq-hook! 'sh-mode-hook mode-name "sh")
lang/sh: recognize functions w/ dashes in imenu
2017-10-21 14:49:57 +02:00
;; recognize function names with dashes in them
Refactor out map.el usage After some profiling, it turns out map-put and map-delete are 5-7x slower (more on Emacs 25) than delq, setf/alist-get and add-to-list for small lists (under 250 items), which is exactly how I've been using them. The only caveat is alist-get's signature is different on Emacs 25, thus a polyfill is necessary in core-lib.
2018-06-23 16:48:58 +02:00
(add-to-list 'sh-imenu-generic-expression
'(sh (nil "^\\s-*function\\s-+\\([[:alpha:]_-][[:alnum:]_-]*\\)\\s-*\\(?:()\\)?" 1)
(nil "^\\s-*\\([[:alpha:]_-][[:alnum:]_-]*\\)\\s-*()" 1)))
lang/sh: recognize functions w/ dashes in imenu
2017-10-21 14:49:57 +02:00
Add doom*shut-up advisor to core-lib
2018-04-23 00:03:28 -04:00
;; `sh-set-shell' is chatty about setting up indentation rules
:boom: revise advice naming convention (1/2) This is first of three big naming convention updates that have been a long time coming. With 2.1 on the horizon, all the breaking updates will batched together in preparation for the long haul. In this commit, we do away with the asterix to communicate that a function is an advice function, and we replace it with the '-a' suffix. e.g. doom*shut-up -> doom-shut-up-a doom*recenter -> doom-recenter-a +evil*static-reindent -> +evil--static-reindent-a The rationale behind this change is: 1. Elisp's own formatting/indenting tools would occasionally struggle with | and * (particularly pp and cl-prettyprint). They have no problem with / and :, fortunately. 2. External syntax highlighters (like pygmentize, discord markdown or github markdown) struggle with it, sometimes refusing to highlight code beyond these symbols. 3. * and | are less expressive than - and -- in communicating the intended visibility, versatility and stability of a function. 4. It complicated the regexps we must use to search for them. 5. They were arbitrary and over-complicated to begin with, decided on haphazardly way back when Doom was simply "my private config". Anyhow, like how predicate functions have the -p suffix, we'll adopt the -a suffix for advice functions, -h for hook functions and -fn for variable functions. Other noteable changes: - Replaces advice-{add,remove}! macro with new def-advice! macro. The old pair weren't as useful. The new def-advice! saves on a lot of space. - Removed "stage" assertions to make sure you were using the right macros in the right place. Turned out to not be necessary, we'll employ better checks later.
2019-07-18 15:42:52 +02:00
(advice-add #'sh-set-shell :around #'doom-shut-up-a)
lang/sh: silence indentation messages
2018-02-02 20:46:02 -05:00
lang/sh: improve fontification for sh-mode + Fontify variables in double quotes (better) + Fontify command substitution in double quotes + Fontify built-in/common commands (see `+sh-builtin-keywords`)
2017-06-20 15:34:10 +02:00
;; 1. Fontifies variables in double quotes
;; 2. Fontify command substitution in double quotes
;; 3. Fontify built-in/common commands (see `+sh-builtin-keywords')
Correct last inline hook defuns See a3e262c7 for rationale
2019-07-28 14:52:59 +02:00
(add-hook! 'sh-mode-hook
lang/sh: conform to new hook conventions
2019-07-25 12:16:58 +02:00
(defun +sh-init-extra-fontification-h ()
(font-lock-add-keywords
nil `((+sh--match-variables-in-quotes
(1 'font-lock-constant-face prepend)
(2 'font-lock-variable-name-face prepend))
(+sh--match-command-subst-in-quotes
(1 'sh-quoted-exec prepend))
Minor refactor & revision across the board
2019-09-03 00:59:17 -04:00
(,(regexp-opt +sh-builtin-keywords 'symbols)
lang/sh: conform to new hook conventions
2019-07-25 12:16:58 +02:00
(0 'font-lock-type-face append))))))
Enable rainbow-delimiters-mode in sh-mode
2018-08-20 00:33:19 +02:00
;; 4. Fontify delimiters by depth
(add-hook 'sh-mode-hook #'rainbow-delimiters-mode)
lang/sh: improve fontification for sh-mode + Fontify variables in double quotes (better) + Fontify command substitution in double quotes + Fontify built-in/common commands (see `+sh-builtin-keywords`)
2017-06-20 15:34:10 +02:00
Rethink smartparens config #181 + Parts of my smartparens config that were personal preference have been moved to my private module. + The css-mode config was redundant and was removed + Moved lang-specific config to their respective modules + Markdown config was redundant with native electric support, and thus removed.
2017-09-02 16:11:14 +02:00
;; autoclose backticks
lang/sh: remove zsh detection sh-mode already does its own detection for zsh, so this is unnecessary.
2019-10-19 13:52:27 -04:00
(sp-local-pair 'sh-mode "`" "`" :unless '(sp-point-before-word-p sp-point-before-same-p)))
Update modules/lang/*
2017-02-19 18:57:16 -05:00
:boom: Rename def-package! -> use-package! Calling this pivotal macro "def-package!" has frequently been a source of confusion. It is a thin wrapper around use-package, and it should be obvious that it is so. For this reason, and to match the naming convention used with other convenience macros/wrappers, it is now use-package!. Also changes def-package-hook! -> use-package-hook! The old macros are now marked obsolete and will be removed when straight integration is merged.
2019-07-23 12:44:03 +02:00
(use-package! company-shell
Reduce def-package magic; explicitly use :when property
2017-03-19 22:47:50 -04:00
:when (featurep! :completion company)
Add lsp support to sh-mode.
2020-01-07 14:50:13 +02:00
:unless (featurep! +lsp)
Massive refactor. Refactor all the things
2016-04-23 22:08:46 -04:00
:after sh-script
lang/sh: refactor
2017-03-20 16:32:29 -04:00
:config
Introduce autodefs to replace some settings + :popup -> set-popup-rule! + :popups -> set-popup-rules! + :company-backend -> set-company-backend! + :evil-state -> set-evil-initial-state! I am slowly phasing out the setting system (def-setting! and set!), starting with these. What are autodefs? These are functions that are always defined, whether or not their respective modules are enabled. However, when their modules are disabled, they are replaced with macros that no-op and don't waste time evaluating their arguments. The old set! function will still work, for a while.
2018-06-15 02:58:12 +02:00
(set-company-backend! 'sh-mode '(company-shell company-files))
fix(sh): disable meta fetch by default on mac OS The `whatis` command is excessively slow on mac OS, rendering company-shell unusable. Ref: #5839
2021-12-02 08:30:13 -05:00
(setq company-shell-delete-duplicates t
;; whatis lookups are exceptionally slow on macOS (#5860)
company-shell-dont-fetch-meta IS-MAC))
Massive refactor. Refactor all the things
2016-04-23 22:08:46 -04:00
:boom: Rename def-package! -> use-package! Calling this pivotal macro "def-package!" has frequently been a source of confusion. It is a thin wrapper around use-package, and it should be obvious that it is so. For this reason, and to match the naming convention used with other convenience macros/wrappers, it is now use-package!. Also changes def-package-hook! -> use-package-hook! The old macros are now marked obsolete and will be removed when straight integration is merged.
2019-07-23 12:44:03 +02:00
(use-package! fish-mode
Moved lang/fish into lang/sh +fish
2018-07-18 15:56:55 -04:00
:when (featurep! +fish)
:defer t
New :editor format module Centralized code formatting with built-in support for a variety of languages. Provides the set-formatter! function for defining your own. Still experimental and needs more testing!
2018-08-22 02:15:44 +02:00
:config (set-formatter! 'fish-mode #'fish_indent))
Added powershell flag to sh
2020-08-23 12:16:25 +01:00
(use-package! powershell
added defet for lazy loading and fixed indentation
2020-10-07 17:47:34 +01:00
:when (featurep! +powershell)
:defer t
:config
(when (featurep! +lsp)
tweak(:lang,:tools): start eglot/lsp-mode later To ensure lsp/eglot settings have precedence over local servers (e.g. cider and lookup handlers). Ref: clojure-emacs/cider#3170
2022-03-24 02:19:52 +01:00
(add-hook 'powershell-mode-local-vars-hook #'lsp! 'append)))
refactor!(tree-sitter): add +tree-sitter flag BREAKING CHANGE: break the global nature of the tree sitter module by adding a +tree-sitter flag to every applicable module In the background this hooks turn-on-tree-sitter-mode to the major-mode-hook of the language. This may also solve the eager loading of tree sitter
2021-10-19 01:54:17 +01:00
;; Tree sitter
(eval-when! (featurep! +tree-sitter)
(add-hook! 'sh-mode-hook #'turn-on-tree-sitter-mode))
Reference in a new issue Copy permalink