Merge pull request #1 from elide-dev/chore/cleanups

chore: general plugin cleanups

Author: melodicore

README.md

@@ -0,0 +1,53 @@
+# Elide Maven Plugin
+
+This plugin can be consumed in a Maven project to use [Elide](https://elide.dev).
+
+> [!WARNING]
+> This plugin is currently under development.
+
+## Features
+
+- [x] Swap out `javac ...` for `elide javac -- ...`
+- [x] Supports explicit path to `elide`
+- [ ] Resolve `elide` via the `PATH`
+- [ ] Swap out `kotlinc ...` for `elide kotlinc -- ...`
+- [ ] Usability of Elide as a Maven toolchain
+
+## Usage
+
+Configuring Elide as your `javac` compiler:
+
+**`pom.xml`**
+```xml
+    <build>
+        <plugins>
+            <plugin>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.13.0</version>
+                <dependencies>
+                    <dependency>
+                        <groupId>dev.elide</groupId>
+                        <artifactId>elide-plexus-compilers</artifactId>
+                        <version>1.0.0-SNAPSHOT</version>
+                    </dependency>
+                </dependencies>
+                <configuration>
+                    <compilerId>elide</compilerId>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+```
+
+Properties needed:
+```xml
+    <properties>
+        <maven.compiler.executable>/path/to/elide</maven.compiler.executable>
+        <maven.compiler.source>24</maven.compiler.source>
+        <maven.compiler.target>24</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+```
+
+> [!TIP]
+> See the [sample project](./sample) for a usage example. Elide also provides a [Gradle plugin](https://github.com/elide-dev/gradle).

build.gradle.kts

@@ -7,10 +7,11 @@ plugins {
 }
 
 group = "dev.elide"
-version = "1.0-SNAPSHOT"
+version = "1.0.0-SNAPSHOT"
 
 repositories {
     mavenCentral()
+    mavenLocal()
 }
 
 java {

sample/.gitignore

@@ -0,0 +1 @@
+target/

sample/.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1,19 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+wrapperVersion=3.3.2
+distributionType=only-script
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.9/apache-maven-3.9.9-bin.zip

sample/README.md

@@ -0,0 +1,36 @@
+## Elide Maven Plugin: Sample Project
+
+This project demonstrates use of Elide as a replacement for `javac` within a Maven project. There is some Java source
+code to build, and the `pom.xml` is configured to use Elide.
+
+**`pom.xml`**
+```xml
+    <build>
+        <plugins>
+            <plugin>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.13.0</version>
+                <dependencies>
+                    <dependency>
+                        <groupId>dev.elide</groupId>
+                        <artifactId>elide-plexus-compilers</artifactId>
+                        <version>1.0.0-SNAPSHOT</version>
+                    </dependency>
+                </dependencies>
+                <configuration>
+                    <compilerId>elide</compilerId>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+```
+
+Properties needed:
+```xml
+    <properties>
+        <maven.compiler.executable>/path/to/elide</maven.compiler.executable>
+        <maven.compiler.source>24</maven.compiler.source>
+        <maven.compiler.target>24</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+```