Automated cypher reference document generation (CI)

Author: JohT

cypher/CYPHER.md

@@ -270,6 +270,7 @@ Script | Directory | Description
 | [List_all_Typescript_modules.cypher](./Internal_Dependencies/List_all_Typescript_modules.cypher) | Internal_Dependencies | List all existing internal Typescript modules. Requires "Set_localRootPath_for_modules.cypher", "Set_number_of...commits.cypher". |
 | [List_elements_that_are_used_by_many_different_modules_for_Typescript.cypher](./Internal_Dependencies/List_elements_that_are_used_by_many_different_modules_for_Typescript.cypher) | Internal_Dependencies | List elements that are used by many different modules |
 | [List_types_that_are_used_by_many_different_packages.cypher](./Internal_Dependencies/List_types_that_are_used_by_many_different_packages.cypher) | Internal_Dependencies | List types that are used by many different packages |
+| [NPM_Package_build_levels_for_graphviz.cypher](./Internal_Dependencies/NPM_Package_build_levels_for_graphviz.cypher) | Internal_Dependencies | List of all NPM packages and their dependencies with build levels for GraphViz Visualization |
 | [Set_file_distance_as_shortest_contains_path_for_dependencies.cypher](./Internal_Dependencies/Set_file_distance_as_shortest_contains_path_for_dependencies.cypher) | Internal_Dependencies | Set file distance for dependencies as the shortest path of CONTAINS relationships (intuitively the fewest number of change directory commands needed) |
 | [Typescript_Module_build_levels_for_graphviz.cypher](./Internal_Dependencies/Typescript_Module_build_levels_for_graphviz.cypher) | Internal_Dependencies | List of all Typescript modules and their dependencies with build levels for GraphViz Visualization |
 | [Annotated_code_elements.cypher](./Java/Annotated_code_elements.cypher) | Java | Annotated code elements overall by element type with some examples |
@@ -380,12 +381,14 @@ Script | Directory | Description
 | [Path_Finding_5_All_pairs_shortest_path_distribution_overall.cypher](./Path_Finding/Path_Finding_5_All_pairs_shortest_path_distribution_overall.cypher) | Path_Finding | Path Finding - All pairs shortest path algorithm - Stream - Overall |
 | [Path_Finding_5_All_pairs_shortest_path_distribution_per_project.cypher](./Path_Finding/Path_Finding_5_All_pairs_shortest_path_distribution_per_project.cypher) | Path_Finding | Path Finding - All pairs shortest path algorithm - Stream - Per project |
 | [Path_Finding_5_All_pairs_shortest_path_examples.cypher](./Path_Finding/Path_Finding_5_All_pairs_shortest_path_examples.cypher) | Path_Finding | Path Finding - All pairs shortest path algorithm - Stream - Longest paths as examples |
-| [Path_Finding_6_Longest_paths_contributors_for_graphviz.cypher](./Path_Finding/Path_Finding_6_Longest_paths_contributors_for_graphviz.cypher) | Path_Finding | Path Finding - Longest path - Stream - List all dependencies for nodes contributing to longest paths and highlight those paths in the Visualization with GraphViz. |
+| [Path_Finding_6_Longest_paths_contributors_for_graphviz.cypher](./Path_Finding/Path_Finding_6_Longest_paths_contributors_for_graphviz.cypher) | Path_Finding | Path Finding - Longest path - Stream - List all dependencies for nodes contributing to longest paths and highlight those paths in the Visualization with GraphViz. Recommended prerequisite: Topological_Sort_Write.cypher |
 | [Path_Finding_6_Longest_paths_distribution_overall.cypher](./Path_Finding/Path_Finding_6_Longest_paths_distribution_overall.cypher) | Path_Finding | Longest paths distribution |
 | [Path_Finding_6_Longest_paths_distribution_per_project.cypher](./Path_Finding/Path_Finding_6_Longest_paths_distribution_per_project.cypher) | Path_Finding | Longest paths distribution |
 | [Path_Finding_6_Longest_paths_examples.cypher](./Path_Finding/Path_Finding_6_Longest_paths_examples.cypher) | Path_Finding | Path Finding - Longest path - Stream - Max. paths as examples |
-| [Path_Finding_6_Longest_paths_for_graphviz.cypher](./Path_Finding/Path_Finding_6_Longest_paths_for_graphviz.cypher) | Path_Finding | Path Finding - Longest path - Stream - Find the top 100 dependencies contributing to the longest paths for Visualization with GraphViz |
+| [Path_Finding_6_Longest_paths_for_graphviz.cypher](./Path_Finding/Path_Finding_6_Longest_paths_for_graphviz.cypher) | Path_Finding | Path Finding - Longest path - Stream - Find the top 100 dependencies contributing to the longest paths for Visualization with GraphViz. Recommended prerequisite: Topological_Sort_Write.cypher |
 | [Set_Parameters.cypher](./Path_Finding/Set_Parameters.cypher) | Path_Finding | Example on how to set the parameters for path finding in this case for Packages and PageRank |
+| [Set_Parameters_NPM.cypher](./Path_Finding/Set_Parameters_NPM.cypher) | Path_Finding | Example on how to set the parameters for path finding in this case for NPM Packages |
+| [Set_Parameters_Typescript_Module.cypher](./Path_Finding/Set_Parameters_Typescript_Module.cypher) | Path_Finding | Example on how to set the parameters for path finding in this case for TypeScript modules |
 | [Set_Parameters.cypher](./Similarity/Set_Parameters.cypher) | Similarity | Example on how to set the parameters for similarity in this case for Packages and Node Similarity |
 | [Similarity_1a_Estimate.cypher](./Similarity/Similarity_1a_Estimate.cypher) | Similarity | Similarity Estimate Memory |
 | [Similarity_1b_Statistics.cypher](./Similarity/Similarity_1b_Statistics.cypher) | Similarity | Similarity Statistics |
