From 52abcfeed07d308b2b377985b5cb8a776bb2e375 Mon Sep 17 00:00:00 2001 From: Svjatoslav Agejenko Date: Sun, 24 Dec 2017 16:58:40 +0200 Subject: [PATCH] Added reference to Tony Bargnesi github page. Initial version for commandline launcher. --- commandline launcher/install | 24 +++++++++++++++++++ commandline launcher/javainspect | 16 +++++++++++++ doc/index.org | 13 ++++++---- pom.xml | 3 ++- .../eu/svjatoslav/inspector/java/Main.java | 5 ++-- usage examples/demo project/pom.xml | 4 ++-- 6 files changed, 56 insertions(+), 9 deletions(-) create mode 100755 commandline launcher/install create mode 100755 commandline launcher/javainspect diff --git a/commandline launcher/install b/commandline launcher/install new file mode 100755 index 0000000..f17fc78 --- /dev/null +++ b/commandline launcher/install @@ -0,0 +1,24 @@ +#!/bin/bash + +( + # go to project root directory + cd .. + + # This script installs JavaInspect into /opt/javainspect/ directory. + # It also enables javainspect command at the commandline. + + # remove old installation (if any) + sudo rm -rf /opt/javainspect/ + + # compile new package + mvn clean package + + # create installation directory + sudo mkdir -p /opt/javainspect/ + + # copy javainspect jar file to opt installation directory + sudo cp target/javainspect.jar /opt/javainspect/ +) + +# deploy launcher script to /usr/local/bin/javainspect +sudo cp javainspect /usr/local/bin/ diff --git a/commandline launcher/javainspect b/commandline launcher/javainspect new file mode 100755 index 0000000..eb6110c --- /dev/null +++ b/commandline launcher/javainspect @@ -0,0 +1,16 @@ +#!/bin/bash +# +# Launcher script for JavaInspect utility: +# http://www2.svjatoslav.eu/gitbrowse/javainspect/doc/ +# + +# Commandline parameters: +# [JAR_FILE_PATH] [GRAPH_NAME] [[OPTIONS] ...] +# +# + + +java \ + -cp .:./example/target/myproject-0.0.jar:./target/javainspect-1.6-SNAPSHOT.jar \ + eu.svjatoslav.inspector.java.Main \ + ./example/src/main/java/ com.myproject.* myproject diff --git a/doc/index.org b/doc/index.org index bcbbf0a..09f1266 100644 --- a/doc/index.org +++ b/doc/index.org @@ -7,10 +7,14 @@ it under the terms of version 3 of the [[https://www.gnu.org/licenses/lgpl.html][GNU Lesser General Public License]] or later as published by the Free Software Foundation. -- Program author: +- Program authors: - Svjatoslav Agejenko - - Homepage: http://svjatoslav.eu - - Email: mailto://svjatoslav@svjatoslav.eu + - Homepage: http://svjatoslav.eu + - Email: mailto://svjatoslav@svjatoslav.eu + + - Tony Bargnesi + - GitHub fork for the project: + https://github.com/abargnesi/javainspect - [[http://www.svjatoslav.eu/programs.jsp][other applications hosted at svjatoslav.eu]] @@ -195,7 +199,8 @@ sudo apt-get install graphviz - BUG: Should not hide references if there are too many of them to classes if referring classes are not visible anyway because of blacklist/whitelist rules. Basically reference counting should exclude not visible classes. -- FEATURE: replace internal java parser with: https://javaparser.org/ +- FEATURE: replace internal java parser in package + eu.svjatoslav.inspector.java.methods with: https://javaparser.org/ - FEATURE: integarte with [[http://plantuml.com/class-diagram][PlantUML]]. - FEATURE: add dark theme - FEATURE: sort Class fields by alphabet diff --git a/pom.xml b/pom.xml index 592064d..2aa7657 100644 --- a/pom.xml +++ b/pom.xml @@ -4,7 +4,7 @@ javainspect 1.7-SNAPSHOT jar - Java inspect + JavaInspect Utility to visualize Java code @@ -19,6 +19,7 @@ + javainspect org.apache.maven.plugins diff --git a/src/main/java/eu/svjatoslav/inspector/java/Main.java b/src/main/java/eu/svjatoslav/inspector/java/Main.java index 080bdab..f24eae3 100644 --- a/src/main/java/eu/svjatoslav/inspector/java/Main.java +++ b/src/main/java/eu/svjatoslav/inspector/java/Main.java @@ -5,6 +5,9 @@ import eu.svjatoslav.inspector.java.structure.ClassGraph; import static java.io.File.separator; import static java.lang.System.getProperty; +/** + * This class acts as a commandline interface for JavaInspect. + */ public class Main { public static void main(String[] args) { if (args.length == 0) { @@ -23,7 +26,5 @@ public class Main { cg.whitelistClassGlob(packageGlob); cg.setKeepDotFile(true); cg.generateGraph(graphName); - - System.exit(0); } } diff --git a/usage examples/demo project/pom.xml b/usage examples/demo project/pom.xml index faee7f6..6a16ce8 100644 --- a/usage examples/demo project/pom.xml +++ b/usage examples/demo project/pom.xml @@ -4,8 +4,8 @@ javainspect-demo 1.0-SNAPSHOT jar - Java inspect demo - Demonstration project for Java inspect utility + JavaInspect demo + Demonstration project for JavaInspect utility -- 2.20.1