In the code block below, we set settings and variables for executing this entire document.
# This setting is for overriding the author's usual small number of `abbreviated_row_count`.
$env.config.table.abbreviated_row_count = 100
# The `$init_numd_pwd_const` constant points to the current working directory from where the `numd` command was initiated.
# It is added by `numd` in every intermediate script to make it available in cases like below.
# We use `path join` here to construct working paths for both Windows and Unix
use ($init_numd_pwd_const | path join numd run1.nu) *
use ($init_numd_pwd_const | path join numd nu-utils numd-internals.nu) *This command is used for parsing initial markdown to detect executable code blocks.
# Here we set the `$file` variable (which will be used in several commands throughout this script) to point to `z_examples/1_simple_markdown/simple_markdown.md`.
let $file = $init_numd_pwd_const | path join z_examples 1_simple_markdown simple_markdown.md
let $md_orig = open -r $file | toggle-output-fences
let $md_orig_table = $md_orig | find-code-blocks
$md_orig_tableOutput:
// ╭─────────────────────────────────line──────────────────────────────────┬────row_type────┬─block_line─╮
// │ # This is a simple markdown example │ text │ 1 │
// │ │ text │ 1 │
// │ ## Example 1 │ text │ 1 │
// │ │ text │ 1 │
// │ the block below will be executed as it is, but won't yield any output │ text │ 1 │
// │ │ text │ 1 │
// │ ```nu │ ```nu │ 7 │
// │ let $var1 = 'foo' │ ```nu │ 7 │
// │ ``` │ ```nu │ 7 │
// │ │ text │ 10 │
// │ ## Example 2 │ text │ 10 │
// │ │ text │ 10 │
// │ ```nu │ ```nu │ 13 │
// │ # This block will produce some output in a separate block │ ```nu │ 13 │
// │ $var1 | path join 'baz' 'bar' │ ```nu │ 13 │
// │ ``` │ ```nu │ 13 │
// │ ```output-numd │ ```output-numd │ 17 │
// │ foo/baz/bar │ ```output-numd │ 17 │
// │ ``` │ ```output-numd │ 17 │
// │ │ text │ 20 │
// │ ## Example 3 │ text │ 20 │
// │ │ text │ 20 │
// │ ```nu │ ```nu │ 23 │
// │ # This block will output results inline │ ```nu │ 23 │
// │ > whoami │ ```nu │ 23 │
// │ user │ ```nu │ 23 │
// │ │ ```nu │ 23 │
// │ > 2 + 2 │ ```nu │ 23 │
// │ 4 │ ```nu │ 23 │
// │ ``` │ ```nu │ 23 │
// ╰─────────────────────────────────line──────────────────────────────────┴────row_type────┴─block_line─╯
The generate-intermediate-script command generates a script that contains code from all executable blocks and numd service commands used for capturing outputs.
# Here we emulate that the `$intermed_script_path` options is not set
let $intermed_script_path = $file
| modify-path --prefix $'numd-temp-(generate-timestamp)' --suffix '.nu'
generate-intermediate-script $md_orig_table
| save -f $intermed_script_path
open $intermed_script_pathOutput:
// # this script was generated automatically using numd
// # https://github.com/nushell-prophet/numd
//
// const init_numd_pwd_const = '/Users/user/git/numd'
//
// "# This is a simple markdown example
//
// ## Example 1
//
// the block below will be executed as it is, but won't yield any output
// " | print
// "```nu" | print
// "let $var1 = 'foo'" | nu-highlight | print
//
// "```\n```output-numd" | print
//
// let $var1 = 'foo'
//
// "```" | print
//
// "
// ## Example 2
// " | print
// "```nu" | print
// "# This block will produce some output in a separate block
// $var1 | path join 'baz' 'bar'" | nu-highlight | print
//
// "```\n```output-numd" | print
//
// # This block will produce some output in a separate block
// $var1 | path join 'baz' 'bar' | table | print; print ''
//
// "```" | print
//
// "
// ## Example 3
// " | print
// "```nu" | print
// "# This block will output results inline" | nu-highlight | print
//
//
// "> whoami" | nu-highlight | print
//
// whoami | table | print; print ''
//
// "> 2 + 2" | nu-highlight | print
//
// 2 + 2 | table | print; print ''
//
// "```" | print
The execute-intermediate-script command runs and captures outputs of the executed intermediate script.
# the flag `$no_fail_on_error` is set to false
let $no_fail_on_error = false
let $nu_res_stdout_lines = execute-intermediate-script $intermed_script_path $no_fail_on_error false
rm $intermed_script_path
$nu_res_stdout_linesOutput:
// # This is a simple markdown example
//
// ## Example 1
//
// the block below will be executed as it is, but won't yield any output
//
// ```nu
// let $var1 = 'foo'
// ```
// ```output-numd
// ```
//
// ## Example 2
//
// ```nu
// # This block will produce some output in a separate block
// $var1 | path join 'baz' 'bar'
// ```
// ```output-numd
// foo/baz/bar
//
// ```
//
// ## Example 3
//
// ```nu
// # This block will output results inline
// > whoami
// user
//
// > 2 + 2
// 4
//
// ```
let $md_res = $nu_res_stdout_lines
| str join (char nl)
| clean-markdown
$md_resOutput:
// # This is a simple markdown example
//
// ## Example 1
//
// the block below will be executed as it is, but won't yield any output
//
// ```nu
// let $var1 = 'foo'
// ```
//
// ## Example 2
//
// ```nu
// # This block will produce some output in a separate block
// $var1 | path join 'baz' 'bar'
// ```
// ```output-numd
// foo/baz/bar
// ```
//
// ## Example 3
//
// ```nu
// # This block will output results inline
// > whoami
// user
//
// > 2 + 2
// 4
// ```
The compute-change-stats command displays stats on the changes made.
compute-change-stats $file $md_orig $md_resOutput:
// ╭──────────────────┬────────────────────╮
// │ filename │ simple_markdown.md │
// │ nushell_blocks │ 3 │
// │ levenshtein_dist │ 0 │
// │ diff_lines │ 0% │
// │ diff_words │ 0% │
// │ diff_chars │ 0% │
// ╰──────────────────┴────────────────────╯