flow: add --all-external-dependencies-file-path build option

Author: MykolaGolubyev

znai-cli/src/main/java/org/testingisdocumenting/znai/cli/ZnaiCliApp.java

@@ -45,6 +45,7 @@
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.time.Instant;
+import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
 public class ZnaiCliApp {
@@ -97,6 +98,7 @@ private void start() {
         if (needsDocGeneration()) {
             webSite = generateDocs(config.getSourceRoot());
             exportLlmTxtIfNeeded();
+            exportAllExternalDepsIfNeeded();
         }
 
         if (config.isPreviewMode()) {
@@ -166,6 +168,38 @@ public void printOutsideDeps() {
                 .forEach(System.out::println);
     }
 
+    private void exportAllExternalDepsIfNeeded() {
+        Path allExternalDepsFilePath = config.getAllExternalDepsFilePath();
+        if (allExternalDepsFilePath == null) {
+            return;
+        }
+
+        ProgressReporter.reportPhase("exporting all external dependencies");
+        ConsoleOutputs.out("creating ", Color.PURPLE, allExternalDepsFilePath);
+
+        String content = sortedExternalDependenciesRelativePaths()
+                .collect(Collectors.joining("\n"));
+
+        FileUtils.writeTextContent(allExternalDepsFilePath, content);
+    }
+
+    private Stream<String> sortedExternalDependenciesRelativePaths() {
+        Path sourceRoot = config.getSourceRoot();
+
+        Stream<String> insideDocPaths = webSite.getAuxiliaryFilesRegistry().getAllPaths()
+                .filter(fullPath -> fullPath.startsWith(sourceRoot))
+                .map(fullPath -> sourceRoot.relativize(fullPath).toString())
+                .filter(relativePath -> !relativePath.endsWith(".md"));
+
+        Stream<String> outsideDocPaths = webSite.getOutsideDocsRequestedResources().entrySet().stream()
+                .filter(e -> webSite.isLocalFile(e.getKey()))
+                .map(e -> sourceRoot.relativize(e.getValue()).toString());
+
+        return Stream.concat(insideDocPaths, outsideDocPaths)
+                .distinct()
+                .sorted();
+    }
+
     private void exportLlmTxtIfNeeded() {
         Path llmTxtOutputPath = config.getLlmTxtOutputPath();
         if (llmTxtOutputPath == null) {

znai-cli/src/main/java/org/testingisdocumenting/znai/cli/ZnaiCliConfig.java

@@ -93,6 +93,7 @@ public enum OptionKey {
 
         DOC_ID("doc-id", "documentation id", true, false),
         LLM_TXT_OUTPUT_PATH("llm-txt-output-path", "save llm.txt to specified path during build", true, false),
+        ALL_EXTERNAL_DEPS_FILE_PATH("all-external-dependencies-file-path", "save all external file dependencies to specified path during build", true, false),
 
         EXPORT("export", "export destination directory", true, false),
 
@@ -156,6 +157,7 @@ public boolean hasMultipleArgs() {
         buildOptions.add(OptionKey.DOC_ID);
         buildOptions.add(OptionKey.DEPLOY);
         buildOptions.add(OptionKey.LLM_TXT_OUTPUT_PATH);
+        buildOptions.add(OptionKey.ALL_EXTERNAL_DEPS_FILE_PATH);
         COMMAND_OPTIONS.put(Command.BUILD, buildOptions);
 
         Set<OptionKey> exportOptions = EnumSet.copyOf(commonOptions);
@@ -234,6 +236,7 @@ public enum ModifiedTimeStrategy {
     private String actor;
     private List<String> lookupPaths;
     private Path llmTxtOutputPath;
+    private Path allExternalDepsFilePath;
 
     private boolean isValidateExternalLinks;
 
@@ -350,6 +353,10 @@ public Path getLlmTxtOutputPath() {
         return llmTxtOutputPath;
     }
 
+    public Path getAllExternalDepsFilePath() {
+        return allExternalDepsFilePath;
+    }
+
     public Path getDeployRoot() {
         return validateIsSet("deployRoot", deployRoot);
     }
@@ -368,6 +375,9 @@ public void print() {
             if (getLlmTxtOutputPath() != null) {
                 print("llm txt output path", llmTxtOutputPath);
             }
+            if (getAllExternalDepsFilePath() != null) {
+                print("all external deps file path", allExternalDepsFilePath);
+            }
         } else if (isExportMode()) {
             print("source root", sourceRoot);
             print("export root", exportRoot);
@@ -452,6 +462,10 @@ private void parseArgs(String[] args) {
                 Paths.get(commandLine.getOptionValue(OptionKey.LLM_TXT_OUTPUT_PATH.getKey())).toAbsolutePath() :
                 null;
 
+        allExternalDepsFilePath = commandLine.hasOption(OptionKey.ALL_EXTERNAL_DEPS_FILE_PATH.getKey()) ?
+                Paths.get(commandLine.getOptionValue(OptionKey.ALL_EXTERNAL_DEPS_FILE_PATH.getKey())).toAbsolutePath() :
+                null;
+
         modifiedTimeStrategy = determineModifiedTimeStrategy(commandLine);
 
         validateMode(commandLine);

znai-docs/znai/release-notes/1.87/add-2026-03-22-export-deps-during-build.md

@@ -0,0 +1,2 @@
+* Add: `--all-external-dependencies-file-path=/tmp/external-dependendies.txt` option to list all the external dependencies
+used during build. 

znai-tests/src/test/groovy/sampledoc/chapter-one/target.md

@@ -1,3 +1,11 @@
 # Target
 
 This is the target page.
+
+:include-file: config.json
+
+:include-file: utils.js
+
+:include-file: app.config
+
+:include-file: schema.graphql

znai-tests/src/test/groovy/sampledoc/lookup-paths

@@ -1 +1,2 @@
-../doxygen.zip
+../doxygen.zip
+../doc-artifacts

znai-tests/src/test/groovy/sampledoc/outside-chapter-file.md

@@ -1,3 +1,5 @@
 # File Outside
 
-Files don't have to belong to chapters if you have simple docs
+Files don't have to belong to chapters if you have simple docs
+
+:include-file: chapter-two/sample.py

znai-tests/src/test/groovy/scenarios/allExternalDeps.groovy

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2026 znai maintainers
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package scenarios
+
+import static clicommands.CliCommands.getZnai
+import static org.testingisdocumenting.webtau.WebTauGroovyDsl.*
+
+scenario('build sampledoc with all external dependencies file') {
+    def depsFilePath = fs.tempDir('znai-deps').resolve('all-external-deps.txt')
+    def deployRoot = fs.tempDir('znai-deploy')
+
+    znai.run("build --doc-id test-doc --deploy $deployRoot " +
+            "--source=${cfg.fullPath('sampledoc')} " +
+            "--all-external-dependencies-file-path $depsFilePath")
+
+    fs.textContent(depsFilePath).should == '../doc-artifacts/app.config\n' +
+            '../doc-artifacts/schema.graphql\n' +
+            'chapter-one/config.json\n' +
+            'chapter-two/sample.py\n' +
+            'utils.js'
+}

znai-website-gen/src/main/java/org/testingisdocumenting/znai/website/WebSite.java

@@ -174,6 +174,10 @@ public Map<String, Path> getOutsideDocsRequestedResources() {
         return resourceResolver.getOutsideDocRequestedResources();
     }
 
+    public boolean isLocalFile(String path) {
+        return resourceResolver.isLocalFile(path);
+    }
+
     public void parseAndDeploy() {
         parse();
         deploy();