markdown_exec 2.8.5 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 718a29bb9eed1123158ffab68a01866fcdbc0126736c5305eae92dd661fb7396
-  data.tar.gz: 05e374bda6ac5603b13d50a33ef36cffd25d8fccdf43733107d63d19395ee9a5
+  metadata.gz: 6105f345e0f4e3b856fc2209f92872c3ab08aa1f7dadab2e3dba4fa686a8d20c
+  data.tar.gz: 3463e2cf4f292621d34007a55953744769047747c62fb20408e9a3c7070dc617
 SHA512:
-  metadata.gz: 18629932f2c6b095329f56ec594eb1016df88b17278ef544f6954f793f054e55c137b8240692392ebba9165c15e0f58b6c1e3883447fa740c90fa1fccb20f351
-  data.tar.gz: bc1e0a9ea38227dc83136f2884934ed6dfed93a4c1e73c4c1faa8a6188b2bc7a197062d356f2e3ff5665629e04de46d40904191de9d23af9b6ba31c9f26953d5
+  metadata.gz: dd25c39ccfefc8d5db5dd8ec985a4c7537824f631e916b18a17236504ea077eac24bc45eed13bd13756dad18ab045422c583b8479d32e9379219dc7f58682f7b
+  data.tar.gz: '084bc0518c1b016c738361f2dcc076cf0f51e5cb56b91b54f21880be09198b2d2176a5428ae2f2dfcedd09de34e73f45c278c13c705db04cc83b3bda8a8f5cb5'

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## [3.0.1] - 2025-05-21
+
+### Changed
+
+- Block ids to reflect source file when imported.
+- Disable UX block warnings for initial values.
+
+## [3.0.0] - 2025-05-20
+
+### Added
+
+- UX block keys 'act' and 'init' specify initial and activation behavior.
+- Inactive targets in long blocks of text to smooth navigation.
+- Options to display configuration keys and values similar to other shell expansions.
+
+### Changed
+
+- Rename UX block key 'default' to 'init' except when used in a prompt for input from the user.
+- Rename UX block keys 'allow', 'format', 'require'.
+- Handle user selecting 'Back' when saving.
+- Modify internal block IDs.
+- Remove extraneous final newline in output.
+- UX block required variables are temporary for evaluation.
+
 ## [2.8.5] - 2025-04-07
 
 ### Added
@@ -71,7 +95,7 @@
 
 ### Added
 
-- UX blocks can add preconditions. Preconditions are variable names that must be set before the UX block is executed. If any preconditions are not set, a warning is displayed, and the sequence is aborted.
+- UX blocks can specify required variables. The variables must be present before the UX block is executed. If any required variables are not set, a warning is displayed, and the sequence is aborted.
 - UX blocks can require shell an other UX blocks.
 - UX blocks are evaluated in order and calculation can depend on prior variables in the same sequence.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    markdown_exec (2.8.5)
+    markdown_exec (3.0.1)
       clipboard (~> 1.3.6)
       open3 (~> 0.1.1)
       optparse (~> 0.1.1)

data/Rakefile

@@ -127,8 +127,6 @@ task :minitest do
     './lib/dev/hierarchy.rb --verbose',
     './lib/dev/process_command.rb --verbose',
     './lib/dev/process_template.rb --test --verbose',
-    # './lib/dev/ruby_file_processor.rb --test --verbose',
-    # './lib/dev/std_out_err_logger.rb', ### errs
     './lib/dev/visibility-controller.rb --verbose',
     './lib/directory_searcher.rb --verbose',
     './lib/evaluate_shell_expressions.rb --verbose',
@@ -147,7 +145,6 @@ task :minitest do
     './lib/resize_terminal.rb --verbose',
     './lib/saved_assets.rb --verbose',
     './lib/saved_files_matcher.rb --verbose',
-    # './lib/shell_session.rb --verbose',
     './lib/table_extractor.rb --verbose',
     './lib/text_analyzer.rb --verbose'
   ]
@@ -258,33 +255,3 @@ def words_list(words)
     %("#{word}")
   end.join ' '
 end
