summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorProtesilaos Stavrou <info@protesilaos.com>2023-02-10 14:18:48 +0200
committerProtesilaos Stavrou <info@protesilaos.com>2023-02-10 14:30:52 +0200
commit112970f8d2355c0cfa0269bb92cd1ecc18790bc9 (patch)
tree8bd8a6e47034cce1029262a9b64c03ba0c3e7ba2
parentd478c08213b69ffbc5450b373484c19cafaa5f04 (diff)
Update to version 1.0.0
-rw-r--r--CHANGELOG.org41
-rw-r--r--sxhkdrc-mode.el2
2 files changed, 42 insertions, 1 deletions
diff --git a/CHANGELOG.org b/CHANGELOG.org
new file mode 100644
index 0000000..448764e
--- /dev/null
+++ b/CHANGELOG.org
@@ -0,0 +1,41 @@
+#+title: Change log of sxhkdrc-mode
+#+author: Protesilaos Stavrou
+#+email: info@protesilaos.com
+#+options: ':nil toc:nil num:nil author:nil email:nil
+
+This document contains the release notes for each tagged commit on the
+project's main git repository: <https://git.sr.ht/~protesilaos/sxhkdrc-mode>.
+
+The newest release is at the top. For further details, please consult
+the manual: <https://protesilaos.com/emacs/sxhkdrc-mode>.
+
+* 1.0.0
+
+This version addresses all the issues that were present in the
+original release of ~sxhkdrc-mode~. The package should now provide a
+fully fledged major mode for editing =sxhkdrc= files. Concretely, I
+have made the following user-facing changes:
+
+- Refined the indentation rules. The indent function is robust: it
+ knows how to correctly align (i) key definitions, (ii) commands,
+ (iii) commands with continuation lines per the =\= shell script
+ notation. Furthermore, indentation is no longer added to wrong
+ places, such as at the end of a line.
+
+- Added support for an Imenu index (use =M-x imenu= or the better =M-x
+ consult-imenu= from the ~consult~ package). This provides a
+ minibuffer completion interface to all relevant syntactic constructs
+ in the buffer. The index consists of entries for keys and commands.
+
+- Defined an ~outline-regexp~. One can now use ~sxhkdrc-mode~ in
+ tandem with =M-x outline-minor-mode=. The outline consists of any
+ comment that starts with at least three comment characters (=#=).
+ Use this to create headings in the document that can be folded in an
+ Org-style fashion and/or navigate between them with minibuffer
+ completion with the command ~consult-outline~.
+
+ [ Also see my ~logos~ package for more with pages/sections/headings. ]
+
+- Rectified the "filling" of comments. With default key bindings,
+ this is done with =M-q= for ~fill-paragraph~.
+
diff --git a/sxhkdrc-mode.el b/sxhkdrc-mode.el
index 80a93c9..39e66f2 100644
--- a/sxhkdrc-mode.el
+++ b/sxhkdrc-mode.el
@@ -6,7 +6,7 @@
;; Maintainer: Protesilaos Stavrou General Issues <~protesilaos/general-issues@lists.sr.ht>
;; URL: https://git.sr.ht/~protesilaos/sxhkdrc-mode
;; Mailing-List: https://lists.sr.ht/~protesilaos/general-issues
-;; Version: 0.1.5
+;; Version: 1.0.0
;; Package-Requires: ((emacs "27.1"))
;; This file is NOT part of GNU Emacs.