@@ -397,6 +400,7 @@ Script | Directory | Description
 | [Similarity_1h_Write.cypher](./Similarity/Similarity_1h_Write.cypher) | Similarity | Similarity Write |
 | [Similarity_1i_Write_Node_Properties.cypher](./Similarity/Similarity_1i_Write_Node_Properties.cypher) | Similarity | Write similar node names and their score per node |
 | [Set_Parameters.cypher](./Topological_Sort/Set_Parameters.cypher) | Topological_Sort | Example on how to set the parameters for topological sort in this case for Java Artifacts and Node Similarity |
+| [Topological_Sort_Exists.cypher](./Topological_Sort/Topological_Sort_Exists.cypher) | Topological_Sort | Return the first node with a "maxDistanceFromSource" if it exists |
 | [Topological_Sort_List.cypher](./Topological_Sort/Topological_Sort_List.cypher) | Topological_Sort | Topological Sort to list the properties topologicalSortIndex (e.g. build order) and maxDistanceFromSource (build level) for each code unit node. Needs graph-data-science plugin version >= 2.5.0 |
 | [Topological_Sort_Query.cypher](./Topological_Sort/Topological_Sort_Query.cypher) | Topological_Sort | Topological Sort to query the properties topologicalSortIndex (e.g. build order) and maxDistanceFromSource (build level) for each code unit node in topologicalSortIndex order. Requires "Add_file_name and_extension.cypher". Needs graph-data-science plugin version >= 2.5.0 |
 | [Topological_Sort_Write.cypher](./Topological_Sort/Topological_Sort_Write.cypher) | Topological_Sort | Topological Sort to write the properties topologicalSortIndex (e.g. build order) and maxDistanceFromSource (build level) into the graph. Needs graph-data-science plugin version >= 2.5.0 |
@@ -413,9 +417,11 @@ Script | Directory | Description
 | [Add_name_to_property_on_scan_nodes.cypher](./Typescript_Enrichment/Add_name_to_property_on_scan_nodes.cypher) | Typescript_Enrichment | Set name property on Typescript scan nodes |
 | [Add_namespace_property_on_nodes_from_linked_npm_packages.cypher](./Typescript_Enrichment/Add_namespace_property_on_nodes_from_linked_npm_packages.cypher) | Typescript_Enrichment | Add namespace property to Typescript nodes if a npm a package is linked. Requires Link_projects_to_npm_packages. |
 | [Count_internal_modules_resolving_external_ones.cypher](./Typescript_Enrichment/Count_internal_modules_resolving_external_ones.cypher) | Typescript_Enrichment | How many internal modules resolve/represent external ones (for manual exploration)? |
+| [Enrich_npm_packages_with_dependency_counts.cypher](./Typescript_Enrichment/Enrich_npm_packages_with_dependency_counts.cypher) | Typescript_Enrichment | Enrich NPM:Package nodes with incoming and outgoing dependency counts Requires Link_npm_packages_with_depends_on_relationships.cypher |
 | [Index_module_name.cypher](./Typescript_Enrichment/Index_module_name.cypher) | Typescript_Enrichment | Create index for module name |
 | [Link_external_modules_to_corresponding_npm_dependency.cypher](./Typescript_Enrichment/Link_external_modules_to_corresponding_npm_dependency.cypher) | Typescript_Enrichment | Link ExternalModule nodes to their corresponding NPM Dependency if available |
-| [Link_npm_dependencies_to_npm_packages.cypher](./Typescript_Enrichment/Link_npm_dependencies_to_npm_packages.cypher) | Typescript_Enrichment | Link npm dependencies to the npm package that describe them if it exists |
+| [Link_npm_dependencies_to_npm_packages.cypher](./Typescript_Enrichment/Link_npm_dependencies_to_npm_packages.cypher) | Typescript_Enrichment | Link npm dependencies to the npm package that describes them, if it exists |
+| [Link_npm_packages_with_depends_on_relationships.cypher](./Typescript_Enrichment/Link_npm_packages_with_depends_on_relationships.cypher) | Typescript_Enrichment | Link npm packages with DEPENDS_ON relationships. Requires Link_npm_dependencies_to_npm_packages. This creates direct package-to-package dependencies by following the chain: (source:NPM:Package)-[dependency_relationship]->(NPM:Dependency)-[:IS_DESCRIBED_IN_NPM_PACKAGE]->(target:NPM:Package) |
 | [Link_projects_to_npm_packages.cypher](./Typescript_Enrichment/Link_projects_to_npm_packages.cypher) | Typescript_Enrichment | Link Typescript projects to npm packages |
 | [Mark_test_modules.cypher](./Typescript_Enrichment/Mark_test_modules.cypher) | Typescript_Enrichment | Add "Test" label for modules that contain tests and test-related implementations |
 | [Remove_duplicate_CONTAINS_relations_between_files.cypher](./Typescript_Enrichment/Remove_duplicate_CONTAINS_relations_between_files.cypher) | Typescript_Enrichment | Remove duplicate CONTAINS relationships with the same properties between files |