pmd-bin 1.37.0 → 2.0.0

package/README.md

@@ -7,13 +7,13 @@
 ## Installation
 
 ```console
-npm install pmd-bin
+npm install --global pmd-bin
 ```
 
 ## Usage
 
 ```console
-pmd -help
+pmd --help
 ```
 
 ## Maintenance

package/dist/pmd-bin/bin/{run.sh → pmd}

@@ -1,18 +1,5 @@
 #!/bin/bash
 
-usage() {
-    echo "Usage:"
-    echo "    $(basename "$0") <application-name> [-h|-v] ..."
-    echo ""
-    echo "application-name: valid options are: $(valid_app_options)"
-    echo "-h print this help"
-    echo "-v display PMD's version"
-}
-
-valid_app_options () {
-    echo "pmd, cpd, cpd-gui, designer, bgastviewer, designerold, ast-dump"
-}
-
 is_cygwin() {
     case "$(uname)" in
         CYGWIN*|MINGW*)
@@ -65,14 +52,13 @@ set_lib_dir() {
     if [ -L "$0" ]; then
       local script_real_loc=$(readlink "$0")
     else
-      local script_real_loc=$0
+      local script_real_loc=${BASH_SOURCE[0]:-${(%):-%x}}
     fi
     local script_dir=$(dirname "${script_real_loc}")
-    local cwd="${PWD}"
 
-    cd "${script_dir}/../lib"
+    pushd "${script_dir}/../lib" >/dev/null
     readonly LIB_DIR=$(pwd -P)
-    cd "${cwd}"
+    popd >/dev/null
   fi
 }
 
@@ -82,11 +68,40 @@ check_lib_dir() {
   fi
 }
 
+set_conf_dir() {
+  if [ -z ${CONF_DIR} ]; then
+    # Allow for symlinks to this script
+    if [ -L $0 ]; then
+      local script_real_loc=$(readlink "$0")
+    else
+      local script_real_loc=${BASH_SOURCE[0]:-${(%):-%x}}
+    fi
+    local script_dir=$(dirname "${script_real_loc}")
+
+    pushd "${script_dir}/../conf" >/dev/null
+    readonly CONF_DIR=$(pwd -P)
+    popd >/dev/null
+  fi
+}
+
+check_conf_dir() {
+  if [ ! -e "${CONF_DIR}" ]; then
+    echo "The configuration directory [${CONF_DIR}] does not exist"
+  fi
+}
+
 function script_exit() {
     echo "$1" >&2
     exit 1
 }
 
+function check_java() {
+  java -version >/dev/null 2>&1
+  if [ $? -ne 0 ]; then
+    script_exit "No java executable found in PATH"
+  fi
+}
+
 determine_java_version() {
     local full_ver=$(java -version 2>&1)
     # java_ver is eg "80" for java 1.8, "90" for java 9.0, "100" for java 10.0.x
@@ -140,9 +155,9 @@ jre_specific_vm_options() {
 
 function add_pmd_classpath() {
     if [ -n "$classpath" ]; then
-        classpath="$classpath:${LIB_DIR}/*"
+        classpath="$classpath:${CONF_DIR}:${LIB_DIR}/*"
     else
-        classpath="${LIB_DIR}/*"
+        classpath="${CONF_DIR}:${LIB_DIR}/*"
     fi
 }
 
@@ -172,49 +187,15 @@ function add_openjfx_classpath() {
 }
 
 readonly APPNAME="${1}"
-if [ -z "${APPNAME}" ]; then
-    usage
-    exit 1
-fi
-shift
-
-case "${APPNAME}" in
-  "pmd")
-    readonly CLASSNAME="net.sourceforge.pmd.PMD"
-    ;;
-  "cpd")
-    readonly CLASSNAME="net.sourceforge.pmd.cpd.CPD"
-    ;;
-  "designer")
-    readonly CLASSNAME="net.sourceforge.pmd.util.fxdesigner.DesignerStarter"
-    ;;
-  "designerold")
-    echo "'designerold' is deprecated and will be removed in PMD 7.0.0, try the new 'designer' instead."
-    readonly CLASSNAME="net.sourceforge.pmd.util.designer.Designer"
-    ;;
-  "bgastviewer")
-    echo "'bgastviewer' is deprecated and will be removed in PMD 7.0.0, try the new 'designer' instead."
-    readonly CLASSNAME="net.sourceforge.pmd.util.viewer.Viewer"
-    ;;
-  "cpdgui")
-    echo "'cpdgui' is deprecated and will be removed in PMD 7.0.0, use 'cpd-gui' instead."
-    readonly CLASSNAME="net.sourceforge.pmd.cpd.GUI"
-    ;;
-  "cpd-gui")
-    readonly CLASSNAME="net.sourceforge.pmd.cpd.GUI"
-    ;;
-  "ast-dump")
-    readonly CLASSNAME="net.sourceforge.pmd.util.treeexport.TreeExportCli"
-    ;;
-  *)
-    echo "${APPNAME} is NOT a valid application name, valid options are: $(valid_app_options)"
-    ;;
-esac
 
 is_cygwin
 
+check_java
+
 set_lib_dir
 check_lib_dir
+set_conf_dir
+check_conf_dir
 
 convert_cygwin_vars
 
@@ -228,4 +209,4 @@ cygwin_paths
 
 java_heapsize_settings
 
