Merge branch 'dev/broken-symlinks'

* dev/broken-symlinks: (50 commits)
  ci: lint
  fs-link: correct some clearly bad logic
  fs-trim: adjust for new `fs-path`
  fs-move: adjust for new `fs-path` api
  fs-path: fix two bugs
  fs-path: continue cleanup
  fs-path: continue `--absolute` implementation
  WIP: fs-path: use `--absolute=...`
  styles.bash: add text sizes
  fs-path: happy with this help
  fs-path: try to document api complexity
  fs-path.bash: remove unused var
  checksum: absolute and validate
  *: use `--follow` instead of `--resolve`
  fs-path.bash: fix follow macos broken links
  ci: fix wsl reporting failure if no failures
  fs-path: more macos fixes
  fs-path: fix test expectations for macos
  fs-path: note todos
  fs-path: new resolution algo
  ...

Signed-off-by: Benjamin Lupton <b@lupton.cc>

Author: balupton

.github/workflows/dorothy-workflow.yml

@@ -294,9 +294,9 @@ jobs:
           # Execute the script, with appropriate ENV varrs, and with some `setsid` magic so that WSL isn't interactive and TTY attached
           wsl.exe -- env GITHUB_TOKEN=$Env:GITHUB_TOKEN CI=true GITHUB_ACTIONS=$Env:GITHUB_ACTIONS GITHUB_STEP_SUMMARY=$summaryWSL bash -eo pipefail -c "(setsid $scriptPath) </dev/null |& cat"
           $scriptExitStatus = $LastExitCode
-          # Append `GITHUB_STEP_SUMMARY` with the WSL generated summary
-          Add-Content -Path $summaryHost -Value (Get-Content -Path $summaryFile)
-          # Report and fail with the script's exit status
+          # If the `wsl.exe` summary (`$summaryFile`) exists, then append to `GITHUB_STEP_SUMMARY` (`$summaryHost`) 
+          if (Test-Path -Path $summaryFile) { Add-Content -Path $summaryHost -Value (Get-Content -Path $summaryFile) }
+          # Report and exit with the script's exit status
           $Host.SetShouldExit($scriptExitStatus) # This works around https://github.com/actions/runner/issues/351 and has GitHub Actions report the correct exit status
           Exit($scriptExitStatus)
   bash-versions-test:

commands.beta/echo-exit-affirmative

@@ -26,7 +26,7 @@ function echo_exit_affirmative() (
 			    If provided, use this value when exit status is neither [0] or [1].
 
 			EXAMPLES:
-			\`\`\`echo-exit-affirmative -- waiter 0 --status=0\`\`\`
+			\`\`\`echo-exit-affirmative -- waiter 0\`\`\`
 			Outputs: \`yes\`
 			\`\`\`echo-exit-affirmative -- waiter 0 --status=1\`\`\`
 			Outputs: \`no\`

commands.beta/echo-nothing-or-fail

@@ -13,9 +13,9 @@ function echo_nothing_or_fail_test() (
 	printf '%s\n' 'sup' | eval-tester --status=1 -- \
 		echo-nothing-or-fail --stdin
 
-	eval-tester --status=0 -- \
+	eval-tester -- \
 		echo-nothing-or-fail --
-	true | eval-tester --status=0 -- \
+	true | eval-tester -- \
 		echo-nothing-or-fail --stdin
 
 	return 0

commands.beta/itunes-owners

@@ -3,7 +3,7 @@
 
 function itunes_owners_test() (
 	source "$DOROTHY/sources/bash.bash"
-	eval-tester --ignore-stderr --status=0 -- itunes-owners --help
+	eval-tester --ignore-stderr -- itunes-owners --help
 )
 
 function itunes_owners() (

commands.beta/video-merge

@@ -56,7 +56,7 @@ function video_merge() (
 			--user=<user>
 			--group=<group>
 			--reason=<reason>
-			    Forwarded to \`is-file\`, \`fs-path --absolute\`, \`fs-remove\`, \`eval-helper\`.
+			    Forwarded to \`is-file\`, \`fs-path\`, \`fs-remove\`, \`eval-helper\`.
 
 			EXAMPLES:
 			\`\`\`video-merge 'merged.m4v' -- 'input1.m4v' 'input2.m4v'\`\`\`

commands.deprecated/fs-dirname

@@ -58,7 +58,7 @@ function fs_dirname() (
 			Outputs: \`.\`
 			\`\`\`fs-path --parents --absolute -- ./symlinked-directory\`\`\`
 			Outputs: \`${parent_of_home}/${USER}\`
-			\`\`\`fs-path --parents --resolve -- ./symlinked-directory\`\`\`
+			\`\`\`fs-path --parents --follow -- ./symlinked-directory\`\`\`
 			Outputs: \`${parent_of_home}\`
 		EOF
 		return 22 # EINVAL 22 Invalid argument

commands.deprecated/fs-realpath

@@ -2,7 +2,7 @@
 
 function fs_realpath() (
 	source "$DOROTHY/sources/bash.bash"
-	dorothy-warnings add --code='fs-realpath' --bold=' has been deprecated in favor of ' --code='fs-path --resolve'
+	dorothy-warnings add --code='fs-realpath' --bold=' has been deprecated in favor of ' --code='fs-path --physical'
 
 	# =====================================
 	# Arguments

commands/checksum

@@ -223,11 +223,12 @@ function checksum_() (
 			--defaults-fuzzy="$(echo-lines --prefix='[' --suffix=']' -- "${option_algorithms[@]}")" -- "${algorithms[@]}"
 	fi
 
-	# ensure all paths exist and are resolved to absolute
+	# ensure all paths exist and are absolute
 	if [[ ${#option_paths[@]} -ne 0 ]]; then
-		# ensure paths are absolute
+		# do not resolve, as directory checksums should compare subpaths and their data, not resolved paths and their data
+		# such that two directories, with same subpaths and data should match, even if symlinks are different
 		__split --target={option_paths} --no-zero-length --invoke -- \
-			fs-path --absolute -- "${option_paths[@]}"
+			fs-path --absolute --validate -- "${option_paths[@]}"
 		# ensure pv for progress bars on large files
 		# __command_required -- pv || return $?
 	fi

commands/dorothy

@@ -967,7 +967,7 @@ function dorothy_() (
 			paths+=("$DOROTHY")
 		fi
 		if [[ -d "$DOROTHY/user" ]]; then
-			paths+=("$(fs-path --resolve -- "$DOROTHY/user")")
+			paths+=("$(fs-path --follow -- "$DOROTHY/user")") # @todo fs-path should have an option to output every resolution
 		fi
 		if [[ ${#paths[@]} -ne 0 ]]; then
 			__print_lines 'Once you have restarted your terminal, you can delete Dorothy by removing the following paths:'

commands/echo-max

@@ -4,7 +4,7 @@ function echo_max_test() (
 	source "$DOROTHY/sources/bash.bash"
 	eval-tester --ignore-stderr --status=22 -- echo-max --help
 
-	eval-tester --status=0 -- \
+	eval-tester -- \
 		echo-max --
 
 	eval-tester --stderr='ERROR: __maximum: The value must be an integer, it was: a' --status=22 -- \