feat (java): Introduce initial Maven & JBang support

.pre-commit-config.yaml

@@ -115,6 +115,8 @@ repos:
       - id: pretty-format-java
         # Keep this version in sync with the same version in .vscode/settings.json
         args: [--autofix, --aosp, --google-java-formatter-version=1.25.1]
+        # See https://github.com/google/google-java-format/issues/1216
+        exclude: learn/jbang
 
   - repo: https://github.com/DavidAnson/markdownlint-cli2
     rev: v0.16.0

.vscode/extensions.json

@@ -18,7 +18,8 @@
     "stardog-union.vscode-langserver-turtle",
     "zazuko.vscode-rdf-sketch",
     "redhat.vscode-yaml",
-    "gruntfuggly.todo-tree"
+    "gruntfuggly.todo-tree",
+    "jbangdev.jbang-vscode"
   ],
   "unwantedRecommendations": [
     // https://github.com/kshetline/ligatures-limited/issues/39

.vscode/settings.json

@@ -164,7 +164,10 @@
     "tools": false,
     "web": false,
     "BUILT": false,
-    ".built": true,
-    "third_party": false
+    ".built": false,
+    "third_party": false,
+    ".jbang": false,
+    "META-INF": false,
+    "learn": false
   }
 }

docs/dev/jbang.md

@@ -0,0 +1,37 @@
+<!--
+    SPDX-License-Identifier: Apache-2.0
+
+    Copyright 2024 The Enola <https://enola.dev> Authors
+
+    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
+
+        https://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.
+-->
+
+# JBang
+
+Java developers (not end-users) can use Enola via [JBang](https://www.jbang.dev/).
+
+<!-- TODO [`learn/jbang`](https://github.com/enola-dev/enola/tree/main/learn/jbang) --> `learn/jbang`
+has an example project illustrating how this works; clone and go there, and then:
+
+1. `tools/maven/install.bash`
+1. `cd learn/jbang`
+1 `./jbang hello.java` will run an example using Enola
+1. `./jbang edit --sandbox --open=code hello.java` opens an IDE
+
+<!-- TODO Improve JBang integration:
+        1. Build Enola on JitPack, and remove the need for step #1.
+        2. Move `learn/jbang` out into a separate Git repo?
+(But then how to test it in CI?
+A Monorepo is very nice for that.
+Perhaps just write a script to automagically extract (copy) it into a small repo?
+-->

java/dev/enola/BUILD

@@ -15,7 +15,7 @@
 # limitations under the License.
 
 load("@rules_java//java:defs.bzl", "java_library")
-# TODO load("@rules_jvm_external//:defs.bzl", "java_export")
+load("@rules_jvm_external//:defs.bzl", "java_export")
 
 java_library(
     name = "api",
@@ -30,10 +30,11 @@ java_library(
     ],
 )
 
-# TODO java_export
-java_library(
+java_export(
     name = "enola",
-    # TODO maven_coordinates = "dev.enola:enola:main-SNAPSHOT",
+    maven_coordinates = "dev.enola:enola:0.0.1-SNAPSHOT",
+    # TODO Fix JavaDoc generation which somehow breaks the build; see https://github.com/enola-dev/enola/issues/491
+    tags = ["no-javadocs"],
     visibility = ["//:__subpackages__"],
     runtime_deps = [
         "//java/dev/enola/common",

jitpack.yml

@@ -0,0 +1,5 @@
+jdk:
+  - openjdk21
+
+install:
+  - tools/maven/install.bash

learn/jbang/README.md

@@ -0,0 +1,24 @@
+<!--
+    SPDX-License-Identifier: Apache-2.0
+
+    Copyright 2024 The Enola <https://enola.dev> Authors
+
+    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
+
+        https://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.
+-->
+
+# Using Enola.dev with JBang
+
+See documentation, [local](../../docs/dev/jbang.md) or on <!--
+TODO [docs.enola.dev](https://docs.enola.dev/dev/jbang/)! --> docs.enola.dev!
+
+This is tested by `//tools/maven/test.bash`.

learn/jbang/hello.java

@@ -0,0 +1,28 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Copyright 2024 The Enola <https://enola.dev> Authors
+ *
+ * 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
+ *
+ *     https://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.
+ */
+
+//JAVA 21
+//COMPILE_OPTIONS --enable-preview -source 21
+//RUNTIME_OPTIONS --enable-preview
+//DEPS dev.enola:enola:0.0.1-SNAPSHOT
+
+import static java.lang.System.out;
+
+void main() {
+    out.println("Hello World: " + dev.enola.common.Version.get());
+}

mkdocs.yaml

@@ -88,7 +88,7 @@ nav:
       # - Java:
       #   - Maven:
       #   - JavaDoc:
-      #   - JBang:
+      - JBang: dev/jbang.md
       # - Contributors:
       - Set-Up: dev/setup.md
       - IDE: dev/ide.md

tools/maven/install.bash

@@ -0,0 +1,29 @@
+#!/usr/bin/env bash
+# SPDX-License-Identifier: Apache-2.0
+#
+# Copyright 2023-2024 The Enola <https://enola.dev> Authors
+#
+# 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
+#
+#     https://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.
+
+set -euox pipefail
+
+# This installs the Maven Artifacts into a local repository...
+
+bazelisk build //java/dev/enola
+
+./java/mvnw install:install-file \
+    -Dfile=bazel-bin/java/dev/enola/enola-project.jar \
+    -Dsources=bazel-bin/java/dev/enola/enola-project-src.jar \
+    -DpomFile=bazel-bin/java/dev/enola/enola-pom.xml
+
+# TODO -Djavadoc=

tools/maven/test.bash

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+# SPDX-License-Identifier: Apache-2.0
+#
+# Copyright 2023-2024 The Enola <https://enola.dev> Authors
+#
+# 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
+#
+#     https://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.
+
+set -euox pipefail
+
+tools/maven/install.bash
+
+learn/jbang/jbang learn/jbang/hello.java

tools/test-ci/test.bash

@@ -39,3 +39,6 @@ tools/git/test.bash
 
 # Test distros: 1. End-user distributed executable fat über JAR, 2. Container Image
 tools/distro/test.bash
+
+# Test Maven repo, via JBang integration support
+tools/maven/test.bash