branch: elpa/graphql-mode
commit 0fb22dd4b190551f654b541391e3718fcb579c90
Author: Michael Herold <opensou...@michaeljherold.com>
Commit: Michael Herold <opensou...@michaeljherold.com>
Fix syntax table for triple quotes
Like `python-mode`, `graphql-mode` has the ability to set block strings
using triple-quoted blocks. By default, these triple-quoted strings end
up messing up if you place a single double-quote within them.
This change modifies the default settings for propertizing characters in
the syntax table. For triple-quoted blocks, we now set the string fence
syntax on the last quote of the opening fence and the first quote of the
closing fence.
This allows for normal `forward-sexp` and `backward-sexp` movements in
`graphql-mode` more readily than in `python-mode` because of the
conventions around block strings in the GraphQL spec. For example:
```
"""
This is a good block string.
"""
"""Whereas this is not."""
```
I lifted the vast majority of this change directly from `python-mode`.
---
graphql-mode.el | 33 +++++++++++++++++++++++++++++++++
1 file changed, 33 insertions(+)
diff --git a/graphql-mode.el b/graphql-mode.el
index 5f3ed0e161..c5e0d4bf58 100644
--- a/graphql-mode.el
+++ b/graphql-mode.el
@@ -274,6 +274,37 @@ Please install it and try again."))
st)
"Syntax table for GraphQL mode.")
+(defun graphql-syntax-stringify ()
+ "Put `syntax-table' property correctly on single/triple quotes."
+ (let* ((ppss (save-excursion (backward-char 3) (syntax-ppss)))
+ (string-start (and (eq t (nth 3 ppss)) (nth 8 ppss)))
+ (quote-starting-pos (- (point) 3))
+ (quote-ending-pos (point)))
+ (cond ((or (nth 4 ppss)
+ (and string-start
+ (not (eql (char-after string-start)
+ (char-after quote-starting-pos)))))
+ ;; Inside of a comment or a string quoted with different triple
+ ;; quotes so do nothing
+ nil)
+ ((nth 5 ppss)
+ ;; The escaped quote - not part of a triple quote
+ (goto-char (1+ quote-starting-pos)))
+ ((null string-start)
+ ;; The start of the string, where we want the string fence syntax on
+ ;; the last quote
+ (put-text-property (1- quote-ending-pos) quote-ending-pos
+ 'syntax-table (string-to-syntax "|")))
+ (t
+ ;; The end of the string, where we want the string fence syntax on
+ ;; the first quote
+ (put-text-property quote-starting-pos (1+ quote-starting-pos)
+ 'syntax-table (string-to-syntax "|"))))))
+
+(defconst graphql-syntax-propertize-function
+ (syntax-propertize-rules
+ ("\"\"\"" (0 (ignore (graphql-syntax-stringify))))))
+
(defvar-local graphql-edit-headers--parent-buffer nil)
(put 'graphql-edit-headers--parent-buffer 'permanent-local t)
@@ -462,6 +493,8 @@ interactively with `\\[graphql-edit-headers]'."
nil
nil
nil))
+ (setq-local syntax-propertize-function
+ graphql-syntax-propertize-function)
(setq imenu-generic-expression `((nil ,graphql-definition-regex 2)))
(add-hook 'completion-at-point-functions 'graphql-completion-at-point nil t))
