Installation

1. jQA CLI Installation

Download the ZIP-distribution of the jQAssistant command line utility (Neo4j 4 or Neo4j 5) and unpack it

2. npm LCE Tool Installation

Global Installation:

run npm install --global @jqassistant/ts-lce

Local Installation:

Run npm install --save-dev @jqassistant/ts-lce
Add the following section to the package.json (add additional options as needed)
```
"scripts": {  
    "jqa": "jqa-ts-lce"  
}
```

3. Project Setup

create a .jqassistant.yml file in the directory that contains your project(s)

jqassistant:
  plugins:
    - group-id: org.jqassistant.plugin.typescript
      artifact-id: jqassistant-typescript-plugin
      version: 1.2.0
  scan:
    include:
      files:
	    - typescript:project::build/jqa-ts-output.json

for the most recent versions of the plugin see the Maven

NOTE

From version 1.2.0 onward, the version of the @jqassistant/ts-lce Node package and the version of the jQA plugin have to match to avoid incompatibility issues.

to exclude unwanted scans of directories like node_modules you can exclude them in the jqassistant.yml:

jqassistant:
  scan:
	properties:
	  file.exclude:
		- /node_modules/**
		- /dist/**
		- /jqassistant/**

see Basic Usage for more details on how to run the tool