diff mbox series

[bug#57069,v3,1/4] etc: Add tempel snippets.

Message ID 20220812085851.12104-1-ngraves@ngraves.fr
State Accepted
Headers show
Series [bug#57069,v3,1/4] etc: Add tempel snippets. | expand

Checks

Context Check Description
cbaines/comparison success View comparision
cbaines/git-branch success View Git branch
cbaines/applying patch success View Laminar job
cbaines/issue success View issue
cbaines/comparison success View comparision
cbaines/git-branch success View Git branch
cbaines/applying patch success View Laminar job
cbaines/issue success View issue

Commit Message

Nicolas Graves Aug. 12, 2022, 8:58 a.m. UTC
* doc/contributing.texi:
  Adding configuration description for TempEL snippets and adapting yasnippet
  configuration to the directory move.
* etc/snippets/tempel/scheme-mode: New file.
* etc/snippets/tempel/text-mode: New file.
* etc/snippets/scheme-mode: Moved from here...
* etc/snippets/yas/scheme-mode: ... to here.
* etc/snippets/text-mode: Moved from here...
* etc/snippets/yas/text-mode: ... to here.
---
 doc/contributing.texi                         |  16 ++-
 etc/snippets/tempel/scheme-mode               | 114 ++++++++++++++++++
 etc/snippets/tempel/text-mode                 | 101 ++++++++++++++++
 .../{ => yas}/scheme-mode/guix-bzr-reference  |   0
 .../{ => yas}/scheme-mode/guix-cvs-reference  |   0
 .../{ => yas}/scheme-mode/guix-git-reference  |   0
 .../{ => yas}/scheme-mode/guix-hg-reference   |   0
 .../{ => yas}/scheme-mode/guix-origin         |   0
 .../{ => yas}/scheme-mode/guix-package        |   0
 .../{ => yas}/scheme-mode/guix-svn-reference  |   0
 .../guix-commit-message-add-cl-package        |   0
 .../text-mode/guix-commit-message-add-package |   0
 .../guix-commit-message-remove-package        |   0
 .../guix-commit-message-rename-package        |   0
 .../guix-commit-message-update-package        |   0
 .../guix-commit-message-use-https-home-page   |   0
 16 files changed, 227 insertions(+), 4 deletions(-)
 create mode 100644 etc/snippets/tempel/scheme-mode
 create mode 100644 etc/snippets/tempel/text-mode
 rename etc/snippets/{ => yas}/scheme-mode/guix-bzr-reference (100%)
 rename etc/snippets/{ => yas}/scheme-mode/guix-cvs-reference (100%)
 rename etc/snippets/{ => yas}/scheme-mode/guix-git-reference (100%)
 rename etc/snippets/{ => yas}/scheme-mode/guix-hg-reference (100%)
 rename etc/snippets/{ => yas}/scheme-mode/guix-origin (100%)
 rename etc/snippets/{ => yas}/scheme-mode/guix-package (100%)
 rename etc/snippets/{ => yas}/scheme-mode/guix-svn-reference (100%)
 rename etc/snippets/{ => yas}/text-mode/guix-commit-message-add-cl-package (100%)
 rename etc/snippets/{ => yas}/text-mode/guix-commit-message-add-package (100%)
 rename etc/snippets/{ => yas}/text-mode/guix-commit-message-remove-package (100%)
 rename etc/snippets/{ => yas}/text-mode/guix-commit-message-rename-package (100%)
 rename etc/snippets/{ => yas}/text-mode/guix-commit-message-update-package (100%)
 rename etc/snippets/{ => yas}/text-mode/guix-commit-message-use-https-home-page (100%)
diff mbox series

Patch

diff --git a/doc/contributing.texi b/doc/contributing.texi
index 02c7c5ae59..655ce182de 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -320,15 +320,23 @@  s-expression, etc.
 @cindex reducing boilerplate
 We also provide templates for common git commit messages and package
 definitions in the @file{etc/snippets} directory.  These templates can
-be used with @url{https://joaotavora.github.io/yasnippet/, YASnippet} to
-expand short trigger strings to interactive text snippets.  You may want
-to add the snippets directory to the @var{yas-snippet-dirs} variable in
+be used to expand short trigger strings to interactive text snippets. If
+you use @url{https://joaotavora.github.io/yasnippet/, YASnippet}, you
+may want to add the @file{etc/snippets/yas} snippets directory to the
+@var{yas-snippet-dirs} variable.  If you use
+@url{https://github.com/minad/tempel/, Tempel}, you may want to add the
+@file{etc/snippets/tempel/*} path to the @var{tempel-path} variable in
 Emacs.
 
 @lisp
 ;; @r{Assuming the Guix checkout is in ~/src/guix.}
+;; @r{Yasnippet}
 (with-eval-after-load 'yasnippet
-  (add-to-list 'yas-snippet-dirs "~/src/guix/etc/snippets"))
+  (add-to-list 'yas-snippet-dirs "~/src/guix/etc/snippets/yas"))
+;;@r{Tempel}
+(with-eval-after-load 'tempel
+         (add-to-list 'tempel-path
+         "~/src/guix/etc/snippets/tempel/*"))
 @end lisp
 
 The commit message snippets depend on @url{https://magit.vc/, Magit} to
diff --git a/etc/snippets/tempel/scheme-mode b/etc/snippets/tempel/scheme-mode
new file mode 100644
index 0000000000..386c9e653f
--- /dev/null
+++ b/etc/snippets/tempel/scheme-mode
@@ -0,0 +1,114 @@ 
+-*- mode: lisp-data -*-
+
+scheme-mode
+
+(package...
+ "(define-public " (s name)
+ n> "(package"
+ n> "(name \"" (s name) "\")"
+ n> "(version \"" p "\")"
+ n> "(source origin...)"
+ n> "(build-system \""
+ (p (completing-read "build-system:"
+                     '("android-ndk"
+                       "ant"
+                       "asdf"
+                       "cargo"
+                       "chicken"
+                       "clojure"
+                       "cmake"
+                       "copy"
+                       "dub"
+                       "dune"
+                       "emacs"
+                       "font"
+                       "glib-or-gtk"
+                       "gnu"
+                       "go"
+                       "guile"
+                       "haskell"
+                       "julia"
+                       "linux-module"
+                       "maven"
+                       "meson"
+                       "minetest"
+                       "minify"
+                       "node"
+                       "ocaml"
+                       "perl"
+                       "python"
+                       "qt"
+                       "r"
+                       "rakudo"
+                       "rebar"
+                       "renpy"
+                       "ruby"
+                       "scons"
+                       "texlive"
+                       "trivial"
+                       "waf")
+                     nil t) "-build-system")
+ "\")"
+ n> "(home-page \"" p "\")"
+ n> "(synopsis \"" p "\")"
+ n> "(description \"" p "\")"
+ n> "(license " p ")))" n)
+
+(origin...
+ "(origin"
+ n> "(method \""
+ (p (completing-read "method:"
+                     '("url-fetch"
+                       "url-fetch/tarbomb"
+                       "url-fetch/zipbomb"
+                       "cvs-fetch"
+                       "git-fetch"
+                       "hg-fetch"
+                       "svn-fetch"
+                       "bzr-fetch")
+                     nil t) method) "\")"
+ n> "(uri " (cl-case (intern method)
+              ('git-fetch "git-reference...")
+              ('svn-fetch "svn-reference...")
+              ('hg-fetch  "hg-reference...")
+              ('cvs-fetch "cvs-reference...")
+              ('bzr-fetch "bzr-reference...")
+              (t          "(string-append \"https://"))
+ p
+ (if (equal (substring method 0 9)  "url-fetch") "\")")
+ ")"
+ n> (cl-case (intern method)
+      ('git-fetch "(file-name (git-file-name name version))\n")
+      ('hg-fetch "(file-name (hg-file-name name version))\n")
+      ('svn-fetch "(file-name (string-append name \"-\" version \"-checkout\"))\n")
+      ('cvs-fetch "(file-name (string-append name \"-\" version \"-checkout\"))\n")
+      ('bzr-fetch "(file-name (string-append name \"-\" version \"-checkout\"))\n")
+      (t          ""))
+ > "(sha256"
+      n> "(base32 \"" p "\")))")
+
+(git-reference...
+ "(git-reference"
+ n> "(url \"" p "\")"
+ n> "(commit \"" p "\"))")
+
+(svn-reference...
+ "(svn-reference"
+ n> "(url \"" p "\")"
+ n> "(revision \"" p "\"))")
+
+(cvs-reference...
+ "(cvs-reference"
+ n> "(root-directory \"" p "\")"
+ n> "(module \"" p "\")"
+ n> "(revision \"" p "\"))")
+
+(hg-reference...
+ "(hg-reference"
+ n> "(url \"" p "\")"
+ n> "(changeset \"" p "\"))")
+
+(bzr-reference...
+ "(bzr-reference"
+ n> "(url \"" p "\")"
+ n> "(revision \"" p "\"))")
diff --git a/etc/snippets/tempel/text-mode b/etc/snippets/tempel/text-mode
new file mode 100644
index 0000000000..a1400aac69
--- /dev/null
+++ b/etc/snippets/tempel/text-mode
@@ -0,0 +1,101 @@ 
+-*- mode: lisp-data -*-
+
+text-mode :when (and (fboundp 'git-commit-mode) (git-commit-mode))
+
+(add\ 
+ "gnu: Add "
+ (p
+  (with-temp-buffer
+    (magit-git-wash #'magit-diff-wash-diffs
+      "diff" "--staged")
+    (goto-char (point-min))
+    (when (re-search-forward "\\+(define-public \\(\\S-+\\)" nil 'noerror)
+      (match-string-no-properties 1)))
+  var ) "." n n
+ "* " (car (magit-staged-files)) " (" (s var ) "): New variable.")
+
+(remove\ 
+ "gnu: Remove "
+ (p (with-temp-buffer
+      (magit-git-wash #'magit-diff-wash-diffs
+        "diff" "--staged")
+      (goto-char (point-min))
+      (when (re-search-forward "\\-(define-public \\(\\S-+\\)" nil 'noerror)
+        (match-string-no-properties 1)))
+    var) "." n n
+ "* " (car (magit-staged-files)) " (" (s var) "): Delete variable.")
+
+(rename\ 
+ "gnu: "
+ (p (with-temp-buffer
+      (magit-git-wash #'magit-diff-wash-diffs
+        "diff" "--staged")
+      (beginning-of-buffer)
+      (when (search-forward "-(define-public " nil 'noerror)
+        (thing-at-point 'sexp 'no-properties)))
+    prev-var)
+ ": Rename package to "
+ (p (with-temp-buffer
+      (magit-git-wash #'magit-diff-wash-diffs
+        "diff" "--staged")
+      (beginning-of-buffer)
+      (when (search-forward "+(define-public " nil 'noerror)
+        (thing-at-point 'sexp 'no-properties)))
+    new-var) "." n n
+ "* " (car (magit-staged-files)) " (" (s prev-var) "): Define in terms of" n
+ "'deprecated-package'." n
+ "(" (s new-var) "): New variable, formerly known as \"" (s prev-var) "\".")
+
+(update\ 
+ "gnu: "
+ (p (with-temp-buffer
+      (magit-git-wash #'magit-diff-wash-diffs
+        "diff" "--staged")
+      (goto-char (point-min))
+      (when (re-search-forward "^[ ]*(define-public \\(\\S-+\\)" nil 'noerror)
+        (match-string-no-properties 1)))
+    var)
+ ": Update to "
+ (p (with-temp-buffer
+      (magit-git-wash #'magit-diff-wash-diffs
+        "diff" "--staged")
+      (goto-char (point-min))
+      (search-forward "name" nil 'noerror)
+      (search-forward "+" nil 'noerror)   ; first change
+      (when (and (search-forward "version " nil 'noerror)
+                 (looking-at-p "\""))
+        (let ((end (save-excursion (search-forward "\")" nil 'noerror))))
+          (when end
+            (forward-char)
+            (buffer-substring-no-properties (point) (- end 2))))))
+    version) "." n n
+ "* " (car (magit-staged-files)) " (" (s var) "): Update to " (s version) "."
+ (mapconcat (lambda (file) (concat "* " file)) (cdr (magit-staged-files))) n)
+
+(addcl\ 
+ "gnu: Add cl-"
+ (p (replace-regexp-in-string
+     "^cl-" "" (with-temp-buffer
+                 (magit-git-wash #'magit-diff-wash-diffs
+                   "diff" "--staged")
+                 (beginning-of-buffer)
+                 (when (search-forward "+(define-public " nil 'noerror)
+                   (replace-regexp-in-string
+                    "^sbcl-" ""
+                    (thing-at-point 'sexp 'no-properties)))))
+    var) "." n n
+ "* " (car (magit-staged-files))
+ " (cl-" (s var)  ", ecl-" (s var) ", sbcl-" (s var) "): New variables.")
+
+(https\ 
+ "gnu: "
+ (p (with-temp-buffer
+      (magit-git-wash #'magit-diff-wash-diffs
+        "diff" "--staged")
+      (goto-char (point-min))
+      (when (re-search-forward "^[ ]*(define-public \\(\\S-+\\)" nil 'noerror)
+        (match-string-no-properties 1)))
+    var)
+ ": Use HTTPS home page." n n
+ "* " (car (magit-staged-files)) " (" (s var) ")[home-page]: Use HTTPS." n
+ (mapconcat (lambda (file) (concat "* " file)) (cdr (magit-staged-files))) n)
diff --git a/etc/snippets/scheme-mode/guix-bzr-reference b/etc/snippets/yas/scheme-mode/guix-bzr-reference
similarity index 100%
rename from etc/snippets/scheme-mode/guix-bzr-reference
rename to etc/snippets/yas/scheme-mode/guix-bzr-reference
diff --git a/etc/snippets/scheme-mode/guix-cvs-reference b/etc/snippets/yas/scheme-mode/guix-cvs-reference
similarity index 100%
rename from etc/snippets/scheme-mode/guix-cvs-reference
rename to etc/snippets/yas/scheme-mode/guix-cvs-reference
diff --git a/etc/snippets/scheme-mode/guix-git-reference b/etc/snippets/yas/scheme-mode/guix-git-reference
similarity index 100%
rename from etc/snippets/scheme-mode/guix-git-reference
rename to etc/snippets/yas/scheme-mode/guix-git-reference
diff --git a/etc/snippets/scheme-mode/guix-hg-reference b/etc/snippets/yas/scheme-mode/guix-hg-reference
similarity index 100%
rename from etc/snippets/scheme-mode/guix-hg-reference
rename to etc/snippets/yas/scheme-mode/guix-hg-reference
diff --git a/etc/snippets/scheme-mode/guix-origin b/etc/snippets/yas/scheme-mode/guix-origin
similarity index 100%
rename from etc/snippets/scheme-mode/guix-origin
rename to etc/snippets/yas/scheme-mode/guix-origin
diff --git a/etc/snippets/scheme-mode/guix-package b/etc/snippets/yas/scheme-mode/guix-package
similarity index 100%
rename from etc/snippets/scheme-mode/guix-package
rename to etc/snippets/yas/scheme-mode/guix-package
diff --git a/etc/snippets/scheme-mode/guix-svn-reference b/etc/snippets/yas/scheme-mode/guix-svn-reference
similarity index 100%
rename from etc/snippets/scheme-mode/guix-svn-reference
rename to etc/snippets/yas/scheme-mode/guix-svn-reference
diff --git a/etc/snippets/text-mode/guix-commit-message-add-cl-package b/etc/snippets/yas/text-mode/guix-commit-message-add-cl-package
similarity index 100%
rename from etc/snippets/text-mode/guix-commit-message-add-cl-package
rename to etc/snippets/yas/text-mode/guix-commit-message-add-cl-package
diff --git a/etc/snippets/text-mode/guix-commit-message-add-package b/etc/snippets/yas/text-mode/guix-commit-message-add-package
similarity index 100%
rename from etc/snippets/text-mode/guix-commit-message-add-package
rename to etc/snippets/yas/text-mode/guix-commit-message-add-package
diff --git a/etc/snippets/text-mode/guix-commit-message-remove-package b/etc/snippets/yas/text-mode/guix-commit-message-remove-package
similarity index 100%
rename from etc/snippets/text-mode/guix-commit-message-remove-package
rename to etc/snippets/yas/text-mode/guix-commit-message-remove-package
diff --git a/etc/snippets/text-mode/guix-commit-message-rename-package b/etc/snippets/yas/text-mode/guix-commit-message-rename-package
similarity index 100%
rename from etc/snippets/text-mode/guix-commit-message-rename-package
rename to etc/snippets/yas/text-mode/guix-commit-message-rename-package
diff --git a/etc/snippets/text-mode/guix-commit-message-update-package b/etc/snippets/yas/text-mode/guix-commit-message-update-package
similarity index 100%
rename from etc/snippets/text-mode/guix-commit-message-update-package
rename to etc/snippets/yas/text-mode/guix-commit-message-update-package
diff --git a/etc/snippets/text-mode/guix-commit-message-use-https-home-page b/etc/snippets/yas/text-mode/guix-commit-message-use-https-home-page
similarity index 100%
rename from etc/snippets/text-mode/guix-commit-message-use-https-home-page
rename to etc/snippets/yas/text-mode/guix-commit-message-use-https-home-page