emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed

From: Pablo Padilla <pgpb.padilla@gmail.com>
To: emacs-orgmode@gnu.org
Subject: Org-mode+Babel: Refactor across files or code blocks
Date: Tue, 22 Oct 2024 21:05:50 +0200	[thread overview]
Message-ID: <D5A036F3-2197-4977-9163-AD12C8157584@gmail.com> (raw)

[-- Attachment #1: Type: text/plain, Size: 1810 bytes --]


Hi there, I have started to write some of my dotfiles using org-mode and I have regularly felt the need to refactor certain parts of my configuration. At the moment I mostly perform refactoring using find and replace but would like to have more robust support to refactor across distinct Babel blocks or across files.

A more detailed example follows:

I'm refactoring my Emacs config files so that they are generated with [org-babel-tangle][1]. I am able to do everything I need but I really miss better refactoring support.

As an example, after I define a symbol (variable, function), there maybe a lot of unrelated code and prose before the next usage:

> Some explanation about `a` and `x`:
> ```elisp
> (defun a ...)
> (defvar x ...)
> ```
> Another paragraph ... 
> ```elisp
> ((((more))))(((lisp)))()()((((code)))
> ```
> Using `a` or `x`:
> ```elisp
> (doSomething (a) ...)
> (crashSystem x ...)
> ```


To rename a symbol, I enter [edit mode (`C-c '`)][2], and there is some limited refactoring support, e.g., rename symbol, extract variable, etc. However, changes to a symbol across all Babel blocks or across files is not supported.

My workflow today is to use `helm-projectile-ag` to find usages in the project (git repo) and then apply the required changes to each, one by one, by hand.

I have been googling for refactoring support across blocks/files so far with little success. I have posted this question to gather some pointers, references to Emacs packages that can improve my refactoring workflow or maybe help me rethink my workflow.


  [1]: https://orgmode.org/manual/Extracting-Source-Code.html 
  [2]: https://orgmode.org/manual/Editing-Source-Code.html

Originally posted in https://emacs.stackexchange.com/q/80858/11978 

Regards,
—
Pablo 

[-- Attachment #2: Type: text/html, Size: 2685 bytes --]

next             reply	other threads:[~2024-10-22 19:07 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-22 19:05 Pablo Padilla [this message]
2024-10-28 22:30 ` Org-mode+Babel: Refactor across files or code blocks Rudolf Adamkovič

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=D5A036F3-2197-4977-9163-AD12C8157584@gmail.com \
    --to=pgpb.padilla@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).