Scan Typescript directly from source without copy in artifacts

Author: JohT

README.md

@@ -91,9 +91,7 @@ This could be as simple as running the following command in your Typescript proj
   npx --yes @jqassistant/ts-lce
   ```
 
-- It is recommended to put the cloned source code repository into a directory called `source` within the analysis workspace so that it will also be picked up to import git log data.
-
-- Copy the resulting json file (e.g. `.reports/jqa/ts-output.json`) into the `artifacts/typescript` directory for your analysis work directory. Create the directory, if it doesn't exists. Custom subdirectories within `artifacts/typescript` are also supported.
+- The cloned repository or source project needs to be copied into the directory called `source` within the analysis workspace, so that it will also be picked up during scan by [resetAndScan.sh](./scripts/resetAndScan.sh) and optional [importGit.sh](./scripts/importGit.sh).
 
 ## :rocket: Getting Started
 

scripts/configuration/template-neo4jv4-jqassistant.yaml

@@ -94,7 +94,6 @@ jqassistant:
       #
       # -Djqassistant.store.properties
       properties:
-        json.file.exclude: "*/typescript/*.json"
 
   # The Scanner configuration
   scan:
@@ -127,6 +126,7 @@ jqassistant:
     # -Djqassistant.scan.properties
     properties:
       # plugin.property.key: value
+      json.file.exclude: "*/.reports/jqa/ts-output.json"
 
   # The analyze configuration
   analyze:

scripts/configuration/template-neo4jv5-jqassistant.yaml

@@ -127,7 +127,7 @@ jqassistant:
     # -Djqassistant.scan.properties
     properties:
       # plugin.property.key: value
-      json.file.exclude: "*/typescript/*.json"
+      json.file.exclude: "*/.reports/jqa/ts-output.json"
 
   # The analyze configuration
   analyze:

scripts/downloader/downloadTypescriptProject.sh

@@ -179,7 +179,4 @@ fi
   usePackageManagerToInstallDependencies
   echo "downloadTypescriptProject: Scanning Typescript source using @jqassistant/ts-lce..."
   npx --yes @jqassistant/[email protected] --extension React >"./../../runtime/logs/jqassistant-typescript-scan-${projectName}.log" 2>&1 || exit
-)
-echo "downloadTypescriptProject: Moving scanned results into the artifacts/typescript directory..."
-mkdir -p artifacts/typescript
-mv -fv "${fullSourceDirectory}/.reports/jqa/ts-output.json" "artifacts/typescript/${fullProjectName}.json"
+)

scripts/findTypescriptDataFiles.sh

@@ -5,7 +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, importGit.sh
+# Requires importGit.sh
 
 # Fail on any error ("-e" = exit on first error, "-o pipefail" exist on errors within piped commands)
 set -o errexit -o pipefail
@@ -60,7 +60,7 @@ else
     echo "resetAndScan: jQAssistant configuration won't be changed since it already exists."
 fi
 
-# Collect all files and directories to scan
+# -- Collect all files and directories to scan ---------------------
 directoriesAndFilesToScan=""
 
 # Scan all files in the artifacts directory (e.g. *.ear, *.war, *.jar for Java)
@@ -69,11 +69,13 @@ if [ -d "${ARTIFACTS_DIRECTORY}" ] ; then
 fi
 
 # Scan Typescript analysis json data files in the artifacts/typescript directory
-typescriptAnalysisFiles="$(source "${SCRIPTS_DIR}/findTypescriptDataFiles.sh")"
+typescriptAnalysisFiles="$(find . -type f -path "*/.reports/jqa/ts-output.json" -exec echo typescript:project::{} \; | tr '\n' ',' | sed 's/,$/\n/')"
 if [ -n "${typescriptAnalysisFiles}" ]; then
     directoriesAndFilesToScan="${directoriesAndFilesToScan},${typescriptAnalysisFiles}"
 fi
 
+# ------------------------------------------------------------------
+
 # Use jQAssistant to scan the downloaded artifacts and write the results into the separate, local Neo4j Graph Database
 echo "resetAndScan: Using jQAssistant CLI version ${JQASSISTANT_CLI_VERSION} to scan: ${directoriesAndFilesToScan}"