emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

editor/format: rewrite set-formatter!

Browse source 
+ First argument is no longer a major mode or list thereof, it is NAME.
  Use :modes instead.
+ Updated docstring & examples.
+ Added formatting unsetting: (set-formatter! 'some-formatter nil)
This commit is contained in:
Henrik Lissner 2018-09-08 23:44:40 -04:00
parent e3d590784c
commit f6234e463a
No known key found for this signature in database
GPG key ID: 5F6C0EA160557395
1 changed files with 119 additions and 110 deletions
Download patch file Download diff file Expand all files Collapse all files

229
modules/editor/format/autoload/settings.el
View file

@ -1,5 +1,7 @@
;;; editor/format/autoload/settings.el -*- lexical-binding: t; -*- ;;; editor/format/autoload/settings.el -*- lexical-binding: t; -*-
;; This must be redefined here because `format-all' only makes it available at
;; compile time.
(defconst +format-system-type (defconst +format-system-type
(cl-case system-type (cl-case system-type
(windows-nt 'windows) (windows-nt 'windows)
@ -21,31 +23,83 @@
else if (eql +format-system-type (car choice)) else if (eql +format-system-type (car choice))
return (cadr choice))) return (cadr choice)))
(defun +format--make-command (formatter &rest _)
`(format-all-buffer-thunk
(lambda (input)
(with-silent-modifications
(setq buffer-file-name ,(buffer-file-name (buffer-base-buffer))
default-directory ,default-directory)
(delay-mode-hooks (funcall ',major-mode))
(insert input)
(condition-case e
(progn
(when doom-debug-mode
(message "formatter (commandp) %s" #',formatter))
(call-interactively #',formatter)
(list nil ""))
(error (list t (error-message-string e))))))))
(defun +format--make-function (formatter &rest _)
`(progn
(when doom-debug-mode
(message "formatter (functionp) %s" #',formatter))
(format-all-buffer-thunk #',formatter)))
(defun +format--make-shell-command (command ok-statuses error-regexp)
(+format--make-shell-command-list (split-string command " " t)
ok-statuses error-regexp))
(defun +format--make-shell-command-list (command-list ok-statuses error-regexp)
`(let (args)
(dolist (arg (list ,@command-list))
(cond ((stringp arg)
(push arg args))
((listp arg)
(catch 'skip
(let (subargs this)
(while (setq this (pop arg))
(cond ((not (stringp (car arg)))
(let ((val (eval (pop arg) t)))
(unless val (throw 'skip nil))
(push (format this val) subargs)))
((stringp this)
(push this subargs))))
(setq args (append subargs args)))))))
(when doom-debug-mode
(message "formatter (arglist) %s" args))
(if ,(and (or ok-statuses error-regexp) t)
(apply #'format-all-buffer-hard
',ok-statuses ,error-regexp
(reverse args))
(apply #'format-all-buffer-easy (reverse args)))))
(cl-defun +format--set (name &key function modes unset)
(declare (indent defun))
(when (and unset (not (gethash name format-all-format-table)))
(error "'%s' formatter does not exist to be unset"))
(puthash name function format-all-format-table)
(dolist (mode (doom-enlist modes))
(cl-destructuring-bind (m &optional probe)
(doom-enlist mode)
(if unset
(puthash m (assq-delete-all name (gethash key format-all-mode-table))
format-all-mode-table)
(format-all-pushhash
m (cons name (if probe `(lambda () ,probe)))
format-all-mode-table)))))
;;;###autodef ;;;###autodef
(cl-defun set-formatter! (cl-defun set-formatter!
(modes-or-name formatter (name formatter &key modes filter ok-statuses error-regexp)
&key "Define (or modify) a formatter named NAME.
name
modes
install
filter
ok-statuses
error-regexp)
"Define a formatter.
MODES-OR-NAME can either be a major mode symbol (or list thereof), a unique name Supported keywords: :modes :install :filter :ok-statuses :error-regexp
for the formatter being defined (also a symbol), or a special list of
two-element sublists with the structure: (MAJOR-MODE FORM).
FORM is evaluated when the buffer is formatted and its return value serves two NAME is a symbol that identifies this formatter.
purposes:
1. It is a predicate for this formatter. Assuming the MAJOR-MODE matches the FORMATTER can be a symbol referring to another formatter, a function, string or
current mode, if FORM evaluates to nil, the formatter is skipped. nested list.
2. It's return value is made available to FORMATTER if it is a function or list
of shell arguments via the `mode-result' variable.
FORMATTER can be a function, string or nested list.
If a function, it should be a formatter function that If a function, it should be a formatter function that
`format-all-buffer-thunk' will accept. `format-all-buffer-thunk' will accept.
@ -56,15 +110,14 @@ FORMATTER can be a function, string or nested list.
string and ARG is both a predicate and argument for STRING. If ARG is nil, string and ARG is both a predicate and argument for STRING. If ARG is nil,
STRING will be omitted from the vector. STRING will be omitted from the vector.
NAME is a symbol that identifies this formatter. If NAME isn't specified and MODES is a major mode, a list thereof, or a list of two-element sublists with
FORMATTER is a function symbol, the symbol's name is used. If FORMATTER is a the structure: (MAJOR-MODE FORM). FORM is evaluated when the buffer is formatted
string or list of strings, the executable is extracted from it and used as the and its return value serves two purposes:
NAME. If FORMATTER is a lambda, NAME is required and will error if omitted. Note
that any formatters with the same NAME will be overwritten by FORMATTER.
INSTALL is a string representing the shell command to install this formatter's 1. It is a predicate for this formatter. Assuming the MAJOR-MODE matches the
dependencies. INSTALL can also be a two-element list: (OS COMMAND), or a list of current mode, if FORM evaluates to nil, the formatter is skipped.
these. OS can be windows, macos, linux, freebsd, openbsd or netbsd. 2. It's return value is made available to FORMATTER if it is a function or
list of shell arguments via the `mode-result' variable.
FILTER is a function that takes three arguments: the formatted output, any error FILTER is a function that takes three arguments: the formatted output, any error
output and the position of the first change. This function must return these output and the position of the first change. This function must return these
@ -81,30 +134,32 @@ OK-STATUSES.
Basic examples: Basic examples:
(set-formatter! '(asm-mode nasm-mode) \"asmfmt\") (set-formatter! 'asmfmt \"asmfmt\" :modes '(asm-mode nasm-mode))
(set-formatter! 'python-mode \"black -q -\" :install \"pip install black\") (set-formatter! 'black \"black -q -\")
(set-formatter! 'tidy \"tidy -q -indent\" :modes '(html-mode web-mode)) (set-formatter! 'html-tidy \"tidy -q -indent\" :modes '(html-mode web-mode))
Advanced examples: Advanced examples:
(set-formatter! (set-formatter!
'clang-format
'(\"clang-format\"
(\"-assume-filename=%S\" (or buffer-file-name mode-result \"\")))
:modes
'((c-mode \".c\") '((c-mode \".c\")
(c++-mode \".cpp\") (c++-mode \".cpp\")
(java-mode \".java\") (java-mode \".java\")
(objc-mode \".m\") (objc-mode \".m\")
(protobuf-mode \".proto\")) (protobuf-mode \".proto\")))
'(\"clang-format\"
(\"-assume-filename=%S\" (or buffer-file-name mode-result \"\")))
:install '(macos \"brew install clang-format\"))
(set-formatter! (set-formatter! 'html-tidy
'(\"tidy\" \"-q\" \"-indent\"
(\"-xml\" (memq major-mode '(nxml-mode xml-mode))))
:modes
'(html-mode '(html-mode
(web-mode (and (equal \"none\" web-mode-engine) (web-mode (and (equal \"none\" web-mode-engine)
(car (member web-mode-content-type '(\"xml\" \"html\")))))) (car (member web-mode-content-type '(\"xml\" \"html\"))))))
'(\"tidy\" \"-q\" \"-indent\"
(\"-xml\" (memq major-mode '(nxml-mode xml-mode))))
:ok-statuses '(0 1) :ok-statuses '(0 1)
:install '(macos \"brew install tidy-html5\")) :executable \"tidy\")
(set-formatter! 'html-tidy ; overwrite predefined html-tidy formatter (set-formatter! 'html-tidy ; overwrite predefined html-tidy formatter
'(\"tidy\" \"-q\" \"-indent\" '(\"tidy\" \"-q\" \"-indent\"
@ -116,82 +171,36 @@ Advanced examples:
(\"-xml\" (memq major-mode '(nxml-mode xml-mode)))) (\"-xml\" (memq major-mode '(nxml-mode xml-mode))))
:ok-statuses '(0 1))) :ok-statuses '(0 1)))
(set-formatter! 'elm-mode (set-formatter! 'elm-format
\"elm-format --yes --stdin\" \"elm-format --yes --stdin\"
:install '(macos \"brew install elm\")
:filter :filter
(lambda (output errput first-diff) (lambda (output errput first-diff)
(list output (list output
(format-all-remove-ansi-color errput) (format-all-remove-ansi-color errput)
first-diff)))" first-diff)))"
(declare (indent defun)) (declare (indent defun))
(cl-check-type name (or symbol null)) (cl-check-type name symbol)
;; Determine if MODES-OR-NAME means MODES or NAMES (after! format-all
(if (and (symbolp modes-or-name) (if (null formatter)
(not (string-match-p "-mode$" (symbol-name modes-or-name)))) (+format--set name
(setq name modes-or-name) :unset t
(setq modes (doom-enlist modes-or-name))) :modes modes)
(let* ((command-list (cond ((stringp formatter) ; shell command (let ((fn (funcall (cond ((stringp formatter)
(split-string formatter " " t)) #'+format--make-shell-command)
((listp formatter) ; shell command in lists ((listp formatter)
formatter))) #'+format--make-shell-command-list)
(name (cond (name) ((and (commandp formatter)
((car command-list) (intern (car command-list))) (not (stringp formatter)))
((symbolp formatter) formatter) #'+format--make-command)
((user-error "Anonymous formatter requires a :name")))) ((functionp formatter)
(formatter #'+format--make-function))
(cond ((commandp formatter) formatter
`(format-all-buffer-thunk ok-statuses
(lambda (input) error-regexp)))
(with-silent-modifications (cl-check-type filter (or function null))
(setq buffer-file-name ,(buffer-file-name (buffer-base-buffer)) (+format--set name
default-directory ,default-directory) :function
(delay-mode-hooks (funcall ',major-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))
(`(let (args)
(dolist (arg ',command-list)
(cond ((stringp arg) (push arg args))
((listp arg)
(catch 'skip
(let (subargs this)
(while (setq this (pop arg))
(cond ((not (stringp (car arg)))
(let ((val (eval (pop arg) t)))
(unless val (throw 'skip nil))
(push (format this val) subargs)))
((stringp this)
(push this subargs))))
(setq args (append subargs args)))))))
(if ,(and (or ok-statuses error-regexp) t)
(apply #'format-all-buffer-hard
',ok-statuses ,error-regexp
(reverse args))
(apply #'format-all-buffer-easy (reverse args)))))))
(fn
`(lambda (executable mode-result) `(lambda (executable mode-result)
(let ((result ,formatter)) ,(if filter `(apply #',filter ,fn) fn))
,(if filter :modes modes)
`(apply #',filter result) name))))
'result))))
(install (cond ((null install) install)
((listp install)
(cdr (assq (+format--resolve-system) install)))
(install))))
(after! format-all
(puthash name (eval fn t) format-all-format-table)
(puthash name (car command-list) format-all-executable-table)
(puthash name (or install (gethash name format-all-install-table))
format-all-install-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))