[#11932] CLI APIs should log more helpful error messages on

NoClassDefFoundError

jOOQ/src/main/java/org/jooq/CLIUtil.java

@@ -0,0 +1,65 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * Other licenses:
+ * -----------------------------------------------------------------------------
+ * Commercial licenses for this work are available. These replace the above
+ * ASL 2.0 and offer limited warranties, support, maintenance, and commercial
+ * database integrations.
+ *
+ * For more information, please visit: http://www.jooq.org/licenses
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ */
+package org.jooq;
+
+import static org.jooq.Constants.MINOR_VERSION;
+
+/**
+ * Common utilities for {@link ParserCLI}, {@link DiffCLI} and others.
+ *
+ * @author Lukas Eder
+ */
+final class CLIUtil {
+
+    static void main(String url, Runnable runnable) {
+        try {
+            runnable.run();
+        }
+        catch (NoClassDefFoundError e) {
+            throw new RuntimeException(
+                """
+                A class definition could not be found when running the CLI utility.
+
+                This is mostly due to a missing dependency. Make sure you have added the right dependencies
+                as according to the manual for {url}
+                """.replace("{url}", url.replace("/latest/", "/" + MINOR_VERSION + "/")),
+                e
+            );
+        }
+    }
+}

jOOQ/src/main/java/org/jooq/DiffCLI.java

@@ -51,22 +51,23 @@
 public final class DiffCLI {
 
     public static final void main(String... args) throws Exception {
-        Args a;
-        Settings settings = new Settings();
-        DSLContext ctx;
-
-        a = parse(args);
-        settings(a, settings);
-        ctx = ctx(a, settings);
-
-        if (a.done) {}
-        else if (a.toDialect == null || a.sql1 == null || a.sql2 == null) {
-            System.out.println("Mandatory arguments: -T and -1, -2. Use -h for help");
-            throw new RuntimeException();
-        }
-        else {
-            render(ctx, a);
-        }
+        CLIUtil.main("https://www.jooq.org/doc/latest/manual/sql-building/schema-diff-cli/", () -> {
+            Args a;
+            Settings settings = new Settings();
+            DSLContext ctx;
+
+            a = parse(args);
+            settings(a, settings);
+            ctx = ctx(a, settings);
+
+            if (a.done) {}
+            else if (a.toDialect == null || a.sql1 == null || a.sql2 == null) {
+                System.out.println("Mandatory arguments: -T and -1, -2. Use -h for help");
+                throw new RuntimeException();
+            }
+            else
+                render(ctx, a);
+        });
     }
 
     private static final DSLContext ctx(Args a, Settings settings) {

jOOQ/src/main/java/org/jooq/ParserCLI.java

@@ -62,25 +62,26 @@ public final class ParserCLI {
     private static final Pattern FLAG = Pattern.compile("^/([\\w\\-]+)(?:\\s+(\\w+))?\\s*$");
 
     public static final void main(String... args) throws Exception {
-        Args a;
-        Settings settings = new Settings();
-        DSLContext ctx;
+        CLIUtil.main("https://www.jooq.org/doc/latest/manual/sql-building/sql-parser/sql-parser-cli/", () -> {
+            Args a;
+            Settings settings = new Settings();
+            DSLContext ctx;
 
-        a = parse(args);
-        settings(a, settings);
-        ctx = ctx(a, settings);
+            a = parse(args);
+            settings(a, settings);
+            ctx = ctx(a, settings);
 
-        if (a.interactive || args == null || args.length == 0) {
-            interactiveMode(ctx, a);
-        }
-        else if (a.done) {}
-        else if (a.toDialect == null || a.sql == null) {
-            System.out.println("Mandatory arguments: -T and -s. Use -h for help");
-            throw new RuntimeException();
-        }
-        else {
-            render(ctx, a);
-        }
+            if (a.interactive || args == null || args.length == 0) {
+                interactiveMode(ctx, a);
+            }
+            else if (a.done) {}
+            else if (a.toDialect == null || a.sql == null) {
+                System.out.println("Mandatory arguments: -T and -s. Use -h for help");
+                throw new RuntimeException();
+            }
+            else
+                render(ctx, a);
+        });
     }
 
     private static final DSLContext ctx(Args a, Settings settings) {