-
-desc 'Build the Docker image for MarkdownExec'
-task :docker_build do
-  dockerfile = 'Dockerfile.ruby-3.3'
-  image_tag = "mde-#{MarkdownExec::VERSION}.gem"
-
-  command = [
-    "docker build",
-    "--build-arg VERSION=#{MarkdownExec::VERSION}",
-    "-f #{dockerfile}",
-    "-t #{image_tag}",
-    "."
-  ].join(' ')
-
-  puts "Building Docker image: #{image_tag} using #{dockerfile}..."
-  puts system(command) || abort("Docker build failed. Please check the output for details.")
-end
-
-desc 'Launch an interactive Docker Bash shell'
-task :docker_exec do
-  exec "docker exec -it mde-#{MarkdownExec::VERSION}.gem bash"
-end
-
-desc 'Run the mde binary inside a Docker container. eg `docker_run -- args`'
-task :docker_run, [:args] do
-  args = ARGV.dup
-  args.shift
-  args.shift if args[0] == '--'
-  exec "docker run -it mde-#{MarkdownExec::VERSION}.gem mde #{args.join(' ')}"
-end

data/bats/bats.bats

@@ -1,5 +1,7 @@
 #!/usr/bin/env bats
 
+# this file is skipped during code checks.
+
 greet () {
   echo "Hello, $1"'!'
   sleep 9

data/bats/block-type-link.bats

@@ -4,6 +4,6 @@ load 'test_helper'
 
 @test 'Link blocks - set variable in link block; call hidden block' {
   # __Exit is required as last block is a Link type
-  run_mde_specs_md_args_expect_xansi '[VARIABLE1]' __Exit ' VARIABLE1: 1'
+  run_mde_specs_md_args_expect_xansi '[VARIABLE1]' $EXIT_MENU ' VARIABLE1: 1'
   run_mde_specs_md_args_expect_xansi '[VARIABLE1]' '(echo-VARIABLE1)' ' VARIABLE1: 1   VARIABLE1: 1'
 }

data/bats/block-type-ux-allowed.bats

@@ -4,14 +4,14 @@ load 'test_helper'
 
 @test 'automatic blocks load defaults - constants or first allowed from output of echo or exec' {
   spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-ux-allowed.md \
-   'SPECIES=Pongo tapanuliensis_GENUS=Pongo_FAMILY=_ORDER=Click to select..._CLASS=Click to select..._YEAR_DISCOVERED=_NAME=Tapanuli Orangutan'
+   'SPECIES=Pongo tapanuliensis_GENUS=Pongo_FAMILY=_ORDER: Click to select..._Click to select..._YEAR_DISCOVERED=_NAME=Tapanuli Orangutan'
 }
 
 @test 'executing a block loads the first allowed value' {
   skip 'Unable to test the menu presented'
   spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-ux-allowed.md \
    '[FAMILY]' \
-   'SPECIES=Pongo tapanuliensis_GENUS=Pongo_FAMILY=Hominidae_ORDER=Click to select..._CLASS=Click to select..._YEAR_DISCOVERED=_NAME='
+   'SPECIES=Pongo tapanuliensis_GENUS=Pongo_FAMILY=Hominidae_Click to select...Click to select..._YEAR_DISCOVERED=_NAME='
 }
 
 @test 'executing a block loads the first line in the output of exec' {

data/bats/block-type-ux-invalid.bats

@@ -4,5 +4,5 @@ load 'test_helper'
 
 @test 'automatic block is invalid YAML' {
   spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-ux-invalid.md \
-   '_Error: HashDelegator../docs/dev/block-type-ux-invalid.md_vmlpd_bfnf_b_3 - --- !ruby/object:NullResult_message: Invalid YAML_data: invalid_ --  -- '
+   '_Error: HashDelegator.ItrBlkFrmNstFls:1¤./docs/dev/block-type-ux-invalid.md:1 - --- !ruby/object:NullResult_message: Invalid YAML_data: invalid_ --  -- '
 }

data/bats/block-type-ux-required-variables.bats

@@ -0,0 +1,20 @@
+#!/usr/bin/env bats
+
+load 'test_helper'
+
+@test 'An undefined variable is a precondition - initial' {
+  spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-ux-required-variables.md \
+   'SPECIES='
+}
+
+# hangs
+# Enter a value: []: #<Errno::EISDIR: Is a directory @ io_fillbuf - fd:12 test>
+# ["/Users/fareed/Documents/dev/ruby/markdown_exec/lib/hash_delegator.rb:4650:in `gets'",
+#  "/Users/fareed/Documents/dev/ruby/markdown_exec/lib/hash_delegator.rb:4650:in `gets'",
+#  "/Users/fareed/Documents/dev/ruby/markdown_exec/lib/hash_delegator.rb:4650:in `block in ux_block_export_activated'",
+#
+#@test 'An undefined variable is a precondition - active' {
+#  spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-ux-required-variables.md \
+#   test \
+#   'A value must exist for: MISSING_VARIABLE_SPECIES='
+#}

data/bats/block-type-ux-row-format.bats

@@ -4,5 +4,5 @@ load 'test_helper'
 
 @test 'Row format merges with prior table' {
   spec_mde_xansi_dname_doc_blocks_expect docs/dev/block-type-ux-row-format.md \
-   '  | Variable  | Value            | Prompt              |_  | --------- | ---------------- | ------------------- |_  | Species   | Pongo tapanulien | New species?    |_ | Name: Gen | Value: Pongo     | Prompt: New genus? |_  | Family    | Hominidae        | Enter a value:  |'
+   "   | Variable   | Value                | Prompt                |_   | ---------- | -------------------- | --------------------- |_   | Species    | Pongo tapanuliensis  | New species?      |_  | Name: Genu | Value: Xform: 'Pongo | Prompt: New genus? |_   | Family     | Hominidae            | Enter a value:    |"
 }

data/bats/block-type-ux-sources.bats

@@ -0,0 +1,36 @@
+#!/usr/bin/env bats
+
+load 'test_helper'
+
+@test 'dname' {
+  spec_mde_xansi_message_doc_blocks_expect docs/dev/block-type-ux-sources.md \
+   dname \
+   'USER_NAME=Guest_CURRENT_DIR=markdown_exec_SHELL_VERSION=/bin/bash_ENVIRONMENT=development_USER_EMAIL=_VERSION='
+}
+
+@test 'init_source' {
+  spec_mde_xansi_message_doc_blocks_expect docs/dev/block-type-ux-sources.md \
+   export_init \
+   'default_exec_echo_allow_false_false'
+}
+
+@test 'act_source' {
+  spec_mde_xansi_message_doc_blocks_expect docs/dev/block-type-ux-sources.md \
+   export_act \
+   'edit_edit_edit_allow_edit_edit'
+}
+
+@test 'is_disabled?' {
+  spec_mde_xansi_message_doc_blocks_expect docs/dev/block-type-ux-sources.md \
+   is_disabled? \
+   'false_false_false_false_false_false'
+}
+
+# test trigger presents prompt
+# test trigger presents allow list
+# test validation limits input
+# test transform formats output
+# test format creates output
+# test default, validation, prompt are displayed
+
+# bin/bmde docs/dev/block-type-ux-sources.md --list-blocks-message init_source --list-blocks-type 3 --list-blocks

data/bats/border.bats

@@ -4,5 +4,5 @@ load 'test_helper'
 
 @test 'Border - ' {
   spec_mde_xansi_dname_doc_blocks_expect docs/dev/border.md \
-   'A: 1_  B: 2_'
+   'A: 1_B: 2'
 }

data/bats/cli.bats

@@ -39,14 +39,14 @@ load 'test_helper'
 # the last block is a link block, so menu is displayed
 @test 'link block setting an environment variable requires a bash block' {
   BATS_OUTPUT_FILTER=A
-  spec_mde_args_expect docs/dev/requiring-blocks.md '[link-local-block-with-vars]' __Exit \
+  spec_mde_args_expect docs/dev/requiring-blocks.md '[link-local-block-with-vars]' $EXIT_MENU \
    ' ARG1: 37'
 }
 
 # the last block is a link block, so menu is displayed
 @test 'link block setting an environment variable calls a bash block in a file' {
   BATS_OUTPUT_FILTER=A
-  spec_mde_args_expect docs/dev/requiring-blocks.md '[link-file-block-with-vars]' __Exit \
+  spec_mde_args_expect docs/dev/requiring-blocks.md '[link-file-block-with-vars]' $EXIT_MENU \
    ' ARG1: arg1-from-link-file'
 }
 

data/bats/command-substitution-options.bats

@@ -0,0 +1,14 @@
+#!/usr/bin/env bats
+
+load 'test_helper'
+
+@test 'Operator $' {
+  spec_mde_xansi_dname_doc_blocks_expect docs/dev/command-substitution-options.md \
+   'operator_$' \
+   'Command substitution__The current value of environment variable Common_Name_is displayed using two different operators._The command echo $SHLVL is executed via command_substitution, using two different operators.__| Operato | Variable Expansio | Command Substitutio |_| ------- | ----------------- | ------------------- |_| $       | Tapanuli Oranguta | Pongo tapanuliensis |_| @       | @{Common_Name}    | @(echo $Species)    |__Toggle between operators.__operator_$__operator_@'
+}
+
+@test 'Operator @' {
+  spec_mde_xansi_dname_doc_blocks_expect docs/dev/command-substitution-options.md \
+   'Command substitution__The current value of environment variable Common_Name_is displayed using two different operators._The command echo $SHLVL is executed via command_substitution, using two different operators.__| Operato | Variable Expansio | Command Substitutio |_| ------- | ----------------- | ------------------- |_| $       | ${Common_Name}    | $(echo $Species)    |_| @       | Tapanuli Oranguta | Pongo tapanuliensis |__Toggle between operators.__operator_$__operator_@'
+}

data/bats/command-substitution.bats

@@ -4,5 +4,5 @@ load 'test_helper'
 
 @test 'Command substitution' {
   spec_mde_xansi_dname_doc_blocks_expect docs/dev/command-substitution.md \
-   'CURRENT BASE NAME IS: MARKDOWN_EXEC_current base name is: markdown_exec_current base name is: markdown_exec_| current base name |_| ----------------- |_| markdown_exec     |_: notice the string is not expanded in Shell block types (names or body)._  echo "current base name is now $(basename `pwd`)"__load: file_markdown_exec.sh_Status not zero: $(err)'
+   'CURRENT BASE NAME IS: MARKDOWN_EXEC_current base name is: markdown_exec_current base name is: markdown_exec_| current base name |_| ----------------- |_| markdown_exec     |_: notice the string is not expanded in Shell block types (names or body)._echo "current base name is now $(basename `pwd`)"_load: file_markdown_exec.sh_Status not zero: $(err)'
 }

data/bats/fail.bats

@@ -2,10 +2,13 @@
 
 load 'test_helper'
 
+# this file contains a test that fails.
+# this file is skipped during code checks.
+
 @test 'FAIL' {
-  run_mde_specs_md_args_expect_xansi '[VARIABLE1]' '__Exit' ' VARIABLE1: FAIL'
+  run_mde_specs_md_args_expect_xansi '[VARIABLE1]' $EXIT_MENU ' VARIABLE1: FAIL'
 }
 
 @test 'OK' {
-  run_mde_specs_md_args_expect_xansi '[VARIABLE1]' '__Exit' ' VARIABLE1: 1'
+  run_mde_specs_md_args_expect_xansi '[VARIABLE1]' $EXIT_MENU ' VARIABLE1: 1'
 }

data/bats/import.bats

@@ -14,3 +14,11 @@ load 'test_helper'
   spec_mde_args_expect docs/dev/import-missing.md \
    ' Error: CachedNestedFileReader.readlines -- No such file or directory - this-is-missing.md @@ '
 }
+
+@test 'Directives - import; list block ids' {
+  BATS_OUTPUT_FILTER=A
+  BATS_SAFE=_
+  spec_mde_args_expect docs/dev/import.md \
+   --list-block-message id --list-blocks \
+   'ItrBlkFrmNstFls:1¤./docs/dev/specs-import.md:0_ItrBlkFrmNstFls:4¤./docs/dev/specs-import.md:3_ItrBlkFrmNstFls:7¤./docs/dev/specs-import.md:6'
+}

data/bats/indented-block-type-vars.bats

@@ -5,5 +5,5 @@ load 'test_helper'
 @test 'an indented block with multiple lines' {
   BATS_OUTPUT_FILTER=A
   spec_mde_xansi_dname_doc_blocks_expect docs/dev/indented-block-type-vars.md \
-   '  Species: Pongo tapanuliensis_  Genus: Pongo_'
+   '  Species: Pongo tapanuliensis_  Genus: Pongo'
 }

data/bats/markup.bats

@@ -53,5 +53,5 @@ load 'test_helper'
 #}
 
 # @test 'OK' {
-#   run_mde_specs_md_args_expect_xansi '[VARIABLE1]' '__Exit' ' VARIABLE1: 1'
+#   run_mde_specs_md_args_expect_xansi '[VARIABLE1]' $EXIT_MENU ' VARIABLE1: 1'
 # }

data/bats/option-expansion.bats

@@ -0,0 +1,8 @@
+#!/usr/bin/env bats
+
+load 'test_helper'
+
+@test '' {
+  spec_mde_xansi_dname_doc_blocks_expect docs/dev/option-expansion.md \
+   '_| Optio | Description                      | Value | Va | Def |_| ----- | -------------------------------- | ----- | -- | --- |_| scree | Screen width for document and in | 2     | 64 | 0   |_| table |                                  | 5     | fa | tru |'
+}

data/bats/table-column-truncate.bats

@@ -4,5 +4,5 @@ load 'test_helper'
 
 @test 'Tables - truncate columns' {
   spec_mde_xansi_dname_doc_blocks_expect docs/dev/table-column-truncate.md \
-   'DEMONSTRATE TRUNCATION OF TEXT IN TABLE CELLS__| Common Name  | Species      | Genus |  Family | Year Di |_| ------------ | ------------ | ----- | ------- | ------- |_| Tapanuli Ora | Pongo tapanu | Pongo | Hominid |  2017   |_| Psychedelic  | Histiophryne | Histi | Antenna |  2009   |_| Ruby Seadrag | Phyllopteryx | Phyll | Syngnat |  2015   |_| Illacme tobi | Illacme tobi | Illac | Siphono |  2016   |_| Spiny Dandel | Taraxacum ja | Tarax | Asterac |  2022   |__'
+   'DEMONSTRATE TRUNCATION OF TEXT IN TABLE CELLS__| Common Name  | Species      | Genus |  Family | Year Di |_| ------------ | ------------ | ----- | ------- | ------- |_| Tapanuli Ora | Pongo tapanu | Pongo | Hominid |  2017   |_| Psychedelic  | Histiophryne | Histi | Antenna |  2009   |_| Ruby Seadrag | Phyllopteryx | Phyll | Syngnat |  2015   |_| Illacme tobi | Illacme tobi | Illac | Siphono |  2016   |_| Spiny Dandel | Taraxacum ja | Tarax | Asterac |  2022   |_'
 }

data/bats/test_helper.bash

@@ -1,5 +1,35 @@
 # facilitate execution of program, comparison of output
 
+EXIT_MENU=__Exit # name of menu Exit option
+
+#   Compare two byte sequences (strings or files) and report each difference:
+#     • zero-based byte offset
+#     • expected byte (0xHEX) and printable character (or “.”)
+#     • actual   byte (0xHEX) and printable character (or “.”)
+compare_bytes () {
+  set +e
+  local mode="$1"; shift
+  if [[ "$mode" == "--file" ]]; then
+    local f1="$1" f2="$2"
+    exec 3<"$f1" 4<"$f2"
+    # read raw bytes from file descriptors 3 and 4
+    cmp --verbose /dev/fd/3 /dev/fd/4
+  else
+    local live="$mode" expect="$1"
+    # feed the two strings into cmp via process-substitution
+    cmp --verbose <(printf '%s' "$live") <(printf '%s' "$expect")
+  fi |
+  head -n 3 |
+  gawk '{
+    live = strtonum(0 $2)
+    expect = strtonum(0 $3)
+    offset = $1 - 1
+    printf "Offset 0x%X (%4d): output \"%c\" 0x%02X (%3d) vs expect \"%c\" 0x%02X (%3d)\n", \
+           offset, offset, live, live, live, expect, expect, expect
+  }'
+  set -e
+}
+
 date_from_history_file_name () {
   basename "$1" | sed -E 's/.*([0-9]{4}-[0-9]{2}-[0-9]{2}).*/\1/'
 }
