Add basic support for Typescript scanning

Author: JohT

README.md

@@ -9,6 +9,7 @@ Contained within this repository is a comprehensive and automated code graph ana
 ## ✨ Features
 
 - Analyze static Java code structure as a graph
+- Also supports Typescript (experimental)
 - Fully automated [pipeline](./.github/workflows/code-structure-analysis.yml) from tool installation to report generation
 - More than 130 CSV reports for dependencies, metrics, cycles, annotations, algorithms and many more
 - Jupyter notebook reports for dependencies, metrics, visibility and many more
@@ -78,6 +79,13 @@ These tools are needed to run the graph visualization scripts of directory [grap
 - Add this line to your `~/.bashrc` file if you are using Anaconda3: `/c/ProgramData/Anaconda3/etc/profile.d/conda.sh`. Try to find a similar script for other conda package managers or versions.
 - Run `conda init` in the git bash opened as administrator. Running it in normal mode usually leads to an error message.
 
+### Additional Prerequisites for analyzing Typescript
+
+- Please follow the description on how to create a json file with the static code information
+of your Typescript project here: https://github.com/jqassistant-plugin/jqassistant-typescript-plugin
+- Example: Run `npx --yes @jqassistant/ts-lce` in your Typescript package.
+- Copy the resulting json file (e.g. `.reports/jqa/ts-output.json`) into the "artifacts" directory for your analysis work directory. Custom subdirectories within "artifacts" are also supported.
+
 ## 🚀 Getting Started
 
 See [GETTING_STARTED.md](./GETTING_STARTED.md) on how to get started on your local machine.
@@ -92,7 +100,7 @@ The [Code Structure Analysis Pipeline](./.github/workflows/code-structure-analys
 - [Setup Python with Conda](https://github.com/conda-incubator/setup-miniconda) package manager [Mambaforge](https://github.com/conda-forge/miniforge#mambaforge)
 - Download artifacts that contain the code to be analyzed [scripts/artifacts](./scripts/downloader/)
 - Setup [Neo4j](https://neo4j.com) Graph Database ([analysis.sh](./scripts/analysis/analyze.sh))
-- Setup [jQAssistant](https://jqassistant.org/get-started) for Java Analysis ([analysis.sh](./scripts/analysis/analyze.sh))
+- Setup [jQAssistant](https://jqassistant.org/get-started) for Java and [Typescript](https://github.com/jqassistant-plugin/jqassistant-typescript-plugin) analysis ([analysis.sh](./scripts/analysis/analyze.sh))
 - Start [Neo4j](https://neo4j.com) Graph Database ([analysis.sh](./scripts/analysis/analyze.sh))
 - Generate CSV Reports [scripts/reports](./scripts/reports) using the command line JSON parser [jq](https://jqlang.github.io/jq)
 - Generate [Jupyter Notebook](https://jupyter.org) reports using these libraries specified in the [environment.yml](./jupyter/environment.yml):
@@ -109,7 +117,7 @@ The [Code Structure Analysis Pipeline](./.github/workflows/code-structure-analys
   - [wordcloud](https://github.com/amueller/word_cloud)
 - [Graph Visualization](./graph-visualization/README.md) uses [node.js](https://nodejs.org/de) and the dependencies listed in [package.json](./graph-visualization/package.json).
 
-**Big shout-out** 📣 to all the creators and contributors of these great libraries 👍. Projects like this wouldn't be possible without them. Feel free to [create an issue](https://github.com/JohT/code-graph-analysis-pipeline/issues/new/choose) if i've forgotten something in the list.
+**Big shout-out** 📣 to all the creators and contributors of these great libraries 👍. Projects like this wouldn't be possible without them. Feel free to [create an issue](https://github.com/JohT/code-graph-analysis-pipeline/issues/new/choose) if something is missing or wrong in the list.
 
 ## 🛠 Command Reference
 

scripts/findTypescriptDataFiles.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+# Echoes a list of Typescript data files starting with "ts-" and having extension "json" in the artifacts directory of sub directories. 
+# Each name will be prefixed by "typescript:project::"and separated by one space character.
+# This list is meant to be used after the "-f" line command option for the jQAssistant scan command to include Typescript data files.
+
+# Fail on any error ("-e" = exit on first error, "-o pipefail" exist on errors within piped commands)
+set -o errexit -o pipefail
+
+ARTIFACTS_DIRECTORY=${ARTIFACTS_DIRECTORY:-"artifacts"}
+
+# Check if the artifacts directory exists
+if [ ! -d "./${ARTIFACTS_DIRECTORY}" ] ; then
+    echo "" # The artifact directory doesn't exist. There is no file at all.
+    exit 0
+fi
+
+find "./${ARTIFACTS_DIRECTORY}" -type f -name 'ts-*.json' -exec echo {} \; | sed 's/^/typescript:project::/' | tr '\n' ' ' 

scripts/resetAndScan.sh

@@ -5,6 +5,7 @@
 # CAUTION: This script deletes all relationships and nodes in the Neo4j Graph Database. 
 # Note: The environment variable NEO4J_INITIAL_PASSWORD is required to login to Neo4j.
 
+# Requires findTypescriptDataFiles.sh
 
 # Fail on any error ("-e" = exit on first error, "-o pipefail" exist on errors within piped commands)
 set -o errexit -o pipefail
@@ -65,10 +66,12 @@ else
     echo "resetAndScan: jQAssistant configuration won't be changed since it already exists."
 fi
 
+directoriesAndFilesToScan="${ARTIFACTS_DIRECTORY} $(source ${SCRIPTS_DIR}/findTypescriptDataFiles.sh)"
+
 # Use jQAssistant to scan the downloaded artifacts and write the results into the separate, local Neo4j Graph Database
-echo "resetAndScan: Scanning ${ARTIFACTS_DIRECTORY} with jQAssistant CLI version ${JQASSISTANT_CLI_VERSION}"
+echo "resetAndScan: Using jQAssistant CLI version ${JQASSISTANT_CLI_VERSION} to scan: ${directoriesAndFilesToScan}"
 
-"${JQASSISTANT_BIN}"/jqassistant.sh scan -f ./${ARTIFACTS_DIRECTORY}
+"${JQASSISTANT_BIN}"/jqassistant.sh scan -f ./${directoriesAndFilesToScan}
 
 # Use jQAssistant to add dependencies between artifacts, package dependencies, artifact dependencies and the java version to the Neo4j Graph Database
 echo "resetAndScan: Analyzing ${ARTIFACTS_DIRECTORY} with jQAssistant CLI version ${JQASSISTANT_CLI_VERSION}"