emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
doomemacs/modules/editor/format/autoload/settings.el

92 lines
3.5 KiB
EmacsLisp
Raw Normal View History

editor/format: format by diff & major refactor This redesigns how format-all applies changes. Before, it would erase the buffer and insert the formatted result. This would throw markers out of whack, and usually meant the cursor would end up somewhere else (e.g. the beginning of the file). Now, changes are made to the buffer line by line, via RCS patch. Other changes: + +format-region function was removed (replaced by +format-buffer and +format/region). + set-formatter! was moved to autoload/settings.el + New +format/buffer command to replace format-all-buffer
2018-08-29 12:48:38 +02:00
;;; editor/format/autoload/settings.el -*- lexical-binding: t; -*-
;;;###autodef
fix(format): removed unused argument
2023-09-13 10:20:39 +01:00
(cl-defun set-formatter! (name args &key modes)
editor/format: rewrite set-formatter! + 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)
2018-09-08 23:44:40 -04:00
"Define (or modify) a formatter named NAME.
docs(format): clarify how to update macro in private config
2023-09-14 16:44:43 +01:00
Supported keywords: :modes
editor/format: rewrite set-formatter! + 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)
2018-09-08 23:44:40 -04:00
NAME is a symbol that identifies this formatter.
FORMATTER can be a symbol referring to another formatter, a function, string or
nested list.
editor/format: format by diff & major refactor This redesigns how format-all applies changes. Before, it would erase the buffer and insert the formatted result. This would throw markers out of whack, and usually meant the cursor would end up somewhere else (e.g. the beginning of the file). Now, changes are made to the buffer line by line, via RCS patch. Other changes: + +format-region function was removed (replaced by +format-buffer and +format/region). + set-formatter! was moved to autoload/settings.el + New +format/buffer command to replace format-all-buffer
2018-08-29 12:48:38 +02:00
If a function, it should be a formatter function that
refactor(format): replace with apheleia Initial refactor of format module to replace format-all with apheleia
2022-08-16 08:13:55 +01:00
`apheleia--run-formatter-function' will accept.
Update & revise set-formatter! docstring
2018-08-29 15:56:59 +02:00
If a string, it is assumed to be a shell command that the buffer's text will
be piped to (through stdin).
If a list, it should represent a shell command as a list of arguments. Each
element is either a string or list (STRING ARG) where STRING is a format
editor/format: format by diff & major refactor This redesigns how format-all applies changes. Before, it would erase the buffer and insert the formatted result. This would throw markers out of whack, and usually meant the cursor would end up somewhere else (e.g. the beginning of the file). Now, changes are made to the buffer line by line, via RCS patch. Other changes: + +format-region function was removed (replaced by +format-buffer and +format/region). + set-formatter! was moved to autoload/settings.el + New +format/buffer command to replace format-all-buffer
2018-08-29 12:48:38 +02:00
string and ARG is both a predicate and argument for STRING. If ARG is nil,
STRING will be omitted from the vector.
docs(format): clarify how to update macro in private config
2023-09-14 16:44:43 +01:00
If you're trying to override this, ensure that you wrap the call in `after!' and
whichever package sets the initial formatter. See the ':editor format' README
for more.
docs(format): set-formatter!: escape quotes in docstring
2023-09-14 17:29:41 +02:00
For more information on how to structure the list to be compatible, see
`apheleia--run-formatter-function'.
refactor(format): replace with apheleia Initial refactor of format module to replace format-all with apheleia
2022-08-16 08:13:55 +01:00
editor/format: rewrite set-formatter! + 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)
2018-09-08 23:44:40 -04:00
MODES is a major mode, a list thereof, or a 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 purposes:
Update & revise set-formatter! docstring
2018-08-29 15:56:59 +02:00
editor/format: rewrite set-formatter! + 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)
2018-09-08 23:44:40 -04:00
1. It is a predicate for this formatter. Assuming the MAJOR-MODE matches the
current mode, if FORM evaluates to nil, the formatter is skipped.
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.
Update & revise set-formatter! docstring
2018-08-29 15:56:59 +02:00
editor/format: format by diff & major refactor This redesigns how format-all applies changes. Before, it would erase the buffer and insert the formatted result. This would throw markers out of whack, and usually meant the cursor would end up somewhere else (e.g. the beginning of the file). Now, changes are made to the buffer line by line, via RCS patch. Other changes: + +format-region function was removed (replaced by +format-buffer and +format/region). + set-formatter! was moved to autoload/settings.el + New +format/buffer command to replace format-all-buffer
2018-08-29 12:48:38 +02:00
Basic examples:
docs(format): set-formatter!: escape quotes in docstring
2023-09-14 17:29:41 +02:00
(set-formatter! \\='asmfmt \"asmfmt\" :modes \\='(asm-mode nasm-mode))
(set-formatter! \\='black \"black -q -\")
(set-formatter! \\='html-tidy \"tidy -q -indent\" :modes \\='(html-mode web-mode))
editor/format: format by diff & major refactor This redesigns how format-all applies changes. Before, it would erase the buffer and insert the formatted result. This would throw markers out of whack, and usually meant the cursor would end up somewhere else (e.g. the beginning of the file). Now, changes are made to the buffer line by line, via RCS patch. Other changes: + +format-region function was removed (replaced by +format-buffer and +format/region). + set-formatter! was moved to autoload/settings.el + New +format/buffer command to replace format-all-buffer
2018-08-29 12:48:38 +02:00
Advanced examples:
(set-formatter!
docs(format): set-formatter!: escape quotes in docstring
2023-09-14 17:29:41 +02:00
\\='clang-format
\\='(\"clang-format\"
editor/format: rewrite set-formatter! + 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)
2018-09-08 23:44:40 -04:00
(\"-assume-filename=%S\" (or buffer-file-name mode-result \"\")))
:modes
docs(format): set-formatter!: escape quotes in docstring
2023-09-14 17:29:41 +02:00
\\='((c-mode \".c\")
editor/format: format by diff & major refactor This redesigns how format-all applies changes. Before, it would erase the buffer and insert the formatted result. This would throw markers out of whack, and usually meant the cursor would end up somewhere else (e.g. the beginning of the file). Now, changes are made to the buffer line by line, via RCS patch. Other changes: + +format-region function was removed (replaced by +format-buffer and +format/region). + set-formatter! was moved to autoload/settings.el + New +format/buffer command to replace format-all-buffer
2018-08-29 12:48:38 +02:00
(c++-mode \".cpp\")
(java-mode \".java\")
(objc-mode \".m\")
editor/format: rewrite set-formatter! + 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)
2018-09-08 23:44:40 -04:00
(protobuf-mode \".proto\")))
editor/format: format by diff & major refactor This redesigns how format-all applies changes. Before, it would erase the buffer and insert the formatted result. This would throw markers out of whack, and usually meant the cursor would end up somewhere else (e.g. the beginning of the file). Now, changes are made to the buffer line by line, via RCS patch. Other changes: + +format-region function was removed (replaced by +format-buffer and +format/region). + set-formatter! was moved to autoload/settings.el + New +format/buffer command to replace format-all-buffer
2018-08-29 12:48:38 +02:00
docs(format): set-formatter!: escape quotes in docstring
2023-09-14 17:29:41 +02:00
(set-formatter! \\='html-tidy
\\='(\"tidy\" \"-q\" \"-indent\"
(\"-xml\" (memq major-mode \\='(nxml-mode xml-mode))))
editor/format: rewrite set-formatter! + 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)
2018-09-08 23:44:40 -04:00
:modes
docs(format): set-formatter!: escape quotes in docstring
2023-09-14 17:29:41 +02:00
\\='(html-mode
editor/format: format by diff & major refactor This redesigns how format-all applies changes. Before, it would erase the buffer and insert the formatted result. This would throw markers out of whack, and usually meant the cursor would end up somewhere else (e.g. the beginning of the file). Now, changes are made to the buffer line by line, via RCS patch. Other changes: + +format-region function was removed (replaced by +format-buffer and +format/region). + set-formatter! was moved to autoload/settings.el + New +format/buffer command to replace format-all-buffer
2018-08-29 12:48:38 +02:00
(web-mode (and (equal \"none\" web-mode-engine)
docs(format): set-formatter!: escape quotes in docstring
2023-09-14 17:29:41 +02:00
(car (member web-mode-content-type \\='(\"xml\" \"html\")))))))
editor/format: format by diff & major refactor This redesigns how format-all applies changes. Before, it would erase the buffer and insert the formatted result. This would throw markers out of whack, and usually meant the cursor would end up somewhere else (e.g. the beginning of the file). Now, changes are made to the buffer line by line, via RCS patch. Other changes: + +format-region function was removed (replaced by +format-buffer and +format/region). + set-formatter! was moved to autoload/settings.el + New +format/buffer command to replace format-all-buffer
2018-08-29 12:48:38 +02:00
docs(format): set-formatter!: escape quotes in docstring
2023-09-14 17:29:41 +02:00
(set-formatter! \\='html-tidy ; overwrite predefined html-tidy formatter
\\='(\"tidy\" \"-q\" \"-indent\"
editor/format: rewrite & fix set-formatter! + Updated docstring (and added two more examples) + Can now be used with shell command strings or string lists. String sublists can have more than 2 elements. Non-string items will be interpolated into the string before it. If any non-string item is nil, its sublist is omitted entirely. + Can now be used to redefine formatters predefined by the format-all package, by passing the formatter's name (as a symbol) as the first argument. + Added :modes property for cases when first argument isn't a major mode or list of them (when redefining a formatter).
2018-09-03 03:53:07 +02:00
\"--tidy-mark\" \"no\"
\"--drop-empty-elements\" \"no\"
\"--show-body-only\" \"auto\"
(\"--indent-spaces\" \"%d\" tab-width)
(\"--indent-with-tabs\" \"%s\" (if indent-tabs-mode \"yes\" \"no\"))
docs(format): set-formatter!: escape quotes in docstring
2023-09-14 17:29:41 +02:00
(\"-xml\" (memq major-mode \\='(nxml-mode xml-mode)))))
editor/format: rewrite & fix set-formatter! + Updated docstring (and added two more examples) + Can now be used with shell command strings or string lists. String sublists can have more than 2 elements. Non-string items will be interpolated into the string before it. If any non-string item is nil, its sublist is omitted entirely. + Can now be used to redefine formatters predefined by the format-all package, by passing the formatter's name (as a symbol) as the first argument. + Added :modes property for cases when first argument isn't a major mode or list of them (when redefining a formatter).
2018-09-03 03:53:07 +02:00
docs(format): set-formatter!: escape quotes in docstring
2023-09-14 17:29:41 +02:00
(set-formatter! \\='elm-format
\"elm-format --yes --stdin\")"
editor/format: format by diff & major refactor This redesigns how format-all applies changes. Before, it would erase the buffer and insert the formatted result. This would throw markers out of whack, and usually meant the cursor would end up somewhere else (e.g. the beginning of the file). Now, changes are made to the buffer line by line, via RCS patch. Other changes: + +format-region function was removed (replaced by +format-buffer and +format/region). + set-formatter! was moved to autoload/settings.el + New +format/buffer command to replace format-all-buffer
2018-08-29 12:48:38 +02:00
(declare (indent defun))
editor/format: rewrite set-formatter! + 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)
2018-09-08 23:44:40 -04:00
(cl-check-type name symbol)
bump: :editor format radian-software/apheleia@c222927f7086 -> radian-software/apheleia@56651724ad22 fbd00b6 changes aphelia-core to aphelia, but only in 1 out of 2 places and this is not the correct name in the version pinned in doom. Fix: #7568 Amend: fbd00b6a0830
2023-11-29 17:27:06 +01:00
(after! apheleia
refactor(format): replace with apheleia Initial refactor of format module to replace format-all with apheleia
2022-08-16 08:13:55 +01:00
(if (null args)
(progn
(setq apheleia-formatters
(assq-delete-all name apheleia-formatters))
(while (rassoc name apheleia-mode-alist)
(setq apheleia-mode-alist
(assq-delete-all (car (rassoc name apheleia-mode-alist)) apheleia-mode-alist))))
fix(format): resolve list expansion issues The argument list was being expanded incorrectly, this should now be resolved.
2022-08-14 16:17:36 +01:00
(let ((formatter (cond
((listp args) `(,@args))
(t args))))
(setf (alist-get name apheleia-formatters) formatter))
refactor(format): replace with apheleia Initial refactor of format module to replace format-all with apheleia
2022-08-16 08:13:55 +01:00
(when modes
(dolist (mode modes)
(setf (alist-get mode apheleia-mode-alist) name))))))
Reference in a new issue Copy permalink