@@ -13,23 +43,27 @@ echo_hexdump_expected_output_filter () {
   local output="$2"
   local filter="$3"
 
+  # print label, line, character count; output
   echo -e "- output_$(echo "$output" | wc -l)_$(echo -n "$output" | wc -c):\n$output"
   if [[ $filter == A ]]; then
+    # print label, line, character count; converted output
     echo -e "- converted_$(echo "$output" | wc -l)_$(echo -n "$output" | wc -c):"
     echo "$(remove_ansi_escape_sequences "$output")"
   fi
+  # print label, line, character count; expected output
   echo -e "- expected_$(echo "$expected" | wc -l)_$(echo -n "$expected" | wc -c):\n$expected"
 
   if [[ $filter == A ]]; then
-    echo "- output"
-    echo_hexdump "$output"
+    # print label and hex dump of converted output
     echo "- converted"
     echo_hexdump "$(remove_ansi_escape_sequences "$output")"
+    # print label and hex dump of expected output
     echo "- expected"
     echo_hexdump "$expected"
 
-    # print the byte offset of the first difference
-    #diff <(remove_ansi_escape_sequences "$output") <(echo -n "$expected") | grep "^[0-9a-f]{8} " | cut -c 1-8
+    # print the byte offset of the first few differences
+    echo "- offset"
+    compare_bytes "$(remove_ansi_escape_sequences "$output")" "$expected"
   fi
 } 
 
