Skip to content

Commit a7443f8

Browse files
committed
Avoid platform-specific code in markdown:check-links task
The `markdown:check-links` task uses the markdown-link-check tool. This tool does not have a capability for discovering Markdown files so it is necessary to use the `find` command to discover the files, then pass their paths to the markdown-link-check tool. Since it is managed as a project dependency using npm, the markdown-link-check tool is invoked using npx. Since the `find` command must be ran in combination with markdown-link-check, it is necessary to use the `--call` flag of npx. Even though Windows contributors are required to use a POSIX-compliant shell such as Git Bash when working with the assets, the commands ran via the `--call` flag are executed using the native shell, which means the Windows command interpreter on a Windows machine even if the task was invoked via a different shell. This causes commands completely valid for use on a Linux or macOS machine to fail to run on a Windows machine due to the significant differences in the Windows command interpreter syntax. During the original development of the task, a reasonably maintainable cross-platform command could not be found. Lacking a better option the hacky approach was taken of using a conditional to run a different command depending on whether the task was running on Windows or not, and not using npx for the Windows command. This resulted in a degraded experience for Windows contributors because they were forced to manually manage the markdown-link-check tool dependency and make it available in the system path. It also resulted in duplication of the fairly complex code contained in the task. Following the elimination of unnecessary complexity in the task code, it became possible to use a single command on all platforms. The Windows command interpreter syntax still posed a difficulty even for the simplified command: A beneficial practice, used throughout the assets, is to break commands into multiple lines to make them and the diffs of their development easier to read. With a POSIX-compliant shell this is accomplished by escaping the introduced newlines with a backslash. However, the Windows command interpreter does not recognize this syntax, making the commands formatted in that manner invalid when the task was ran on a Windows machine. The identified solution was to define the command via a Taskfile variable. The YAML syntax was carefully chosen to support the use of the familiar backslash escaping syntax, while also producing in a string that did not contain this non-portable escaping syntax after passing through the YAML parser.
1 parent 51b3eac commit a7443f8

File tree

1 file changed

+28
-35
lines changed

1 file changed

+28
-35
lines changed

Taskfile.yml

+28-35
Original file line numberDiff line numberDiff line change
@@ -318,46 +318,39 @@ tasks:
318318
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-markdown-task/Taskfile.yml
319319
markdown:check-links:
320320
desc: Check for broken links
321+
vars:
322+
# The command is defined in a Taskfile variable to allow it to be broken into multiple lines for readability.
323+
# This can't be done in the `cmd` object of the Taskfile because `npx --call` uses the native shell, which causes
324+
# standard newline escaping syntax to not work when the task is run on Windows.
325+
#
326+
# Using -regex instead of -name to avoid Task's behavior of globbing even when quoted on Windows
327+
# The odd method for escaping . in the regex is required for windows compatibility because mvdan.cc/sh gives
328+
# \ characters special treatment on Windows in an attempt to support them as path separators.
329+
#
330+
# prettier-ignore
331+
CHECK_LINKS_COMMAND:
332+
"
333+
find . \
334+
-type d -name \".git\" -prune -o \
335+
-type d -name \".licenses\" -prune -o \
336+
-type d -name \"__pycache__\" -prune -o \
337+
-type d -name \"node_modules\" -prune -o \
338+
-regex \".*[.]md\" \
339+
-exec \
340+
markdown-link-check \
341+
--quiet \
342+
--config \"./.markdown-link-check.json\" \
343+
\\{\\} \
344+
+
345+
"
321346
deps:
322347
- task: docs:generate
323348
- task: npm:install-deps
324349
cmds:
325350
- |
326-
if [[ "{{.OS}}" == "Windows_NT" ]]; then
327-
# npx --call uses the native shell, which makes it too difficult to use npx for this application on Windows,
328-
# so the Windows user is required to have markdown-link-check installed and in PATH.
329-
if ! which markdown-link-check &>/dev/null; then
330-
echo "markdown-link-check not found or not in PATH. Please install: https://github.com/tcort/markdown-link-check#readme"
331-
exit 1
332-
fi
333-
# Default behavior of the task on Windows is to exit the task when the first broken link causes a non-zero
334-
# exit status, but it's better to check all links before exiting.
335-
set +o errexit
336-
STATUS=0
337-
# Using -regex instead of -name to avoid Task's behavior of globbing even when quoted on Windows
338-
# The odd method for escaping . in the regex is required for windows compatibility because mvdan.cc/sh gives
339-
# \ characters special treatment on Windows in an attempt to support them as path separators.
340-
for file in $(find . -regex ".*[.]md"); do
341-
markdown-link-check \
342-
--quiet \
343-
--config "./.markdown-link-check.json" \
344-
"$file"
345-
STATUS=$(( $STATUS + $? ))
346-
done
347-
exit $STATUS
348-
else
349-
npx --package=markdown-link-check --call='
350-
STATUS=0
351-
for file in $(find . -regex ".*[.]md"); do
352-
markdown-link-check \
353-
--quiet \
354-
--config "./.markdown-link-check.json" \
355-
"$file"
356-
STATUS=$(( $STATUS + $? ))
357-
done
358-
exit $STATUS
359-
'
360-
fi
351+
npx \
352+
--package=markdown-link-check \
353+
--call='{{.CHECK_LINKS_COMMAND}}'
361354
362355
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-markdown-task/Taskfile.yml
363356
markdown:fix:

0 commit comments

Comments
 (0)