-java ${HEAPSIZE} ${PMD_JAVA_OPTS} $(jre_specific_vm_options) -cp "${classpath}" "${CLASSNAME}" "$@"
+java ${HEAPSIZE} ${PMD_JAVA_OPTS} $(jre_specific_vm_options) -cp "${classpath}" net.sourceforge.pmd.cli.PmdCli "$@"

package/dist/pmd-bin/bin/pmd.bat

@@ -1,11 +1,79 @@
 @echo off
+rem make all variables local to not add new global environment variables to the current cmd session
+setlocal
 set TOPDIR="%~dp0.."
 set OPTS=
-set MAIN_CLASS=net.sourceforge.pmd.PMD
-set PMD_CLASSPATH=%TOPDIR%\lib\*
+set COMMAND=%1
+set MAIN_CLASS=net.sourceforge.pmd.cli.PmdCli
 
-if [%CLASSPATH%] NEQ [] (
-    set PMD_CLASSPATH=%CLASSPATH%;%PMD_CLASSPATH%
+rem check whether java is available at all
+java -version > nul 2>&1 || (
+    echo No java executable found in PATH
+    exit /b 1
 )
 
-java %PMD_JAVA_OPTS% -classpath %PMD_CLASSPATH% %OPTS% %MAIN_CLASS% %*
+rem sets the jver variable to the java version, eg 90 for 9.0.1+x or 80 for 1.8.0_171-b11 or 110 for 11.0.6.1
+rem sets the jvendor variable to either java (oracle) or openjdk
+for /f tokens^=1^,3^,4^,5^ delims^=.-_+^"^  %%j in ('java -version 2^>^&1 ^| findstr /c:"version"') do (
+  set jvendor=%%j
+  if %%l EQU ea (
+    set /A "jver=%%k0"
+  ) else (
+    if %%k EQU 1 (
+      rem for java version 1.7.x, 1.8.x, ignore the first 1.
+      set /A "jver=%%l%%m"
+    ) else (
+      set /A "jver=%%k%%l"
+    )
+  )
+)
+
+Set "jreopts="
+rem oracle java 9 and 10 has javafx included as a module
+if /I %jvendor% == java (
+    if %jver% GEQ 90 (
+        if %jver% LSS 110 (
+            rem enable reflection
+            SETLOCAL EnableDelayedExpansion
+            rem java9 and java10 from oracle contain javafx as a module
+            rem open internal module of javafx to reflection (for our TreeViewWrapper)
+            set "jreopts=--add-opens javafx.controls/javafx.scene.control.skin=ALL-UNNAMED"
+            rem The rest here is for RichtextFX
+            set "jreopts=!jreopts! --add-opens javafx.graphics/javafx.scene.text=ALL-UNNAMED"
+            set "jreopts=!jreopts! --add-opens javafx.graphics/com.sun.javafx.scene.text=ALL-UNNAMED"
+            set "jreopts=!jreopts! --add-opens javafx.graphics/com.sun.javafx.text=ALL-UNNAMED"
+            set "jreopts=!jreopts! --add-opens javafx.graphics/com.sun.javafx.geom=ALL-UNNAMED"
+            rem Warn of remaining illegal accesses
+            set "jreopts=!jreopts! --illegal-access=warn"
+        )
+    )
+)
+
+set "_needjfxlib=0"
+if [%COMMAND%] == [designer] (
+    if /I %jvendor% == openjdk set _needjfxlib=1
+    if /I %jvendor% == java (
+        if %jver% GEQ 110 set _needjfxlib=1
+    )
+)
+if %_needjfxlib% EQU 1 (
+    if %jver% LSS 100 (
+        echo For openjfx at least java 10 is required.
+        exit /b 1
+    )
+    if not defined JAVAFX_HOME (
+        echo The environment variable JAVAFX_HOME is missing.
+        exit /b 1
+    )
+    rem The wildcard will include only jar files, but we need to access also
+    rem property files such as javafx.properties that lay bare in the dir
+    set pmd_classpath=%TOPDIR%\conf;%TOPDIR%\lib\*;%JAVAFX_HOME%\lib\*;%JAVAFX_HOME%\lib\
+) else (
+    set pmd_classpath=%TOPDIR%\conf;%TOPDIR%\lib\*
+)
+
+if defined CLASSPATH (
+    set pmd_classpath=%CLASSPATH%;%pmd_classpath%
+)
+
+java %PMD_JAVA_OPTS% %jreopts% -classpath %pmd_classpath% %OPTS% %MAIN_CLASS% %*

package/dist/pmd-bin/conf/simplelogger.properties

@@ -0,0 +1,22 @@
+#
+# BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+#
+
+org.slf4j.simpleLogger.logFile=System.err
+org.slf4j.simpleLogger.showDateTime=false
+org.slf4j.simpleLogger.dateTimeFormat=yyyy-MM-dd'T'HH:mm:ss.SSSXXX
+org.slf4j.simpleLogger.showThreadName=false
+org.slf4j.simpleLogger.showThreadId=false
+org.slf4j.simpleLogger.showLogName=false
+org.slf4j.simpleLogger.showShortLogName=false
+org.slf4j.simpleLogger.levelInBrackets=true
+
+# Default log level for all loggers
+# Must be one of "trace", "debug", "info", "warn", "error" or "off"
+# Will be changed by "--debug" command line option
+org.slf4j.simpleLogger.defaultLogLevel=info
+
+# configure logging detail level for a single logger.
+# Must be one of "trace", "debug", "info", "warn", "error" or "off"
+#org.slf4j.simpleLogger.log.net.sourceforge.pmd.PMD=debug
+#org.slf4j.simpleLogger.log.com.example.rules.MyRule=debug