Skip to content

Commit d13d897

Browse files
committed
Automated scripts reference document generation (CI)
1 parent 632f81d commit d13d897

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

scripts/SCRIPTS.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ Script | Directory | Description
3737
| [executeQueryFunctions.sh](./executeQueryFunctions.sh) | | Provides functions to execute Cypher queries using either "executeQuery.sh" or Neo4j's "cypher-shell". |
3838
| [findPathsToScan.sh](./findPathsToScan.sh) | | Finds all files and directories to scan and analyze and provides them as comma-separated list. |
3939
| [importGit.sh](./importGit.sh) | | Coordinates the import of git data from the given --source directory where one ore more git repositories are located and the value of the environment variable IMPORT_GIT_LOG_DATA_IF_SOURCE_IS_PRESENT. |
40+
| [installJavaScriptDependencies.sh](./installJavaScriptDependencies.sh) | | This script triggers the installation of dependencies for JavaScript projects in the source folder. |
4041
| [embedMarkdownIncludes.sh](./markdown/embedMarkdownIncludes.sh) | markdown | Processes template markdown (sysin) replacing placeholders like "<!-- include:intro.md -->" or "<!-- include:intro.md\|fallback.md -->" with the contents of the specified markdown files. The files to include needs to be in the "includes" subdirectory. |
4142
| [formatQueryResultAsMarkdownTable.sh](./markdown/formatQueryResultAsMarkdownTable.sh) | markdown | Takes the input stream (Cypher query result in JSON format) and formats it as a Markdown table. |
4243
| [testEmbedMarkdownIncludes.sh](./markdown/testEmbedMarkdownIncludes.sh) | markdown | Tests template processing for markdown by embedding includes. |
@@ -90,6 +91,7 @@ Script | Directory | Description
9091
| [testCloneGitRepository.sh](./testCloneGitRepository.sh) | | Tests "cloneGitRepository.sh". |
9192
| [testDetectChangedFiles.sh](./testDetectChangedFiles.sh) | | Tests "detectChangedFiles.sh". |
9293
| [testDownloadMavenArtifacts.sh](./testDownloadMavenArtifacts.sh) | | Tests "downloadMavenArtifacts.sh". |
94+
| [testInstallJavaScriptDependencies.sh](./testInstallJavaScriptDependencies.sh) | | Tests "installJavaScriptDependencies.sh". |
9395
| [convertQueryResultCsvToGraphVizDotFile.sh](./visualization/convertQueryResultCsvToGraphVizDotFile.sh) | visualization | Converts a Cypher query result in CSV format to a GraphViz DOT (https://graphviz.org/doc/info/lang.html) file for Visualization including layout templates. |
9496
| [renderGraphVizSVG.sh](./visualization/renderGraphVizSVG.sh) | visualization | Renders the given GraphViz file as a SVG image. |
9597
| [visualizeQueryResults.sh](./visualization/visualizeQueryResults.sh) | visualization | Visualizes the Cypher query result (CSV format) using GraphViz and outputs it as SVG image. |

0 commit comments

Comments
 (0)