Skip to content

Commit 5dd0b16

Browse files
committed
[feature] Update README.md to keep consistency with other plugins and update to jQAssistant 1.7.0.
1 parent ff526ce commit 5dd0b16

File tree

2 files changed

+28
-10
lines changed

2 files changed

+28
-10
lines changed

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,36 @@
1-
# jQAssistant JavaScript Source Parser Plugin #
1+
# jQAssistant JavaScript Plugin
22

33
[![GitHub license](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://github.com/softvis-research/jqa-githubissues-plugin/blob/master/LICENSE)
44
[![Build Status](https://api.travis-ci.com/softvis-research/jqa-javascript-plugin.svg?branch=development)](https://travis-ci.com/softvis-research/jqa-javascript-plugin)
55
[![codecov](https://codecov.io/gh/softvis-research/jqa-javascript-plugin/branch/development/graph/badge.svg)](https://codecov.io/gh/softvis-research/jqa-javascript-plugin)
66

7-
8-
This is a JavaScript parser for [jQAssistant](https://www.jqassistant.org). It enables jQAssistant to scan and to analyze [JavaScript](https://www.ecma-international.org/ecma-262/9.0/index.html#Title) files.
7+
This is a JavaScript parser for [jQAssistant](https://jqassistant.org/).
8+
It enables jQAssistant to scan and to analyze JavaScript file.
99

1010
## Getting Started
11-
### Standalone
12-
Download [jQAssistant](https://jqassistant.org/get-started/) for command line usage. To build the project create a new maven run configuration for the project with the goals ```clean install```. You can find the resulting jar file in the target folder of the project. Then run:
11+
12+
Download the jQAssistant command line tool for your system: [jQAssistant - Get Started](https://jqassistant.org/get-started/).
13+
14+
Next download the latest version from the release tab. Put the `jqassistant-javascript-plugin-*.jar` into the plugins folder of the jQAssistant command
15+
line tool.
16+
17+
Now scan your code and wait for the plugin to finish:
1318

1419
```bash
15-
# Scan the GitHub-Repositories
16-
jqassistant-commandline-neo4jv3-1.4.0/bin/jqassistant.sh scan -f
20+
jqassistant.sh scan -f
21+
```
22+
23+
You can then start a local Neo4j server to start querying the database at [http://localhost:7474](http://localhost:7474):
1724

18-
# Start a Neo4J web UI to explore the result:
19-
jqassistant-commandline-neo4jv3-1.4.0/bin/jqassistant.sh server
25+
```bash
26+
jqassistant.sh server
2027
```
2128

29+
2230
## Labels and relations
2331

2432
### Labels
33+
2534
The JavaScript plugin uses the following labels in the resulting graph:
2635

2736
| Label | Description |
@@ -41,7 +50,9 @@ The JavaScript plugin uses the following labels in the resulting graph:
4150
|```:String```|Nodes that represent JavaScript [null](https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/String).|
4251

4352
### Relations
53+
4454
#### JavaScriptFile
55+
4556
```java
4657
(:JavaScriptFile) -[DECLARES] -> (:Variable)
4758
(:JavaScriptFile) -[DECLARES] -> (:Class)

pom.xml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<parent>
77
<groupId>org.jqassistant.contrib.common</groupId>
88
<artifactId>parent</artifactId>
9-
<version>1.6.0</version>
9+
<version>1.7.0</version>
1010
</parent>
1111

1212
<groupId>org.jqassistant.contrib.plugin</groupId>
@@ -37,6 +37,13 @@
3737
</license>
3838
</licenses>
3939

40+
<scm>
41+
<connection>scm:git:git@github.com:softvis-research/jqa-javascript-plugin.git</connection>
42+
<developerConnection>scm:git:git@github.com:softvis-research/jqa-javascript-plugin.git</developerConnection>
43+
<url>https://github.com/softvis-research/jqa-javascript-plugin.git</url>
44+
<tag>HEAD</tag>
45+
</scm>
46+
4047
<pluginRepositories>
4148
<pluginRepository>
4249
<snapshots>

0 commit comments

Comments
 (0)