Skip to content

Commit 51d9749

Browse files
committed
Bring main documentation up-to-date
1 parent 792418c commit 51d9749

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

+12-5
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ Contained within this repository is a comprehensive and automated code graph ana
1010

1111
- Analyze static code structure as a graph
1212
- Supports Java Code Analysis
13-
- **🌟New🌟:** Supports Typescript Code Analysis (experimental)
13+
- Supports Typescript Code Analysis (experimental)
1414
- Fully automated [pipeline for Java](./.github/workflows/internal-java-code-analysis.yml) from tool installation to report generation
1515
- Fully automated [pipeline for Typescript](./.github/workflows/internal-typescript-code-analysis.yml) from tool installation to report generation
1616
- Fully automated [local run](./GETTING_STARTED.md)
17-
- Easy integratable in your [continuous integration pipeline](./INTEGRATION.md)
17+
- Easily integrable into your [continuous integration pipeline](./INTEGRATION.md)
1818
- More than 130 CSV reports for dependencies, metrics, cycles, annotations, algorithms and many more
1919
- Jupyter notebook reports for dependencies, metrics, visibility and many more
2020
- Graph structure visualization
@@ -23,12 +23,14 @@ Contained within this repository is a comprehensive and automated code graph ana
2323
- Tested on MacOS (zsh), Linux (bash) and Windows (Git Bash)
2424
- Comprehensive list of [Cypher queries](./cypher/CYPHER.md)
2525
- Example analysis for [AxonFramework](https://github.com/AxonFramework/AxonFramework)
26+
- Example analysis for [react-router](https://github.com/remix-run/react-router)
2627

27-
### :book: Jupyter Notebook Reports
28+
### :notebook: Jupyter Notebook Reports
2829

2930
Here is an overview of [Jupyter Notebooks](https://jupyter.org) reports from [code-graph-analysis-examples](https://github.com/JohT/code-graph-analysis-examples). For a complete list, see the [Jupyter Notebook Report Reference](#page_with_curl-jupyter-notebook-report-reference).
3031

3132
- [External Dependencies](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/external-dependencies-java/ExternalDependenciesJava.md) contains detailed information about external library usage ([Notebook](./jupyter/ExternalDependenciesJava.ipynb)).
33+
- [Git History](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/git-history-general/GitHistoryGeneral.md) contains information about the git history of the analyzed code ([Notebook](./jupyter/GitHistoryGeneral.ipynb)).
3234
- [Internal Dependencies](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/internal-dependencies-java/InternalDependenciesJava.md) is based on [Analyze java package metrics in a graph database](https://joht.github.io/johtizen/data/2023/04/21/java-package-metrics-analysis.html) and also includes cyclic dependencies ([Notebook](./jupyter/InternalDependenciesJava.ipynb)).
3335
- [Method Metrics](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/method-metrics-java/MethodMetricsJava.md) shows how the effective number of lines of code and the cyclomatic complexity are distributed across the methods in the code ([Notebook](./jupyter/MethodMetricsJava.ipynb)).
3436
- [Node Embeddings](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/node-embeddings-java/NodeEmbeddingsJava.md) shows how to generate node embeddings and to further reduce their dimensionality to be able to visualize them in a 2D plot ([Notebook](./jupyter/NodeEmbeddingsJava.ipynb)).
@@ -37,7 +39,7 @@ Here is an overview of [Jupyter Notebooks](https://jupyter.org) reports from [co
3739
- [Visibility Metrics](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/visibility-metrics-java/VisibilityMetricsJava.md) ([Notebook](./jupyter/VisibilityMetricsJava.ipynb)).
3840
- [Wordcloud](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/wordcloud/Wordcloud.md) contains a visual representation of package and class names ([Notebook](./jupyter/Wordcloud.ipynb)).
3941

40-
### :book: Graph Data Science Reports
42+
### :blue_book: Graph Data Science Reports
4143

4244
This project includes several reports that use Neo4j's [Graph Data Science Library](https://neo4j.com/product/graph-data-science). These reports are part of the [code-graph-analysis-examples](https://github.com/JohT/code-graph-analysis-examples) repository. For a full list of reports, check out the [CSV Cypher Query Report Reference](#page_with_curl-csv-cypher-query-report-reference).
4345

@@ -46,6 +48,7 @@ Here are some reports that utilize Neo4j's [Graph Data Science Library](https://
4648
- [Centrality with Page Rank](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/centrality-csv/Package_Centrality_Page_Rank.csv) ([Source Script](./scripts/reports/CentralityCsv.sh))
4749
- [Community Detection with Leiden](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/community-csv/Package_communityLeidenId_Community__Metrics.csv) ([Source Script](./scripts/reports/CommunityCsv.sh))
4850
- [Node Embeddings with HashGNN](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/node-embeddings-csv/Package_Embeddings_HashGNN.csv) ([Source Script](./scripts/reports/NodeEmbeddingsCsv.sh))
51+
- [Path Finding with all pairs shortest path](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/path-finding-csv/Package_all_pairs_shortest_paths_distribution_per_project.csv) ([Source Script](./scripts/reports/PathFindingCsv.sh))
4952
- [Similarity with Jaccard](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/similarity-csv/Package_Similarity.csv) ([Source Script](./scripts/reports/SimilarityCsv.sh))
5053
- [Topology Sort](https://github.com/JohT/code-graph-analysis-examples/blob/main/analysis-results/AxonFramework/latest/topology-csv/Package_Topological_Sort.csv) ([Source Script](./scripts/reports/TopologicalSortCsv.sh))
5154

@@ -82,7 +85,7 @@ Here are some fully automated graph visualizations utilizing [GraphViz](https://
8285

8386
### Additional Prerequisites for Graph Visualization
8487

85-
These tools are needed to run the graph visualization scripts of directory [graph-visualization](./graph-visualization):
88+
These tools are needed to run the graph visualization scripts of directory [scripts/visualization/](./scripts/visualization/) and the deprecated scripts in [graph-visualization](./graph-visualization):
8689

8790
- [Node.js](https://nodejs.org/en)
8891
- [npm](https://www.npmjs.com)
@@ -176,6 +179,10 @@ The [Code Structure Analysis Pipeline](./.github/workflows/internal-java-code-an
176179

177180
[ENVIRONMENT_VARIABLES.md](./scripts/ENVIRONMENT_VARIABLES.md) contains all environment variables that are supported by the scripts including default values and description. It can be generated as described in [Generate Environment Variable Reference](./COMMANDS.md#generate-environment-variable-reference).
178181

182+
## :closed_book: Change Log
183+
184+
[CHANGELOG.md](./CHANGELOG.md) contains all changes of this repository.
185+
179186
## :thinking: Questions & Answers
180187

181188
- How can i run an analysis locally?

0 commit comments

Comments
 (0)