Got better write-good and proselint working.
My English is very good.
This commit is contained in:
Howard Abrams
parent
219d0ecea7
commit
5e3c45a9a8
2 changed files with 134 additions and 110 deletions
166
ha-org.org
166
ha-org.org
|
|
@ -7,7 +7,7 @@ A literate programming file for configuring org-mode and those files.
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp :exports none
|
#+BEGIN_SRC emacs-lisp :exports none
|
||||||
;;
|
;;
|
||||||
;; Copyright (C) 2020 Howard X. Abrams
|
;; ©2020 Howard X. Abrams
|
||||||
;;
|
;;
|
||||||
;; Author: Howard X. Abrams <http://gitlab.com/howardabrams>
|
;; Author: Howard X. Abrams <http://gitlab.com/howardabrams>
|
||||||
;; Maintainer: Howard X. Abrams
|
;; Maintainer: Howard X. Abrams
|
||||||
|
|
@ -55,8 +55,7 @@ One other helper routine is a =general= macro for org-mode files:
|
||||||
:non-normal-prefix "S-SPC")
|
:non-normal-prefix "S-SPC")
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
* Initialization Section
|
* Initialization Section
|
||||||
Org is an important part of my Emacs world, and with a lot of customization (even though Spacemacs and Doom do a good job getting things started).
|
Begin by initializing these org variables:
|
||||||
|
|
||||||
#+NAME: variables
|
#+NAME: variables
|
||||||
#+BEGIN_SRC emacs-lisp :tangle no
|
#+BEGIN_SRC emacs-lisp :tangle no
|
||||||
(setq org-return-follows-link t
|
(setq org-return-follows-link t
|
||||||
|
|
@ -68,17 +67,13 @@ Org is an important part of my Emacs world, and with a lot of customization (eve
|
||||||
; appear indented.
|
; appear indented.
|
||||||
|
|
||||||
sentence-end-double-space nil ; I jump around by sentences, but seldom have two spaces.
|
sentence-end-double-space nil ; I jump around by sentences, but seldom have two spaces.
|
||||||
;; Speed Commands: If point is at the beginning of a headline or code
|
|
||||||
;; block in org-mode, single keys do fun things. See
|
|
||||||
;; org-speed-command-help for details (or hit the ? key at a headline).
|
|
||||||
org-use-speed-commands t
|
|
||||||
|
|
||||||
org-export-with-sub-superscripts nil
|
org-export-with-sub-superscripts nil
|
||||||
|
|
||||||
org-directory "~/personal"
|
org-directory "~/personal"
|
||||||
org-default-notes-file "~/personal/general-notes.txt"
|
org-default-notes-file "~/personal/general-notes.txt"
|
||||||
|
|
||||||
org-enforce-todo-dependencies t ; Can't close a task until subtasks are done
|
org-enforce-todo-dependencies t ; Can't close a task without completed subtasks
|
||||||
org-agenda-dim-blocked-tasks t
|
org-agenda-dim-blocked-tasks t
|
||||||
org-log-done 'time
|
org-log-done 'time
|
||||||
|
|
||||||
|
|
@ -105,16 +100,16 @@ Files that end in =.txt= are still org files to me:
|
||||||
|
|
||||||
(add-to-list 'safe-local-variable-values '(org-content . 2))
|
(add-to-list 'safe-local-variable-values '(org-content . 2))
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
*Note:* Many of the files that I edit close some, but not all, of the headers using a file variable. Let's allow that to not insist that I need to approve that.
|
*Note:* Org mode files with the =org-content= variable setting will collapse two levels headers. Let's allow that without the need to approve that.
|
||||||
** Better Return
|
** Better Return
|
||||||
Hitting the ~Return~ key in an org file should format the following line based on context. For instance, at the end of a list, insert a new item.
|
Hitting the ~Return~ key in an org file should format the following line based on context. For instance, at the end of a list, insert a new item.
|
||||||
We begin with the interactive function that calls our code only if we are at the end of the line.
|
We begin with the interactive function that calls our code if we are at the end of the line.
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
(defun ha-org-return ()
|
(defun ha-org-return ()
|
||||||
"If at the end of a line, do something special based on the
|
"If at the end of a line, do something special based on the
|
||||||
information about the line by calling `ha-org-special-return',
|
information about the line by calling `ha-org-special-return',
|
||||||
otherwise, just call `org-return' as usual."
|
otherwise, `org-return' as usual."
|
||||||
(interactive)
|
(interactive)
|
||||||
(if (eolp)
|
(if (eolp)
|
||||||
(ha-org-special-return)
|
(ha-org-special-return)
|
||||||
|
|
@ -128,13 +123,13 @@ And bind it to the Return key:
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
What should we do if we are at the end of a line?
|
What should we do if we are at the end of a line?
|
||||||
- Given a prefix, call =org-return= as usual in an org file.
|
- Given a prefix, call =org-return= as usual in an org file.
|
||||||
- On a link, call =org-return= in order to open it.
|
- On a link, call =org-return= and open it.
|
||||||
- On a header? Let's create a new header (or maybe not).
|
- On a header? Create a new header.
|
||||||
- In a table? Let's create a new row.
|
- In a table? Create a new row.
|
||||||
- If we are really in a list, we can create a new item.
|
- In a list, create a new item.
|
||||||
|
|
||||||
I really should break this function into smaller bits ...
|
I should break this function into smaller bits ...
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
(defun ha-org-special-return (&optional ignore)
|
(defun ha-org-special-return (&optional ignore)
|
||||||
|
|
@ -178,22 +173,22 @@ I really should break this function into smaller bits ...
|
||||||
(org-return)))))
|
(org-return)))))
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
How do we know if we are in a list item? Lists end with two blank lines, so we need to make sure we are also not at the beginning of a line to avoid a loop where a new entry gets created with only one blank line.
|
How do we know if we are in a list item? Lists end with two blank lines, so we need to make sure we are also not at the beginning of a line to avoid a loop where a new entry gets created with one blank line.
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
(defun org-really-in-item-p ()
|
(defun org-really-in-item-p ()
|
||||||
"Similar to `org-in-item-p', however, this works around an
|
"Return item beginning position when in a plain list, nil otherwise.
|
||||||
issue where the point could actually be in some =code= words, but
|
Unlike `org-in-item-p', this works around an issue where the
|
||||||
still be on an item element."
|
point could actually be in some =code= words, but still be on an
|
||||||
(save-excursion
|
item element."
|
||||||
(let ((location (org-element-property :contents-begin (org-line-element-context))))
|
(save-excursion
|
||||||
(when location
|
(let ((location (org-element-property :contents-begin (org-line-element-context))))
|
||||||
(goto-char location))
|
(when location
|
||||||
(org-in-item-p))))
|
(goto-char location))
|
||||||
|
(org-in-item-p))))
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
The org API allows getting the context associated with /current element/. However, this could be a line-level symbol, like paragraph or =list-item= only if the point isn't /inside/ a bold or italics item. You know how HTML distinguishes between /block/ and /inline/ elements, org doesn't. So, let's make a function that makes that distinction:
|
The org API allows getting the context associated with the /current element/. This could be a line-level symbol, like paragraph or =list-item=, but always when the point isn't /inside/ a bold or italics item. You know how HTML distinguishes between /block/ and /inline/ elements, org doesn't. So, let's make a function that makes that distinction:
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
(defun org-line-element-context ()
|
(defun org-line-element-context ()
|
||||||
"Return the symbol of the current block element, e.g. paragraph or list-item."
|
"Return the symbol of the current block element, e.g. paragraph or list-item."
|
||||||
|
|
@ -215,27 +210,26 @@ And I would like to have cute little icons for those states:
|
||||||
|
|
||||||
#+NAME: org-font-lock
|
#+NAME: org-font-lock
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
(dolist (m '(org-mode org-journal-mode))
|
(dolist (m '(org-mode org-journal-mode))
|
||||||
(font-lock-add-keywords m ; A bit silly but my headers are now
|
(font-lock-add-keywords m ; A bit silly but my headers are now
|
||||||
`(("^\\*+ \\(TODO\\) " ; shorter, and that is nice canceled
|
`(("^\\*+ \\(TODO\\) " ; shorter, and that is nice canceled
|
||||||
(1 (progn (compose-region (match-beginning 1) (match-end 1) "⚑") nil)))
|
(1 (progn (compose-region (match-beginning 1) (match-end 1) "⚑") nil)))
|
||||||
("^\\*+ \\(DOING\\) "
|
("^\\*+ \\(DOING\\) "
|
||||||
(1 (progn (compose-region (match-beginning 1) (match-end 1) "⚐") nil)))
|
(1 (progn (compose-region (match-beginning 1) (match-end 1) "⚐") nil)))
|
||||||
("^\\*+ \\(CANCELED\\) "
|
("^\\*+ \\(CANCELED\\) "
|
||||||
(1 (progn (compose-region (match-beginning 1) (match-end 1) "✘") nil)))
|
(1 (progn (compose-region (match-beginning 1) (match-end 1) "✘") nil)))
|
||||||
("^\\*+ \\(BLOCKED\\) "
|
("^\\*+ \\(BLOCKED\\) "
|
||||||
(1 (progn (compose-region (match-beginning 1) (match-end 1) "✋") nil)))
|
(1 (progn (compose-region (match-beginning 1) (match-end 1) "✋") nil)))
|
||||||
("^\\*+ \\(DONE\\) "
|
("^\\*+ \\(DONE\\) "
|
||||||
(1 (progn (compose-region (match-beginning 1) (match-end 1) "✔") nil)))
|
(1 (progn (compose-region (match-beginning 1) (match-end 1) "✔") nil)))
|
||||||
;; Here is my approach for quickly making the
|
;; Here is my approach for making the initial asterisks for listing items and
|
||||||
;; initial asterisks for listing items and whatnot,
|
;; whatnot, appear as Unicode bullets ;; (without actually affecting the text
|
||||||
;; appear as Unicode bullets (without actually
|
;; file or the behavior).
|
||||||
;; affecting the text file or the behavior).
|
("^ +\\([-*]\\) "
|
||||||
("^ +\\([-*]\\) "
|
(0 (prog1 () (compose-region (match-beginning 1) (match-end 1) "•")))))))
|
||||||
(0 (prog1 () (compose-region (match-beginning 1) (match-end 1) "•")))))))
|
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
** Meetings
|
** Meetings
|
||||||
I've notice that while I really like taking notes in a meeting, I don't always like the multiple windows I have opened, so I created this function that I can easily call to eliminate distractions during a meeting.
|
I've notice that while showing a screen while taking meeting notes, I don't always like showing other windows, so I created this function to remove distractions during a meeting.
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
(defun meeting-notes ()
|
(defun meeting-notes ()
|
||||||
|
|
@ -243,7 +237,7 @@ I've notice that while I really like taking notes in a meeting, I don't always l
|
||||||
should be. After calling this function, call 'meeting-done' to reset the environment."
|
should be. After calling this function, call 'meeting-done' to reset the environment."
|
||||||
(interactive)
|
(interactive)
|
||||||
(outline-mark-subtree) ; Select org-mode section
|
(outline-mark-subtree) ; Select org-mode section
|
||||||
(narrow-to-region (region-beginning) (region-end)) ; Only show that region
|
(narrow-to-region (region-beginning) (region-end)) ; Show that region
|
||||||
(deactivate-mark)
|
(deactivate-mark)
|
||||||
(delete-other-windows) ; remove other windows
|
(delete-other-windows) ; remove other windows
|
||||||
(text-scale-set 2) ; readable by others
|
(text-scale-set 2) ; readable by others
|
||||||
|
|
@ -251,7 +245,7 @@ I've notice that while I really like taking notes in a meeting, I don't always l
|
||||||
(message "When finished taking your notes, run meeting-done."))
|
(message "When finished taking your notes, run meeting-done."))
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
Of course, I need an 'undo' feature when the meeting is over...
|
Of course, I need an 'undo' feature when the meeting is over…
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
(defun meeting-done ()
|
(defun meeting-done ()
|
||||||
|
|
@ -316,7 +310,7 @@ To make the snippets more context aware, this predicate
|
||||||
(plist-get (cadr (org-element-at-point)) :language)))
|
(plist-get (cadr (org-element-at-point)) :language)))
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
** Keybindings
|
** Keybindings
|
||||||
Keybindings available to all file buffers:
|
Global keybindings available to all file buffers:
|
||||||
#+NAME: global-keybindings
|
#+NAME: global-keybindings
|
||||||
#+BEGIN_SRC emacs-lisp :tangle no
|
#+BEGIN_SRC emacs-lisp :tangle no
|
||||||
(ha-leader
|
(ha-leader
|
||||||
|
|
@ -382,7 +376,7 @@ Bindings specific to org files:
|
||||||
"n w" '("widen" . widen))
|
"n w" '("widen" . widen))
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
Oh, and we'll use [[https://github.com/abo-abo/ace-link][ace-link]] for quickly jumping:
|
Oh, and we'll use [[https://github.com/abo-abo/ace-link][ace-link]] for jumping:
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
(use-package ace-link
|
(use-package ace-link
|
||||||
|
|
@ -392,7 +386,7 @@ Oh, and we'll use [[https://github.com/abo-abo/ace-link][ace-link]] for quickly
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
* Supporting Packages
|
* Supporting Packages
|
||||||
** Exporters
|
** Exporters
|
||||||
Limit the number of exporters to just the ones that I would use:
|
Limit the number of exporters to the ones that I would use:
|
||||||
#+NAME: ox-exporters
|
#+NAME: ox-exporters
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
(setq org-export-backends '(ascii html icalendar md odt))
|
(setq org-export-backends '(ascii html icalendar md odt))
|
||||||
|
|
@ -424,7 +418,7 @@ And we can install company support:
|
||||||
(use-package company-graphviz-dot)
|
(use-package company-graphviz-dot)
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
** Spell Checking
|
** Spell Checking
|
||||||
Let's hook some spell-checking into org files, and actually all text files. We'll use [[https://www.emacswiki.org/emacs/FlySpell][flyspell]] mode to highlight the misspelled words, and use the venerable [[https://www.emacswiki.org/emacs/InteractiveSpell][ispell]] for correcting (as it is less mousy).
|
Let's hook some spell-checking into org files, and actually all text files. We'll use [[https://www.emacswiki.org/emacs/FlySpell][flyspell]] mode to highlight the misspelled words, and use the venerable [[https://www.emacswiki.org/emacs/InteractiveSpell][ispell]] for correcting.
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
(use-package flyspell
|
(use-package flyspell
|
||||||
|
|
@ -496,7 +490,7 @@ Of course I need a thesaurus, and I'm installing [[https://github.com/SavchenkoV
|
||||||
"s r" '("related" . powerthesaurus-lookup-related-dwim)
|
"s r" '("related" . powerthesaurus-lookup-related-dwim)
|
||||||
"s S" '("sentence" . powerthesaurus-lookup-sentences-dwim)))
|
"s S" '("sentence" . powerthesaurus-lookup-sentences-dwim)))
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
The key-bindings, keystrokes, key-connections work well with just ~M-T~ (notice the Shift), but to jump to specifics, we use a leader. However, the /definitions/ do not work, so let's use abo-abo's [[https://github.com/abo-abo/define-word][define-word]] project:
|
The key-bindings, keystrokes, and key-connections work well with ~M-T~ (notice the Shift), but to jump to specifics, we use a leader. Since the /definitions/ do not work, so let's use abo-abo's [[https://github.com/abo-abo/define-word][define-word]] project:
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
(use-package define-word
|
(use-package define-word
|
||||||
|
|
@ -521,16 +515,60 @@ I've been working on my own [[http://www.howardism.org/Technical/Emacs/focused-w
|
||||||
"o f" '("begin focus" . ha-focus-begin)
|
"o f" '("begin focus" . ha-focus-begin)
|
||||||
"o F" '("break focus" . ha-focus-break)))
|
"o F" '("break focus" . ha-focus-break)))
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
** Writegood
|
** Grammar and Prose Linting
|
||||||
|
Flagging cliches, weak phrasing and other poor grammar choices.
|
||||||
The [[https://github.com/bnbeckwith/writegood-mode][writegood-mode]] highlights passive and weasel words as typed. Shame it doesn't check for dangled prepositions.
|
*** Writegood
|
||||||
|
The [[https://github.com/bnbeckwith/writegood-mode][writegood-mode]] is effective at highlighting passive and weasel words, but isn’t integrated into =flycheck=:
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp :tangle no
|
||||||
(use-package writegood-mode
|
(use-package writegood-mode
|
||||||
:hook ((org-mode . writegood-mode)))
|
:hook ((org-mode . writegood-mode)))
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
** Writeroom
|
|
||||||
For a complete focused, /distraction-free/ environment, for writing or just concentrating, I'm using [[https://github.com/joostkremers/writeroom-mode][Writeroom-mode]]:
|
We install the =write-good= NPM:
|
||||||
|
#+BEGIN_SRC shell
|
||||||
|
npm install -g write-good
|
||||||
|
#+END_SRC
|
||||||
|
|
||||||
|
And check that the following works:
|
||||||
|
#+BEGIN_SRC sh
|
||||||
|
write-good --text="So it is what it is."
|
||||||
|
#+END_SRC
|
||||||
|
|
||||||
|
Now, let’s connect it to flycheck:
|
||||||
|
#+BEGIN_SRC emacs-lisp
|
||||||
|
(flycheck-define-checker write-good
|
||||||
|
"A checker for prose"
|
||||||
|
:command ("write-good" "--parse" source-inplace)
|
||||||
|
:standard-input nil
|
||||||
|
:error-patterns
|
||||||
|
((warning line-start (file-name) ":" line ":" column ":" (message) line-end))
|
||||||
|
:modes (markdown-mode org-mode text-mode))
|
||||||
|
|
||||||
|
(add-to-list 'flycheck-checkers 'vale 'append)
|
||||||
|
#+END_SRC
|
||||||
|
*** Proselint
|
||||||
|
With overlapping goals to =write-good=, the [[https://github.com/amperser/proselint/][proselint]] project, once installed, can check for some English phrasings. I like =write-good= better, but I want this available for its level of /pedantic-ness/.
|
||||||
|
#+BEGIN_SRC sh
|
||||||
|
brew install proselint
|
||||||
|
#+END_SRC
|
||||||
|
|
||||||
|
Next, create a configuration file, =~/.config/proselint/config= file, to turn on/off checks:
|
||||||
|
#+BEGIN_SRC js :tangle ~/.config/proselint/config.json :mkdirp yes
|
||||||
|
{
|
||||||
|
"checks": {
|
||||||
|
"typography.diacritical_marks": false,
|
||||||
|
"consistency.spacing": false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
#+END_SRC
|
||||||
|
|
||||||
|
And tell [[https://www.flycheck.org/][flycheck]] to use this:
|
||||||
|
#+BEGIN_SRC emacs-lisp
|
||||||
|
(use-package flycheck
|
||||||
|
:config (add-to-list 'flycheck-checkers 'proselint))
|
||||||
|
#+END_SRC
|
||||||
|
** Write-room
|
||||||
|
For a complete focused, /distraction-free/ environment, for writing or concentrating, I'm using [[https://github.com/joostkremers/writeroom-mode][Writeroom-mode]]:
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
(use-package writeroom-mode
|
(use-package writeroom-mode
|
||||||
|
|
@ -548,9 +586,7 @@ For a complete focused, /distraction-free/ environment, for writing or just conc
|
||||||
("C-M-=" . writeroom-adjust-width)))
|
("C-M-=" . writeroom-adjust-width)))
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
* Technical Artifacts :noexport:
|
* Technical Artifacts :noexport:
|
||||||
|
Let's provide a name, to allow =require= to work:
|
||||||
Let's provide a name so that the file can be required:
|
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp :exports none
|
#+BEGIN_SRC emacs-lisp :exports none
|
||||||
(provide 'ha-org)
|
(provide 'ha-org)
|
||||||
;;; ha-org.el ends here
|
;;; ha-org.el ends here
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ A literate programming file for helping me program.
|
||||||
#+BEGIN_SRC emacs-lisp :exports none
|
#+BEGIN_SRC emacs-lisp :exports none
|
||||||
;;; general-programming.el --- A literate programming file for helping me program. -*- lexical-binding: t; -*-
|
;;; general-programming.el --- A literate programming file for helping me program. -*- lexical-binding: t; -*-
|
||||||
;;
|
;;
|
||||||
;; Copyright (C) 2020 Howard X. Abrams
|
;; Copyright © 2020 Howard X. Abrams
|
||||||
;;
|
;;
|
||||||
;; Author: Howard X. Abrams <http://gitlab.com/howardabrams>
|
;; Author: Howard X. Abrams <http://gitlab.com/howardabrams>
|
||||||
;; Maintainer: Howard X. Abrams
|
;; Maintainer: Howard X. Abrams
|
||||||
|
|
@ -25,9 +25,7 @@ A literate programming file for helping me program.
|
||||||
|
|
||||||
* Introduction
|
* Introduction
|
||||||
|
|
||||||
Seems that all programming interfaces and workflows behave similarly. However...
|
Seems that all programming interfaces and workflows behave similarly. However, one other helper routine is a =general= macro for org-mode files:
|
||||||
|
|
||||||
One other helper routine is a =general= macro for org-mode files:
|
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
(general-create-definer ha-prog-leader
|
(general-create-definer ha-prog-leader
|
||||||
:states '(normal visual motion)
|
:states '(normal visual motion)
|
||||||
|
|
@ -50,30 +48,14 @@ Farm off commands into /virtual environments/:
|
||||||
(direnv-mode))
|
(direnv-mode))
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
** Spell Checking Comments
|
** Spell Checking Comments
|
||||||
The [[https://www.emacswiki.org/emacs/FlySpell#h5o-2][flyspell-prog-mode]] only checks for misspellings in comments. Useful!
|
The [[https://www.emacswiki.org/emacs/FlySpell#h5o-2][flyspell-prog-mode]] only checks for misspellings in comments.
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
(use-package flyspell
|
(use-package flyspell
|
||||||
:hook (prog-mode . flyspell-prog-mode))
|
:hook (prog-mode . flyspell-prog-mode))
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
** Flymake
|
** Flycheck
|
||||||
Grab the latest version of [[https://www.emacswiki.org/emacs/FlyMake][Flymake]] in order to integrate with LSP. While we are at it, let’s add some keybindings.
|
Why use [[https://www.flycheck.org/][flycheck]] over the built-in =flymake=? Speed used to be the advantage, however, I’m now pushing this stuff to LSP, so speed is less of an issue. However, what about when I am not using LSP? Also, since I’ve hooked up grammar stuff to it, I need this with global keybindings.
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp :tangle no
|
|
||||||
(use-package flymake
|
|
||||||
:config
|
|
||||||
(ha-prog-leader
|
|
||||||
">" '("next problem" . flymake-goto-next-error)
|
|
||||||
"<" '("previous problem" . flymake-goto-prev-error)
|
|
||||||
"p" '(:ignore t :which-key "problems")
|
|
||||||
"p s" '("start checking" . flymake-start)
|
|
||||||
"p t" '("toggle flymake" . flymake-mode)
|
|
||||||
"p p" '("show problem" . flymake-show-diagnostic)
|
|
||||||
"p P" '("list all problems" . flymake-show-buffer-diagnostics)
|
|
||||||
"p l" '("show log buffer" . flymake-switch-to-log-buffer)
|
|
||||||
"p b" '("show log buffer" . flymake-running-backends)))
|
|
||||||
#+END_SRC
|
|
||||||
The question is why not use the newer [[https://www.flycheck.org/][flycheck]]? Speed used to be the advantage, however, I’m now pushing this stuff to LSP, so speed is less of an issue. However, what about when I am not using LSP?
|
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
(use-package flycheck
|
(use-package flycheck
|
||||||
|
|
@ -87,27 +69,27 @@ The question is why not use the newer [[https://www.flycheck.org/][flycheck]]? S
|
||||||
(global-flycheck-mode)
|
(global-flycheck-mode)
|
||||||
(ha-leader "t c" 'flycheck-mode)
|
(ha-leader "t c" 'flycheck-mode)
|
||||||
|
|
||||||
(ha-prog-leader
|
(ha-leader
|
||||||
">" '("next problem" . flycheck-next-error)
|
">" '("next problem" . flycheck-next-error)
|
||||||
"<" '("previous problem" . flycheck-previous-error)
|
"<" '("previous problem" . flycheck-previous-error)
|
||||||
|
|
||||||
"p" '(:ignore t :which-key "problems")
|
"P" '(:ignore t :which-key "problems")
|
||||||
"p b" '("error buffer" . flycheck-buffer)
|
"P b" '("error buffer" . flycheck-buffer)
|
||||||
"p c" '("clear" . flycheck-clear)
|
"P c" '("clear" . flycheck-clear)
|
||||||
"p n" '("next" . flycheck-next-error)
|
"P n" '("next" . flycheck-next-error)
|
||||||
"p p" '("previous" . flycheck-previous-error)
|
"P p" '("previous" . flycheck-previous-error)
|
||||||
"p l" '("list all" . flycheck-list-errors)
|
"P l" '("list all" . flycheck-list-errors)
|
||||||
"p y" '("copy errors" . flycheck-copy-errors-as-kill)
|
"P y" '("copy errors" . flycheck-copy-errors-as-kill)
|
||||||
"p s" '("select checker" . flycheck-select-checker)
|
"P s" '("select checker" . flycheck-select-checker)
|
||||||
"p ?" '("describe checker" . flycheck-describe-checker)
|
"P ?" '("describe checker" . flycheck-describe-checker)
|
||||||
"p h" '("display error" . flycheck-display-error-at-point)
|
"P h" '("display error" . flycheck-display-error-at-point)
|
||||||
"p e" '("explain error" . flycheck-explain-error-at-point)
|
"P e" '("explain error" . flycheck-explain-error-at-point)
|
||||||
"p H" '("help" . display-local-help)
|
"P H" '("help" . display-local-help)
|
||||||
"p i" '("manual" . flycheck-manual)
|
"P i" '("manual" . flycheck-manual)
|
||||||
"p V" '("version" . flycheck-version)
|
"P V" '("version" . flycheck-version)
|
||||||
"p v" '("verify-setup" . flycheck-verify-setup)
|
"P v" '("verify-setup" . flycheck-verify-setup)
|
||||||
"p x" '("disable-checker" . flycheck-disable-checker)
|
"P x" '("disable-checker" . flycheck-disable-checker)
|
||||||
"p t" '("toggle flycheck" . flycheck-mode)))
|
"P t" '("toggle flycheck" . flycheck-mode)))
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
** Documentation
|
** Documentation
|
||||||
I’ve used the [[http://kapeli.com/][Dash]] API Documentation browser (an external application) with Emacs, however, this is only available for Mac.
|
I’ve used the [[http://kapeli.com/][Dash]] API Documentation browser (an external application) with Emacs, however, this is only available for Mac.
|
||||||
|
|
@ -157,7 +139,7 @@ The [[https://github.com/blahgeek/emacs-devdocs-browser][devdocs-browser]] proje
|
||||||
"d O" '("remove download" . devdocs-browser-remove-offline-data)))
|
"d O" '("remove download" . devdocs-browser-remove-offline-data)))
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
** Language Server Protocol (LSP) Integration
|
** Language Server Protocol (LSP) Integration
|
||||||
The [[https://microsoft.github.io/language-server-protocol/][LSP]] is a way to connect /editors/ (like Emacs) to /languages/ (like Lisp) ... wait, no, it was originally designed for VS Code and probably Python, but we now abstract away [[https://github.com/davidhalter/jedi][Jedi]] and the [[http://tkf.github.io/emacs-jedi/latest/][Emacs integration to Jedi]] (and duplicate everything for Ruby, and Clojure, and...).
|
The [[https://microsoft.github.io/language-server-protocol/][LSP]] is a way to connect /editors/ (like Emacs) to /languages/ (like Lisp)… wait, no, it was originally designed for VS Code and probably Python, but we now abstract away [[https://github.com/davidhalter/jedi][Jedi]] and the [[http://tkf.github.io/emacs-jedi/latest/][Emacs integration to Jedi]] (and duplicate everything for Ruby, and Clojure, and…).
|
||||||
|
|
||||||
Instead, we install [[https://emacs-lsp.github.io/lsp-mode/][LSP Mode]] (and friends), which simplifies my configuration:
|
Instead, we install [[https://emacs-lsp.github.io/lsp-mode/][LSP Mode]] (and friends), which simplifies my configuration:
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
|
|
@ -218,7 +200,13 @@ The [[https://github.com/emacs-lsp/lsp-treemacs][lsp-treemacs]] offers a project
|
||||||
(ha-prog-leader
|
(ha-prog-leader
|
||||||
"0" '("treemacs" . lsp-treemacs-symbols)))
|
"0" '("treemacs" . lsp-treemacs-symbols)))
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
*** Origami Folding
|
||||||
|
The [[https://github.com/emacs-lsp/lsp-origami][lsp-origami]] project integrates the [[https://github.com/gregsexton/origami.el][origami]] project with LSP for /better code folding/:
|
||||||
|
|
||||||
|
#+BEGIN_SRC emacs-lisp
|
||||||
|
(use-package lsp-origami
|
||||||
|
:hook (lsp-after-open . lsp-origami-try-enable))
|
||||||
|
#+END_SRC
|
||||||
*** Debugging
|
*** Debugging
|
||||||
Do we want to use a debugger?
|
Do we want to use a debugger?
|
||||||
|
|
||||||
|
|
@ -334,7 +322,7 @@ Using the [[https://github.com/seagle0128/doom-modeline][Doom Modeline]] to add
|
||||||
(setq doom-modeline-env-version t)
|
(setq doom-modeline-env-version t)
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
* Languages
|
* Languages
|
||||||
Simple to configure languages go here. More advanced stuff will go in their own files...eventually.
|
Simple to configure languages go here. More advanced stuff will go in their own files… eventually.
|
||||||
** YAML and Jinja
|
** YAML and Jinja
|
||||||
Doing a lot of [[https://github.com/yoshiki/yaml-mode][YAML work]], but this project needs a new maintainer.
|
Doing a lot of [[https://github.com/yoshiki/yaml-mode][YAML work]], but this project needs a new maintainer.
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
|
|
@ -350,7 +338,7 @@ Ansible uses Jinja, so we install the [[https://github.com/paradoxxxzero/jinja2-
|
||||||
|
|
||||||
** Emacs Lisp
|
** Emacs Lisp
|
||||||
|
|
||||||
Why yes, I do find I code a lot in Emacs...
|
Why yes, I do find I code a lot in Emacs…
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
(ha-auto-insert-file (rx ".el" eol) "emacs-lisp-mode.el")
|
(ha-auto-insert-file (rx ".el" eol) "emacs-lisp-mode.el")
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
@ -428,7 +416,7 @@ And we just need to bind it. The following is Doom-specific:
|
||||||
"e c" '("current" . ha-eval-current-expression))
|
"e c" '("current" . ha-eval-current-expression))
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
*** Dim those Parenthesis
|
*** Dim those Parenthesis
|
||||||
The [[https://github.com/tarsius/paren-face][paren-face]] project lowers the color level of parenthesis which I personally find better.
|
The [[https://github.com/tarsius/paren-face][paren-face]] project lowers the color level of parenthesis which I find better.
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
(use-package paren-face
|
(use-package paren-face
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue