Fix up naming and add more docs

JonathanGiles · Jul 15, 2024 · 2cf109c · 2cf109c
1 parent 4c386ce
commit 2cf109c
Show file tree

Hide file tree

Showing 11 changed files with 57 additions and 13 deletions.
diff --git a/...nsions/manifest/azure/storage-ext/pom.xml → ...nsions/manifold/azure/storage-ext/pom.xml b/...nsions/manifest/azure/storage-ext/pom.xml → ...nsions/manifold/azure/storage-ext/pom.xml
@@ -6,14 +6,18 @@
 
     <parent>
         <groupId>com.microsoft.aspire</groupId>
-        <artifactId>aspire4j-extensions-manifest-ext</artifactId>
+        <artifactId>aspire4j-extensions-manifold-ext</artifactId>
         <version>1.0-SNAPSHOT</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
 
     <artifactId>aspire4j-extensions-azure-storage-ext</artifactId>
     <version>1.0-SNAPSHOT</version>
 
+    <properties>
+        <maven.javadoc.skip>true</maven.javadoc.skip>
+    </properties>
+
     <dependencies>
         <dependency>
             <groupId>com.microsoft.aspire</groupId>

diff --git a/...n/AzureStorageDistributedApplication.java → ...n/AzureStorageDistributedApplication.java b/...n/AzureStorageDistributedApplication.java → ...n/AzureStorageDistributedApplication.java
@@ -1,4 +1,4 @@
-package azure.storage.manifest.extensions.com.microsoft.aspire.DistributedApplication;
+package manifold.azure.storage.extensions.com.microsoft.aspire.DistributedApplication;
 
 import com.microsoft.aspire.extensions.azure.storage.resources.AzureStorageResource;
 import manifold.ext.rt.api.Extension;

diff --git a/...torage-ext/src/main/java/module-info.java → ...torage-ext/src/main/java/module-info.java b/...torage-ext/src/main/java/module-info.java → ...torage-ext/src/main/java/module-info.java
@@ -2,10 +2,10 @@
 /**
  * An Aspire extension providing support for Azure Storage.
  */
-module com.microsoft.aspire.extensions.manifest.azure.storage {
+module com.microsoft.aspire.extensions.manifold.azure.storage {
     requires transitive com.microsoft.aspire.extensions.azure.storage;
     requires manifold.rt;
     requires manifold.ext.rt;
 
-    exports azure.storage.manifest.extensions.com.microsoft.aspire.DistributedApplication;
+    exports manifold.azure.storage.extensions.com.microsoft.aspire.DistributedApplication;
 }
diff --git a/aspire4j/extensions/manifest/pom.xml → aspire4j/extensions/manifold/pom.xml b/aspire4j/extensions/manifest/pom.xml → aspire4j/extensions/manifold/pom.xml
@@ -11,7 +11,7 @@
         <relativePath>../../pom.xml</relativePath>
     </parent>
 
-    <artifactId>aspire4j-extensions-manifest-ext</artifactId>
+    <artifactId>aspire4j-extensions-manifold-ext</artifactId>
     <version>1.0-SNAPSHOT</version>
     <packaging>pom</packaging>
 
@@ -54,6 +54,20 @@
                     </annotationProcessorPaths>
                 </configuration>
             </plugin>
+
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-jar-plugin</artifactId>
+                <version>3.4.2</version>
+                <configuration>
+                    <archive>
+                        <manifestEntries>
+                            <!--class files as source must be available for extension method classes-->
+                            <Contains-Sources>java,class</Contains-Sources>
+                        </manifestEntries>
+                    </archive>
+                </configuration>
+            </plugin>
         </plugins>
     </build>
 </project>
diff --git a/aspire4j/extensions/manifold/readme.md b/aspire4j/extensions/manifold/readme.md
@@ -0,0 +1,5 @@
+# Aspire4J Manifold Extensions
+
+Experimental extension modules using the [Manifold] extensions functionality. These extension modules, when added to your project, will enable additional APIs in the core APIs in the Aspire4J framework (most notably, on DistributedApplication).
+
+[Manifold]: http://manifold.systems/
diff --git a/...4j/extensions/manifest/spring-ext/pom.xml → ...4j/extensions/manifold/spring-ext/pom.xml b/...4j/extensions/manifest/spring-ext/pom.xml → ...4j/extensions/manifold/spring-ext/pom.xml
@@ -6,14 +6,18 @@
 
     <parent>
         <groupId>com.microsoft.aspire</groupId>
-        <artifactId>aspire4j-extensions-manifest-ext</artifactId>
+        <artifactId>aspire4j-extensions-manifold-ext</artifactId>
         <version>1.0-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
     <artifactId>aspire4j-extensions-spring-ext</artifactId>
     <version>1.0-SNAPSHOT</version>
 
+    <properties>
+        <maven.javadoc.skip>true</maven.javadoc.skip>
+    </properties>
+
     <dependencies>
         <dependency>
             <groupId>com.microsoft.aspire</groupId>

diff --git a/aspire4j/extensions/manifold/spring-ext/readme.md b/aspire4j/extensions/manifold/spring-ext/readme.md
@@ -0,0 +1,19 @@
+# Aspire4J Manifold Extensions - Spring
+
+Experimental extension modules using the [Manifold] extensions functionality. To include this project dependency in your project, add the following to your `pom.xml` file:
+
+```xml
+<dependency>
+    <groupId>com.microsoft.aspire</groupId>
+    <artifactId>aspire4j-extensions-spring-ext</artifactId>
+    <version>1.0-SNAPSHOT</version>
+</dependency>
+```
+
+This extension module provides the following extensions:
+
+* `DistributedApplication`
+  * `addSpringProject(String name)`
+  * `addEurekaServiceDiscovery(String name)`
+
+[Manifold]: http://manifold.systems/
diff --git a/...ication/SpringDistributedApplication.java → ...ication/SpringDistributedApplication.java b/...ication/SpringDistributedApplication.java → ...ication/SpringDistributedApplication.java
@@ -1,4 +1,4 @@
-package spring.manifest.extensions.com.microsoft.aspire.DistributedApplication;
+package manifold.spring.extensions.com.microsoft.aspire.DistributedApplication;
 
 import com.microsoft.aspire.extensions.microservice.common.resources.EurekaServiceDiscovery;
 import com.microsoft.aspire.extensions.spring.resources.SpringProject;

diff --git a/...spring-ext/src/main/java/module-info.java → ...spring-ext/src/main/java/module-info.java b/...spring-ext/src/main/java/module-info.java → ...spring-ext/src/main/java/module-info.java
@@ -2,10 +2,10 @@
 /**
  * An Aspire extension providing support for <a href="https://spring.io">Spring</a> projects.
  */
-module com.microsoft.aspire.extensions.manifest.spring {
+module com.microsoft.aspire.extensions.manifold.spring {
     requires transitive com.microsoft.aspire.extensions.spring;
     requires manifold.rt;
     requires manifold.ext.rt;
 
-    exports spring.manifest.extensions.com.microsoft.aspire.DistributedApplication;
+    exports manifold.spring.extensions.com.microsoft.aspire.DistributedApplication;
 }
diff --git a/aspire4j/pom.xml b/aspire4j/pom.xml
@@ -36,8 +36,8 @@
         <module>extensions/quarkus</module>
         <module>extensions/spring</module>
 
-        <!-- manifest extension libraries -->
-        <module>extensions/manifest</module>
+        <!-- manifold extension libraries -->
+        <module>extensions/manifold</module>
     </modules>
 
     <build>
@@ -53,7 +53,6 @@
                     <additionalJOption>-Xdoclint:none</additionalJOption>
                 </configuration>
             </plugin>
-
         </plugins>
     </build>
 </project>
diff --git a/...er-apphost/src/main/java/com/microsoft/aspire/storageexplorer/StorageExplorerAppHost.java b/...er-apphost/src/main/java/com/microsoft/aspire/storageexplorer/StorageExplorerAppHost.java
@@ -38,7 +38,6 @@ public class StorageExplorerAppHost implements AppHost {
             .withReference(eurekaServiceDiscovery)
             .withOpenTelemetry();
 //            .withReference(openAI);
-
     }
 
     public static void main(String[] args) {