Add recipe for operating on a specified file list

kgryte · kgryte · commit fa766a3c5d1b · 2021-08-14T17:00:49.000-07:00
diff --git a/tools/make/lib/markdown/README.md b/tools/make/lib/markdown/README.md
@@ -58,6 +58,10 @@ The command supports the following environment variables:
 
 -   **MARKDOWN_ASSET_PATH**: a file path relative to the project root directory; e.g., `./README.md`.
 
+* * *
+
+### Namespace ToCs
+
 #### markdown-namespace-tocs
 
 Updates the table of contents of namespace Markdown files.
@@ -81,6 +85,26 @@ $ make markdown-namespace-tocs MARKDOWN_PATTERN='README.md' MARKDOWN_FILTER='.*/
 
 This command is useful when wanting to glob for Markdown files (e.g., process all Markdown files for a particular package).
 
+#### markdown-namespace-tocs-files
+
+Updates the table of contents of a specified list of namespace Markdown files.
+
+<!-- run-disable -->
+
+```bash
+$ make markdown-namespace-tocs-files FILES='/foo/foo.md /foo/bar.md'
+```
+
+The command supports the following environment variables:
+
+-   **FILES**: list of Markdown files.
+
+This command is useful when wanting to process a list of Markdown files generated by some other command (e.g., a list of changed Markdown files obtained via `git diff`).
+
+* * *
+
+### Package URLs
+
 #### markdown-pkg-urls
 
 Updates Markdown files by resolving package identifiers to GitHub repository URLs.
diff --git a/tools/make/lib/markdown/namespace_toc.mk b/tools/make/lib/markdown/namespace_toc.mk
@@ -47,6 +47,7 @@ REMARK_TOC_OUTPUT_FLAG ?= --output
 #
 # ## Notes
 #
+# -   This rule is useful when wanting to glob for Markdown files (e.g., process all Markdown files for a particular package).
 # -   In order to update table of contents, a namespace Markdown file must contain namespace table of contents comments.
 #
 # @param {string} [MARKDOWN_FILTER] - file path pattern (e.g., `.*/math/base/special/.*`)
@@ -58,10 +59,31 @@ REMARK_TOC_OUTPUT_FLAG ?= --output
 # @example
 # make markdown-namespace-tocs MARKDOWN_PATTERN='README.md' MARKDOWN_FILTER='.*/math/base/special/.*'
 #/
-markdown-namespace-tocs: $(NODE_MODULES) assert-clean-working-directory
+markdown-namespace-tocs: $(NODE_MODULES)
 	$(QUIET) NODE_PATH="$(NODE_PATH)" $(REMARK) $(MARKDOWN_FILES) \
 		$(REMARK_TOC_FLAGS) \
 		$(REMARK_TOC_PLUGIN_FLAGS) \
 		$(REMARK_TOC_OUTPUT_FLAG)
 
 .PHONY: markdown-namespace-tocs
+
+#/
+# Updates the table of contents of a specified list of namespace Markdown files.
+#
+# ## Notes
+#
+# -   This rule is useful when wanting to process a list of Markdown files generated by some other command (e.g., a list of changed Markdown files obtained via `git diff`).
+# -   In order to update table of contents, a namespace Markdown file must contain namespace table of contents comments.
+#
+# @param {string} FILES - list of files
+#
+# @example
+# make markdown-namespace-tocs-files FILES='/foo/foo.md /foo/bar.md'
+#/
+markdown-namespace-tocs-files: $(NODE_MODULES)
+	$(QUIET) NODE_PATH="$(NODE_PATH)" $(REMARK) $(FILES) \
+		$(REMARK_TOC_FLAGS) \
+		$(REMARK_TOC_PLUGIN_FLAGS) \
+		$(REMARK_TOC_OUTPUT_FLAG)
+
+.PHONY: markdown-namespace-tocs-files
