e932c74758
Also renames +format|on-save to +format|buffer for clarity. It should not (normally) be used directly. Use `+format|enable-on-save-maybe` and `+format|enable-on-save`.
234 lines
9.2 KiB
EmacsLisp
234 lines
9.2 KiB
EmacsLisp
;;; editor/format/autoload.el -*- lexical-binding: t; -*-
|
|
|
|
;;;###autoload
|
|
(defun +format--resolve-system (choices)
|
|
"Get first choice matching `format-all-system-type' from CHOICES."
|
|
(cl-loop for choice in choices
|
|
if (atom choice) return choice
|
|
else if (eql format-all-system-type (car choice))
|
|
return (cadr choice)))
|
|
|
|
;;;###autodef
|
|
(cl-defun set-formatter! (modes formatter &key
|
|
name
|
|
install
|
|
filter
|
|
ok-statuses
|
|
error-regexp)
|
|
"Define a FORMATTER for MODES.
|
|
|
|
MODES can be a major mode symbol, a vector of major modes, or a vector of
|
|
two-element vectors made up of [MAJOR-MODE FORM]. FORM is evaluated when the
|
|
buffer is formatted and its return value is a predicate for this formatter. Its
|
|
return value is stored in If it is non-nil, this formatter is used. Its return
|
|
value is stored in the `mode-result' variable for FORMATTER (if it's not a
|
|
string).
|
|
|
|
FORMATTER can be a function, string or nested vector.
|
|
|
|
If a function, it should be a formatter function that
|
|
`format-all-buffer-thunk' will accept.
|
|
If a string, it is assumed to be a shell command that the text will be piped
|
|
to (stdin).
|
|
If a vector, it should represent a shell command as a list of arguments. Each
|
|
element is either a string or vector [STRING ARG] where STRING is a format
|
|
string and ARG is both a predicate and argument for STRING. If ARG is nil,
|
|
STRING will be omitted from the vector.
|
|
|
|
NAME is the identifier for this formatter. If FORMATTER is a lambda, NAME will
|
|
default to \"default\".
|
|
|
|
INSTALL should be a string representing the shell command necessary to install
|
|
this formatter's dependencies. INSTALL can also be a list of lists made up of
|
|
two items: (OS COMMAND).
|
|
|
|
Basic examples:
|
|
|
|
(set-formatter! '(asm-mode nasm-mode) \"asmfmt\")
|
|
(set-formatter! 'python-mode \"black -q -\" :install \"pip install black\")
|
|
|
|
Advanced examples:
|
|
|
|
(set-formatter!
|
|
'((c-mode \".c\")
|
|
(c++-mode \".cpp\")
|
|
(java-mode \".java\")
|
|
(objc-mode \".m\")
|
|
(protobuf-mode \".proto\"))
|
|
'(\"clang-format\"
|
|
(\"-assume-filename=%S\" (or buffer-file-name mode-result \"\")))
|
|
:install '(macos \"brew install clang-format\"))
|
|
|
|
(set-formatter!
|
|
'(html-mode
|
|
(web-mode (and (equal \"none\" web-mode-engine)
|
|
(car (member web-mode-content-type '(\"xml\" \"html\"))))))
|
|
'(\"tidy\" \"-q\" \"-indent\"
|
|
(\"-xml\" (memq major-mode '(nxml-mode xml-mode))))
|
|
:ok-statuses '(0 1)
|
|
:install '(macos \"brew install tidy-html5\"))
|
|
|
|
(set-formatter! 'elm-mode
|
|
\"elm-format --yes --stdin\"
|
|
:install '(macos \"brew install elm\")
|
|
:filter
|
|
(lambda (output errput first-diff)
|
|
(list output
|
|
(format-all-remove-ansi-color errput)
|
|
first-diff)))"
|
|
(declare (indent defun))
|
|
(cl-check-type name (or symbol null))
|
|
(let* ((command-list (cond ((stringp formatter) ; shell command
|
|
(split-string formatter " " t))
|
|
((listp formatter) ; shell command in lists
|
|
formatter)))
|
|
(name (cond (name)
|
|
((car command-list) (intern (car command-list)))
|
|
((symbolp formatter) formatter)
|
|
((user-error "Anonymous formatter requires a :name"))))
|
|
(fn (lambda (executable mode-result)
|
|
(let ((result
|
|
(cond ((commandp formatter)
|
|
(let ((mode major-mode)
|
|
(file buffer-file-name)
|
|
(dir default-directory))
|
|
(format-all-buffer-thunk
|
|
(lambda (input)
|
|
(with-silent-modifications
|
|
(setq buffer-file-name file
|
|
default-directory dir)
|
|
(delay-mode-hooks (funcall mode))
|
|
(insert input)
|
|
(condition-case e
|
|
(progn
|
|
(call-interactively formatter)
|
|
(list nil ""))
|
|
(error (list t (error-message-string e)))))))))
|
|
((functionp formatter)
|
|
(format-all-buffer-thunk formatter))
|
|
((cl-loop for arg in command-list
|
|
if (stringp arg)
|
|
collect arg into args
|
|
else if (eval (cadr arg) t)
|
|
collect (format (car arg) it) into args
|
|
finally do
|
|
(if (or ok-statuses error-regexp)
|
|
(apply #'format-all-buffer-hard ok-statuses error-regexp args)
|
|
(apply #'format-all-buffer-easy args)))))))
|
|
(if filter
|
|
(apply filter result)
|
|
result))))
|
|
(install (cond ((null install) install)
|
|
((listp install)
|
|
(cdr (assq (+format--resolve-system) install)))
|
|
(install))))
|
|
(after! format-all
|
|
(puthash name fn format-all-format-table)
|
|
(puthash name install format-all-install-table)
|
|
(puthash name (car command-list) format-all-executable-table)
|
|
(dolist (mode (doom-enlist modes))
|
|
(cl-destructuring-bind (m &optional probe)
|
|
(doom-enlist mode)
|
|
(format-all-pushhash
|
|
m (cons name (if probe `(lambda () ,probe)))
|
|
format-all-mode-table))))
|
|
name))
|
|
|
|
;;;###autoload
|
|
(defun +format-region (beg end)
|
|
"Runs the active formatter on the selected region."
|
|
(cl-check-type beg integer)
|
|
(cl-check-type end integer)
|
|
;; TODO Refactor me
|
|
;; Hack ahoy! We force format-all (and the programs it delegates to) to only
|
|
;; format a region rather than the whole buffer.
|
|
(require 'format-all)
|
|
(save-restriction
|
|
(let* ((beg (save-excursion (goto-char beg) (line-beginning-position)))
|
|
(end (save-excursion (goto-char end)
|
|
(if (bolp) (backward-char))
|
|
(line-end-position)))
|
|
(file buffer-file-name)
|
|
(dir default-directory)
|
|
(mode major-mode)
|
|
(input (buffer-substring-no-properties beg end))
|
|
(leading-indent 0)
|
|
final-output)
|
|
(with-temp-buffer
|
|
(with-silent-modifications
|
|
(setq buffer-file-name file
|
|
default-directory dir)
|
|
(delay-mode-hooks (funcall mode))
|
|
(save-excursion (insert input))
|
|
(setq leading-indent (current-indentation))
|
|
(indent-rigidly (point-min) (point-max) (- leading-indent))
|
|
;; From `format-all-buffer'
|
|
(cl-destructuring-bind (formatter mode-result) (format-all-probe)
|
|
(unless formatter (error "Don't know how to format %S code" major-mode))
|
|
(let ((f-function (gethash formatter format-all-format-table))
|
|
(executable (format-all-formatter-executable formatter)))
|
|
(cl-destructuring-bind (output errput first-diff)
|
|
(funcall f-function executable mode-result)
|
|
(cl-case output
|
|
((nil)
|
|
(message "Syntax error"))
|
|
((t)
|
|
(message "Already formatted"))
|
|
(t
|
|
(erase-buffer)
|
|
(insert output)
|
|
(indent-rigidly (point-min) (point-max) leading-indent)
|
|
(setq final-output (string-trim-right (buffer-string)))))
|
|
(with-current-buffer (get-buffer-create "*format-all-errors*")
|
|
(erase-buffer)
|
|
(unless (= 0 (length errput))
|
|
(insert errput)
|
|
(display-buffer (current-buffer)))))))))
|
|
(when final-output
|
|
(message "Reformatted!")
|
|
(save-excursion
|
|
(goto-char beg)
|
|
(delete-region beg end)
|
|
(insert final-output))))))
|
|
|
|
|
|
;;
|
|
;; Commands
|
|
;;
|
|
|
|
;;;###autoload
|
|
(defalias '+format/buffer 'format-all-buffer)
|
|
|
|
;;;###autoload
|
|
(defun +format/region (beg end)
|
|
"Runs the active formatter on the lines within BEG and END.
|
|
|
|
WARNING: this may not work everywhere. It will throw errors if the region
|
|
contains a syntax error in isolation. It is mostly useful for formatting
|
|
snippets or single lines."
|
|
(interactive "r")
|
|
(+format-region beg end))
|
|
|
|
;;;###autoload
|
|
(defun +format/region-or-buffer (beg end)
|
|
"Runs the active formatter on the selected region (or whole buffer, if nothing
|
|
is selected)."
|
|
(interactive "r")
|
|
(if (use-region-p)
|
|
(+format-region beg end)
|
|
(format-all-buffer)))
|
|
|
|
|
|
;;
|
|
;; Hooks
|
|
;;
|
|
|
|
;;;###autoload
|
|
(defun +format|enable-on-save ()
|
|
"Enables formatting on save."
|
|
(add-hook 'before-save-hook #'+format|buffer nil t))
|
|
|
|
;;;###autoload
|
|
(defun +format|buffer ()
|
|
"Runs `format-all-buffer' immediately, without moving the cursor."
|
|
(save-excursion (format-all-buffer)))
|