.github/workflows | ||
nix | ||
test | ||
flake.lock | ||
flake.nix | ||
LICENSE | ||
README.org |
nix-org-babel
This is a quick and dirty implementation of org-babel-tangle
in Nix.
It provides a function that takes an Org string and returns the contents of source blocks in a particular language.
talyz/fromElisp has a built-in Org support, but I created this because I needed more control on which parts to extract. It provides an option for excluding subtrees matching a particular heading pattern. For example, you can omit archived subtrees from the output.
Usage
Import the flake.
Extracting source blocks from an Org file/string
tangleOrgBabel function
This function takes an Org string and returns its source blocks.
Example:
let
tangle = lib.tangleOrgBabel {
languages = [ "emacs-lisp" ];
};
in
# Return a string
tangle (builtins.readFile ./config.org)
Arguments:
- An attribute set of options.
- An Org input string.
tangleOrgBabelFile function
Similar to tangleOrgBabel
, but this function takes a file as an argument and writes the output to a file.
Example:
# Write to a file
let
pkgs = import nixpkgs {
inherit system;
overlays = [
org-babel.overlay
];
};
in
pkgs.tangleOrgBabelFile "init.el" ./config.org {
languages = [ "emacs-lisp" ];
}
Note that this function is provided in the overlay of the flake.
Arguments:
- A string for the derivation name.
- An input file path.
- An attribute set of options.
Options
Languages
Example:
{
languages = [ "emacs-lisp" "elisp" ];
}
Default: [ "emacs-lisp" "lisp" ]
Filtering subtrees
You can transform the input by specifying processLines
option.
It must be a function that takes a list of strings and returns a list of strings.
This library also contains excludeHeadlines
function which can be used to exclude subtrees according to a predicate on the headline text, so you can use it in the option.
Example:
{
# Exclude archived subtrees
processLines = excludeHeadlines (matchOrgTag "ARCHIVE");
}
You can use the following predicates from this library:
- tag
- Returns true if the headline matches a tag given as the argument. The argument must be a string.
- headlineText
- Returns true if the headline matches the text given as the argument. The argument must be a string.