From: Daniel Ziltener <[email protected]> * lisp/ob-tangle.el (org-babel-tangle-single-block): strip noweb tags from block if :noweb has been set to strip-tangle. * lisp/ob-core.el (org-babel-common-header-args-w-values): add "strip-tangle" as new allowed value. * testing/lisp/test-ob-tangle.el (ob-tangle/strip-tangle): add new test case for strip-tangle. * doc/org-manual.org (Noweb Reference Syntax): adjust documentation for the noweb header argument. * etc/ORG-NEWS: add entry for new header argument value.
This patch adds the "strip-tangle" option for the :noweb header argument. This strips the noweb tags before tangling the block. This can be useful for e.g. testing purposes where one wants to use a block as test case that can be both run inline as well as tangled into a file for automated testing. --- doc/org-manual.org | 6 ++++++ etc/ORG-NEWS | 5 +++++ lisp/ob-core.el | 2 +- lisp/ob-tangle.el | 4 +++- testing/lisp/test-ob-tangle.el | 26 ++++++++++++++++++++++++++ 5 files changed, 41 insertions(+), 2 deletions(-) diff --git a/doc/org-manual.org b/doc/org-manual.org index 18a050069..064d51bcd 100644 --- a/doc/org-manual.org +++ b/doc/org-manual.org @@ -18993,6 +18993,12 @@ tangled, or exported. Expansion of noweb syntax references in the body of the code block when tangling. No expansion when evaluating or exporting. +- =strip-tangle= :: + + Expansion of noweb syntax references in the body of the code block + when evaluating or exporting. Removes noweb syntax references + when exporting. + - =no-export= :: Expansion of noweb syntax references in the body of the code block diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS index 6e875deb6..2c66d2e45 100644 --- a/etc/ORG-NEWS +++ b/etc/ORG-NEWS @@ -228,6 +228,11 @@ commands. =:noweb-prefix= can be set to =no= to prevent the prefix characters from being repeated when expanding a multiline noweb reference. +*** New =:noweb= babel header argument value =strip-tangle= + +=:noweb= can be set to =strip-tangle= to strip the noweb syntax references +before tangling. + *** New LaTeX source block backend using =engraved-faces-latex= When ~org-latex-src-block-backend~ is set to ~engraved~, diff --git a/lisp/ob-core.el b/lisp/ob-core.el index 518831ec6..c52f113b4 100644 --- a/lisp/ob-core.el +++ b/lisp/ob-core.el @@ -414,7 +414,7 @@ then run `org-babel-switch-to-session'." (mkdirp . ((yes no))) (no-expand) (noeval) - (noweb . ((yes no tangle no-export strip-export))) + (noweb . ((yes no tangle strip-tangle no-export strip-export))) (noweb-ref . :any) (noweb-sep . :any) (noweb-prefix . ((no yes))) diff --git a/lisp/ob-tangle.el b/lisp/ob-tangle.el index 2da92efaf..d9d847195 100644 --- a/lisp/ob-tangle.el +++ b/lisp/ob-tangle.el @@ -536,7 +536,9 @@ non-nil, return the full association list to be used by (body ;; Run the tangle-body-hook. (let ((body (if (org-babel-noweb-p params :tangle) - (org-babel-expand-noweb-references info)+ (if (string= "strip-tangle" (cdr (assq :noweb (nth 2 info)))) + (replace-regexp-in-string (org-babel-noweb-wrap) "" (nth 1 info))
+ (org-babel-expand-noweb-references info))
(nth 1 info))))
(with-temp-buffer
(insert
diff --git a/testing/lisp/test-ob-tangle.el b/testing/lisp/test-ob-tangle.el
index a0003ee40..af2a72682 100644
--- a/testing/lisp/test-ob-tangle.el
+++ b/testing/lisp/test-ob-tangle.el
@@ -510,6 +510,32 @@ another block
(org-split-string (buffer-string))))
(delete-file file))))))
+(ert-deftest ob-tangle/strip-tangle ()
+ "Test if strip-tangle works correctly when tangling noweb code blocks."
+ (should
+ (equal '("1")
+ (let ((file (make-temp-file "org-tangle-")))
+ (unwind-protect
+ (progn
+ (org-test-with-temp-text-in-file
+ (format "
+#+name: block1
+#+begin_src elisp
+2
+#+end_src
+
+#+begin_src elisp :noweb strip-tangle :tangle %s
++1<<block1>>
+#+end_src
+" file)
+ (let ((org-babel-noweb-error-all-langs nil)
+ (org-babel-noweb-error-langs nil))
+ (org-babel-tangle)))
+ (with-temp-buffer
+ (insert-file-contents file)
+ (org-split-string (buffer-string))))
+ (delete-file file))))))
+
(ert-deftest ob-tangle/detangle-false-positive ()
"Test handling of false positive link during detangle."
(let (buffer)
--
2.35.3
OpenPGP_0x752C7F031AADF16F.asc
Description: OpenPGP public key
OpenPGP_signature
Description: OpenPGP digital signature
