org-babel tangle代码块时如何指定添加的空行数量

能否自定义tangle时添加的空行数量 #

原生padline头参数仅支持布尔值配置：设为yes时在代码块末尾加1行空行，设为no则不加，本身不支持直接指定空行数量。你可以通过自定义头参数 + org-babel-post-tangle-hook 钩子的方式实现自定义数量配置，示例配置如下：

;; 自定义padlines头参数，支持指定代码块末尾添加的空行数量
(defun my/org-babel-add-custom-padlines ()
  "根据代码块的padlines头参数添加对应数量的空行"
  (interactive)
  (when (org-babel-current-src-block-location)
    (let* ((block-info (org-babel-get-src-block-info))
           (padlines (cdr (assq :padlines (nth 2 block-info)))))
      (when padlines
        (save-excursion
          (goto-char (point-max))
          (insert (make-string (string-to-number padlines) ?\n)))))))

;; 钩子绑定到tangle流程
(add-hook 'org-babel-post-tangle-hook #'my/org-babel-add-custom-padlines)

配置完成后，你就可以在代码块头参数里指定需要的空行数量了，示例用法：

#+BEGIN_SRC python :tangle test.py :padlines 2
def demo():
    print("test")
#+END_SRC

如何适配Python等编程语言的空行规范 #

有两种常用方案可以实现符合语言规范的空行处理：

方案1：按语言动态配置空行数量 #

在上述自定义钩子的逻辑里，增加语言类型判断分支，直接内置对应语言的规范要求即可。比如适配Python的PEP8规范的示例：

(defun my/org-babel-auto-pad-by-lang ()
  "根据代码块语言自动添加符合规范的空行"
  (interactive)
  (when (org-babel-current-src-block-location)
    (let* ((block-info (org-babel-get-src-block-info))
           (lang (nth 0 block-info))
           (content (nth 1 block-info))
           (pad-num 1))
      ;; 按语言设置空行数量
      (cond
       ((equal lang "python")
        (cond
         ;; 导包块后面加2行空行
         ((string-match-p "^\\(import\\|from.*import\\)" content)
          (setq pad-num 2))
         ;; 类/函数定义块后面加2行空行
         ((string-match-p "^\\(class\\|def\\)" content)
          (setq pad-num 2))
         (t (setq pad-num 1))))
       ;; 其他语言的规则可以自行补充
       ((equal lang "shell")
        (setq pad-num 1)))
      ;; 写入空行
      (save-excursion
        (goto-char (point-max))
        (insert (make-string pad-num ?\n)))))))

;; 替换之前的钩子绑定
(remove-hook 'org-babel-post-tangle-hook #'my/org-babel-add-custom-padlines)
(add-hook 'org-babel-post-tangle-hook #'my/org-babel-auto-pad-by-lang)

方案2：tangle后自动调用代码格式化工具 #

更省心的方案是在tangle完成后，自动调用对应语言的格式化工具处理空行、缩进等规范问题，不需要手动维护规则。以Python为例，配置自动调用ruff格式化的示例：

(defun my/org-babel-format-after-tangle ()
  "tangle完成后自动格式化对应文件"
  (interactive)
  (when (and buffer-file-name (file-exists-p buffer-file-name))
    (pcase (file-name-extension buffer-file-name)
      ("py" (call-process "ruff" nil nil nil "format" buffer-file-name))
      ("js" (call-process "prettier" nil nil nil "--write" buffer-file-name))
      ;; 其他语言的格式化命令自行补充
      )))

(add-hook 'org-babel-post-tangle-hook #'my/org-babel-format-after-tangle)

注意：如果同时使用多个post-tangle钩子，建议把格式化的钩子放在最后执行，避免其他操作修改内容后格式不符合要求。

内容的提问来源于stack exchange，提问作者Olivier Ma