nvim-orgmode / nvim-orgmode/orgmode

Orgmode Babel

Open
#190 7 comments 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

core-feature
Dominant language
Lua
Stars
3.9k
Forks
190
Avg merge
2d 13h
Merged PRs (30d)
7

Description

Does this feature exist in Emacs orgmode core?

N/A

Orgmode link

https://blog.8bitzen.com/posts/27-02-2019-using-orgmode-babel/
https://orgmode.org/worg/org-contrib/babel/intro.html

Note- marked as N/A above, since i'm not familiar enough with orgmode to know if its in core or a library. The docs link says contrib, but it seems builtin (ie. don't need to install another package in emacs to use).

Feature value

Very high. I think this is one of orgmodes killer features for writing "smart notes" (literate programming).

I think a combo of sniprun/treesitter should be able to do this, and i'm playing around a little with it. The treesitter org parser doesn't handle (block parameters) just lumps them as one value. Also using header-args as a property at the top of the document doesn't work.

I'm not sure how to run sniprun in a way where we can setup the environment based on org properties for the run. (for example per file settings, or per block settings)

Org Babel also allows for including other files with helper functions in different languages, and named blocks.

Its very cool. Here is a video that demonstrates its power https://www.youtube.com/watch?v=0g9BcZvQbXU&ab_channel=spudlyo

Again, thank you for this amazing plugin. I know most of the features have been focused on GTD, this opens up a can of goodness, but it isn't directly in the GTD world of org.

Additional context

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing org parser and the treesitter handling for block parameters and top-level header-args. Then investigate how sniprun could receive per-file and per-block Org properties, including named blocks and helper-file inclusion. Done would require a defined, tested subset of Org Babel behavior supported by the plugin.

Written by the indexing model from the issue text.

Assessment

Tech stack
emacs
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.