@@ -210,8 +244,8 @@ spec_mde_args_grep_filter_expect () {
 
   if ( ! expect_equal_with_conversion "$expected" "$output" "$filter"); then
     echo_hexdump_expected_output_filter "$expected" "$output" "$filter"
+    return 1
   fi
-  expect_equal_with_conversion "$expected" "$output" "$filter"
   [[ -n $status ]] && echo "- status: $status"
   [[ -n $status ]]
 }
@@ -237,6 +271,17 @@ spec_mde_xansi_dname_doc_blocks_expect () {
   "${!#}"
 }
 
+spec_mde_xansi_message_doc_blocks_expect () {
+  BATS_OUTPUT_FILTER=A
+  BATS_SAFE=_
+  spec_mde_args_expect "$1" \
+   "${@:3:$(($#-3))}" \
+   --list-blocks-message "$2" \
+   --list-blocks-type 3 \
+   --list-blocks \
+  "${!#}"
+}
+
 spec_mde_xansi_oname_doc_blocks_expect () {
   BATS_OUTPUT_FILTER=A
   BATS_SAFE=_

data/docs/dev/bats-document-configuration.md

@@ -31,4 +31,4 @@ script_execution_tail:
 user_must_approve: false
 
 clear_screen_for_select_block: false
-```
+```

data/docs/dev/block-type-ux-allowed.md

@@ -3,13 +3,11 @@
 allowed:
 - Pongo tapanuliensis
 - Histiophryne psychedelica
-default: :allowed
 name: SPECIES
 ```
 / automatic block loads first line in output of exec
 ```ux :[document_ux_GENUS]
 allowed: :exec
-default: :allowed
 exec: echo "Pongo\nHistiophryne psychedelica"
 name: GENUS
 ```
@@ -18,7 +16,7 @@ name: GENUS
 allowed:
 - Hominidae
 - Antennariidae
-default: ''
+init: false
 name: FAMILY
 ```
 / automatic block loads default value that is not in allowed list
@@ -26,13 +24,13 @@ name: FAMILY
 allowed:
 - Primates
 - Lophiiformes
-default: Click to select...
+format: '%{name}: Click to select...'
 name: ORDER
 ```
 / automatic block loads default value, not in allowed list from echo
 ```ux :[document_ux_CLASS]
 allowed: :echo
-default: Click to select...
+format: Click to select...
 echo: |
   Mammalia
   Actinopterygii
@@ -41,14 +39,14 @@ name: CLASS
 / executed block presents a menu of the lines in the output of exec
 ```ux :[YEAR_DISCOVERED]
 allowed: :exec
-default: ''
+init: false
+prompt: ''
 exec: echo "2017\n2009"
 name: YEAR_DISCOVERED
 ```
 / automatic block presents a menu of the lines in the output of echo
 ```ux :[document_ux_NAME]
 allowed: :echo
-default: :allowed
 echo: |
   Tapanuli Orangutan
   Psychedelic Frogfish

data/docs/dev/block-type-ux-auto.md

@@ -6,26 +6,28 @@ name: v1
 / name and default
 / transform and validate options not applied to default
 ```ux
-default: ''
+init: false
 echo: 11
 name: v2
 ```
 / name and default; auto-load
 / prompt option is ignored during auto-load
 ```ux :[document_ux_v3]
-default: 12
+init: :echo
+echo: 12
 name: v3
 ```
 / name, default, exec; auto-load static
 ```ux :[document_ux_v4]
-default: 21
+init: :echo
+echo: 21
 exec: basename $(pwd)
 name: v4
 ```
 / name, default, exec; auto-load executed `basename $(pwd)`
 / allowed is ignored by exec
 ```ux :[document_ux_v5]
-default: :exec
+init: :exec
 exec: basename $(pwd)
 name: v5
 ```
@@ -34,7 +36,8 @@ name: v5
 allowed:
 - 32
 - 33
-default: 31
+init: :echo
+echo: 31
 name: v6
 ```
 @import bats-document-configuration.md

data/docs/dev/block-type-ux-chained.md

@@ -3,19 +3,21 @@
 ENTITY='Pongo tapanuliensis,Pongo'
 ```
 ```ux :[SPECIES] +(shell) +(GENUS)
+act: :echo
 echo: "${ENTITY%%,*}"
+init: false
 name: SPECIES
 ```
 / required ux block requires another
 ```ux :(GENUS) +[NAME]
 echo: "${ENTITY##*,}"
+init: false
 name: GENUS
-readonly: true
 ```
 / executed in context of prior ux blocks, uses their values
 ```ux :[NAME]
 echo: "$SPECIES - $GENUS"
+init: false
 name: NAME
-readonly: true
 ```
 @import bats-document-configuration.md

data/docs/dev/block-type-ux-echo-hash.md

@@ -1,6 +1,5 @@
 / This automatic block sets multiple variables and displays the first variable.
 ```ux :[document_ux_BASENAME]
-default: :echo
 echo:
   BASENAME: "$(basename `pwd`)"
   DOCUMENTS: "${BASENAME%%_*}"
@@ -10,19 +9,19 @@ readonly: true
 ```
 / This block displays the second variable in the first block.
 ```ux :[DOCUMENTS]
-default: false
+init: false
 name: DOCUMENTS
 readonly: true
 ```
 / This block displays the third variable in the first block.
 ```ux :[OPERATION]
-default: false
+init: false
 name: OPERATION
 readonly: true
 ```
 / Multiple UX blocks to set many variables for a specific name.
 ```ux
-default: false
+init: false
 echo:
   Species: Pongo tapanuliensis
   Genus: Pongo
@@ -37,7 +36,7 @@ menu_format: 'Load %{name}'
 name: Tapanuli Orangutan
 ```
 ```ux
-default: false
+init: false
 echo:
   Species: Histiophryne psychedelica
   Genus: Histiophryne
@@ -56,7 +55,7 @@ name: Psychedelic Frogfish
 | -| -
 / A read-only variable in a UX block in a table
 ```ux
-default: false
+init: false
 menu_format: '| %{name}| ${%{name}}'
 name: Species
 readonly: true
@@ -65,7 +64,7 @@ readonly: true
 | Genus| ${Genus}
 / An editable variable in a UX block in a table
 ```ux
-default: false
+init: false
 menu_format: '| %{name}| ${%{name}}'
 name: Family
 ```

data/docs/dev/block-type-ux-echo.md

@@ -9,14 +9,14 @@ menu_with_inherited_lines: true
 ```
 / This block is not visible. Execute to set a new value, displayed by the block above.
 ```ux :(VAR_has_count)
-default: false
+init: false
 echo: $(basename `pwd` | wc -c)
 force: false
 name: VAR
 ```
 / This block is visible. Execute to set a new value, displayed by the block above.
 ```ux :[IAB_has_count]
-default: false
+init: false
 echo: $VAR$VAR
 name: IAB
 ```