branch: externals/denote
commit ac21068d3ca420cd9c54af95b5bff6972978e070
Author: Jean-Philippe Gagné Guay <jeanphilippe...@gmail.com>
Commit: Jean-Philippe Gagné Guay <jeanphilippe...@gmail.com>
Allow consecutive hyphens in file name titles
---
denote.el | 44 +++++++++++++++++++++++++++-----------------
1 file changed, 27 insertions(+), 17 deletions(-)
diff --git a/denote.el b/denote.el
index 04f1695123..0264cc0871 100644
--- a/denote.el
+++ b/denote.el
@@ -714,7 +714,7 @@ The note's ID is derived from the date and time of its
creation.")
(defconst denote-signature-regexp
"==\\([^.]*?\\)\\(==.*\\|--.*\\|__.*\\|\\..*\\)*$"
"Regular expression to match the SIGNATURE field in a file name.")
-(defconst denote-title-regexp
"--\\([^.]*?\\)\\(==.*\\|--.*\\|__.*\\|\\..*\\)*$"
+(defconst denote-title-regexp "--\\([^.]*?\\)\\(==.*\\|__.*\\|\\..*\\)*$"
"Regular expression to match the TITLE field in a file name.")
(defconst denote-keywords-regexp
"__\\([^.]*?\\)\\(==.*\\|--.*\\|__.*\\|\\..*\\)*$"
@@ -821,23 +821,32 @@ leading and trailing hyphen."
(replace-regexp-in-string "_\\|\s+" "-" str))))
(defun denote--remove-dot-characters (str)
- "Remove the dot character from STR."
+ "Remove dot characters from STR."
(replace-regexp-in-string "\\." "" str))
-(defun denote--trim-right-token-characters (str)
- "Remove =, - and _ from the end of STR."
- (string-trim-right str "[=_-]+"))
+(defun denote--trim-right-token-characters (str component)
+ "Remove =, - and _ from the end of STR.
+The removal is done only if necessary according to COMPONENT."
+ (if (eq component 'title)
+ (string-trim-right str "[=_]+")
+ (string-trim-right str "[=_-]+")))
-(defun denote--replace-consecutive-token-characters (str)
+(defun denote--replace-consecutive-token-characters (str component)
"Replace consecutive characters with a single one in STR.
-Spaces, underscores and equal signs are replaced with a single
-one in str."
- (replace-regexp-in-string
- "-\\{2,\\}" "-"
- (replace-regexp-in-string
- "_\\{2,\\}" "_"
+Hyphens, underscores and equal signs are replaced with a single
+one in str, if necessary according to COMPONENT."
+ ;; -- are allowed in titles
+ (if (eq component 'title)
+ (replace-regexp-in-string
+ "_\\{2,\\}" "_"
+ (replace-regexp-in-string
+ "=\\{2,\\}" "=" str))
(replace-regexp-in-string
- "=\\{2,\\}" "=" str))))
+ "-\\{2,\\}" "-"
+ (replace-regexp-in-string
+ "_\\{2,\\}" "_"
+ (replace-regexp-in-string
+ "=\\{2,\\}" "=" str)))))
(defun denote-sluggify (component str)
"Make STR an appropriate slug for file name COMPONENT.
@@ -845,9 +854,10 @@ one in str."
Apply the function specified in `denote-file-name-slug-function'
to COMPONENT which is one of `title', `signature', `keyword'. If
the resulting string still contains consecutive -,_ or =, they
-are replaced by a single occurence of the character. If
-COMPONENT is `keyword', remove underscores from STR as they are
-used as the keywords separator in file names."
+are replaced by a single occurence of the character, if necessary
+according to COMPONENT. If COMPONENT is `keyword', remove
+underscores from STR as they are used as the keywords separator
+in file names."
(let* ((slug-function (alist-get component denote-file-name-slug-functions))
(str-slug (cond ((eq component 'title)
(funcall (or slug-function #'denote-sluggify-title)
str))
@@ -859,7 +869,7 @@ used as the keywords separator in file names."
(funcall (or slug-function
#'denote-sluggify-signature) str)))))
(denote--trim-right-token-characters
(denote--replace-consecutive-token-characters
- (denote--remove-dot-characters str-slug)))))
+ (denote--remove-dot-characters str-slug) component) component)))
(make-obsolete
'denote-letter-case
