From 0af42d191506bd0f29089038e6358728c6ff9e54 Mon Sep 17 00:00:00 2001
From: Benny Yen <benny123tw@gmail.com>
Date: Wed, 26 Jun 2024 18:01:02 +0800
Subject: [PATCH] refactor: move ViteProperties in javite-webmvc

---
 gradle.properties                             |   2 +-
 .../com/javite/spring/config/ViteConfig.java  |   3 +-
 .../javite/spring/config/ViteProperties.java  | 124 ++++++++++++++++++
 .../src/main/resources/META-INF/vite.tld      |   8 +-
 .../com/javite/spring/config/ViteConfig.java  |   4 +-
 .../javite/spring/config/ViteProperties.java  | 124 ++++++++++++++++++
 .../src/main/resources/META-INF/vite.tld      |   2 +-
 7 files changed, 259 insertions(+), 8 deletions(-)
 create mode 100644 javite-webmvc-jre8/src/main/java/com/javite/spring/config/ViteProperties.java
 create mode 100644 javite-webmvc/src/main/java/com/javite/spring/config/ViteProperties.java

diff --git a/gradle.properties b/gradle.properties
index 33aa3f7..dfe35db 100644
--- a/gradle.properties
+++ b/gradle.properties
@@ -1 +1 @@
-version=0.1.2
+version=0.1.3-alpha
diff --git a/javite-webmvc-jre8/src/main/java/com/javite/spring/config/ViteConfig.java b/javite-webmvc-jre8/src/main/java/com/javite/spring/config/ViteConfig.java
index 3ab71a0..b703872 100644
--- a/javite-webmvc-jre8/src/main/java/com/javite/spring/config/ViteConfig.java
+++ b/javite-webmvc-jre8/src/main/java/com/javite/spring/config/ViteConfig.java
@@ -1,8 +1,8 @@
 package com.javite.spring.config;
 
-import com.javite.config.ViteProperties;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.ComponentScan;
 import org.springframework.context.annotation.Configuration;
 
 /**
@@ -31,6 +31,7 @@
  * @see com.javite.spring.annotation.EnableVite
  */
 @Configuration
+@ComponentScan(basePackages = "com.javite.spring.config")
 public class ViteConfig {
 
     @Value("${vite.debug:true}")
diff --git a/javite-webmvc-jre8/src/main/java/com/javite/spring/config/ViteProperties.java b/javite-webmvc-jre8/src/main/java/com/javite/spring/config/ViteProperties.java
new file mode 100644
index 0000000..f898fb1
--- /dev/null
+++ b/javite-webmvc-jre8/src/main/java/com/javite/spring/config/ViteProperties.java
@@ -0,0 +1,124 @@
+package com.javite.spring.config;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.stereotype.Component;
+
+/**
+ * Configuration properties for integrating Vite with Java web applications.
+ *
+ * <p>This class provides properties that can be used to configure the Vite integration,
+ * including settings for the Vite manifest file, local development server URL, resource paths, and debug mode.</p>
+ *
+ * <p>These properties can be configured in the application's configuration file (e.g., `application.properties`
+ * or `application.yml` for Spring applications) and are typically used by integration modules to facilitate the setup and use of Vite in Java web
+ * applications.</p>
+ *
+ * <p>Usage example:</p>
+ * <pre class="code">
+ * vite.debug=true
+ * vite.manifestPath=/WEB-INF/dist/.vite/manifest.json
+ * vite.localServerUrl=http://localhost:5173
+ * vite.resourcePath=/resources
+ * </pre>
+ */
+@Component
+@ConfigurationProperties(prefix = "vite")
+public class ViteProperties {
+
+    /**
+     * Whether to enable debug mode in Vite.
+     * <p>Default is {@code true}.</p>
+     */
+    private boolean debug = true;
+
+    /**
+     * The path of the manifest file generated by Vite.
+     * <p>Default is {@code /WEB-INF/dist/.vite/manifest.json}.</p>
+     */
+    private String manifestPath = "/WEB-INF/dist/.vite/manifest.json";
+
+    /**
+     * The local server URL for Vite development.
+     * <p>Default is {@code http://localhost:5173}.</p>
+     */
+    private String localServerUrl = "http://localhost:5173";
+
+    /**
+     * The path to the resources.
+     * <p>Default is {@code /resources}.</p>
+     */
+    private String resourcePath = "/resources";
+
+    /**
+     * Returns whether debug mode is enabled.
+     *
+     * @return {@code true} if debug mode is enabled, {@code false} otherwise
+     */
+    public boolean isDebug() {
+        return debug;
+    }
+
+    /**
+     * Sets whether debug mode is enabled.
+     *
+     * @param debug {@code true} to enable debug mode, {@code false} to disable it
+     */
+    public void setDebug(boolean debug) {
+        this.debug = debug;
+    }
+
+    /**
+     * Returns the path of the manifest file generated by Vite.
+     *
+     * @return the manifest file path
+     */
+    public String getManifestPath() {
+        return manifestPath;
+    }
+
+    /**
+     * Sets the path of the manifest file generated by Vite.
+     *
+     * @param manifestPath the manifest file path
+     */
+    public void setManifestPath(String manifestPath) {
+        this.manifestPath = manifestPath;
+    }
+
+    /**
+     * Returns the local server URL for Vite development.
+     *
+     * @return the local server URL
+     */
+    public String getLocalServerUrl() {
+        return localServerUrl;
+    }
+
+    /**
+     * Sets the local server URL for Vite development.
+     *
+     * @param localServerUrl the local server URL
+     */
+    public void setLocalServerUrl(String localServerUrl) {
+        this.localServerUrl = localServerUrl;
+    }
+
+    /**
+     * Returns the path to the resources.
+     *
+     * @return the resource path
+     */
+    public String getResourcePath() {
+        return resourcePath;
+    }
+
+    /**
+     * Sets the path to the resources.
+     *
+     * @param resourcePath the resource path
+     */
+    public void setResourcePath(String resourcePath) {
+        this.resourcePath = resourcePath;
+    }
+
+}
diff --git a/javite-webmvc-jre8/src/main/resources/META-INF/vite.tld b/javite-webmvc-jre8/src/main/resources/META-INF/vite.tld
index 96d6063..733f819 100644
--- a/javite-webmvc-jre8/src/main/resources/META-INF/vite.tld
+++ b/javite-webmvc-jre8/src/main/resources/META-INF/vite.tld
@@ -7,6 +7,10 @@
     <description>Vite JSP Tag Library</description>
     <short-name>vite</short-name>
     <tag>
+        <description>Import a Vite asset.</description>
+        <name>import</name>
+        <tag-class>com.javite.spring.tags.ViteImport</tag-class>
+        <body-content>empty</body-content>
         <attribute>
             <description>The entry point of the Vite asset to be imported.</description>
             <name>entry</name>
@@ -37,10 +41,6 @@
             <required>false</required>
             <rtexprvalue>true</rtexprvalue>
         </attribute>
-        <body-content>empty</body-content>
-        <description>Import a Vite asset.</description>
-        <name>import</name>
-        <tag-class>com.javite.spring.tags.ViteImport</tag-class>
     </tag>
     <tlib-version>1.0</tlib-version>
 
diff --git a/javite-webmvc/src/main/java/com/javite/spring/config/ViteConfig.java b/javite-webmvc/src/main/java/com/javite/spring/config/ViteConfig.java
index 8f301af..bcb033b 100644
--- a/javite-webmvc/src/main/java/com/javite/spring/config/ViteConfig.java
+++ b/javite-webmvc/src/main/java/com/javite/spring/config/ViteConfig.java
@@ -1,9 +1,10 @@
 package com.javite.spring.config;
 
+import com.javite.config.ViteProperties;
 import org.springframework.beans.factory.annotation.Value;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
-import com.javite.config.ViteProperties;
 
 /**
  * Configuration class for integrating Vite with Spring MVC applications.
@@ -12,6 +13,7 @@
  * {@code application.properties} file.</p>
  */
 @Configuration
+@EnableConfigurationProperties(ViteProperties.class)
 public class ViteConfig {
 
     @Value("${vite.debug:true}")
diff --git a/javite-webmvc/src/main/java/com/javite/spring/config/ViteProperties.java b/javite-webmvc/src/main/java/com/javite/spring/config/ViteProperties.java
new file mode 100644
index 0000000..f898fb1
--- /dev/null
+++ b/javite-webmvc/src/main/java/com/javite/spring/config/ViteProperties.java
@@ -0,0 +1,124 @@
+package com.javite.spring.config;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.stereotype.Component;
+
+/**
+ * Configuration properties for integrating Vite with Java web applications.
+ *
+ * <p>This class provides properties that can be used to configure the Vite integration,
+ * including settings for the Vite manifest file, local development server URL, resource paths, and debug mode.</p>
+ *
+ * <p>These properties can be configured in the application's configuration file (e.g., `application.properties`
+ * or `application.yml` for Spring applications) and are typically used by integration modules to facilitate the setup and use of Vite in Java web
+ * applications.</p>
+ *
+ * <p>Usage example:</p>
+ * <pre class="code">
+ * vite.debug=true
+ * vite.manifestPath=/WEB-INF/dist/.vite/manifest.json
+ * vite.localServerUrl=http://localhost:5173
+ * vite.resourcePath=/resources
+ * </pre>
+ */
+@Component
+@ConfigurationProperties(prefix = "vite")
+public class ViteProperties {
+
+    /**
+     * Whether to enable debug mode in Vite.
+     * <p>Default is {@code true}.</p>
+     */
+    private boolean debug = true;
+
+    /**
+     * The path of the manifest file generated by Vite.
+     * <p>Default is {@code /WEB-INF/dist/.vite/manifest.json}.</p>
+     */
+    private String manifestPath = "/WEB-INF/dist/.vite/manifest.json";
+
+    /**
+     * The local server URL for Vite development.
+     * <p>Default is {@code http://localhost:5173}.</p>
+     */
+    private String localServerUrl = "http://localhost:5173";
+
+    /**
+     * The path to the resources.
+     * <p>Default is {@code /resources}.</p>
+     */
+    private String resourcePath = "/resources";
+
+    /**
+     * Returns whether debug mode is enabled.
+     *
+     * @return {@code true} if debug mode is enabled, {@code false} otherwise
+     */
+    public boolean isDebug() {
+        return debug;
+    }
+
+    /**
+     * Sets whether debug mode is enabled.
+     *
+     * @param debug {@code true} to enable debug mode, {@code false} to disable it
+     */
+    public void setDebug(boolean debug) {
+        this.debug = debug;
+    }
+
+    /**
+     * Returns the path of the manifest file generated by Vite.
+     *
+     * @return the manifest file path
+     */
+    public String getManifestPath() {
+        return manifestPath;
+    }
+
+    /**
+     * Sets the path of the manifest file generated by Vite.
+     *
+     * @param manifestPath the manifest file path
+     */
+    public void setManifestPath(String manifestPath) {
+        this.manifestPath = manifestPath;
+    }
+
+    /**
+     * Returns the local server URL for Vite development.
+     *
+     * @return the local server URL
+     */
+    public String getLocalServerUrl() {
+        return localServerUrl;
+    }
+
+    /**
+     * Sets the local server URL for Vite development.
+     *
+     * @param localServerUrl the local server URL
+     */
+    public void setLocalServerUrl(String localServerUrl) {
+        this.localServerUrl = localServerUrl;
+    }
+
+    /**
+     * Returns the path to the resources.
+     *
+     * @return the resource path
+     */
+    public String getResourcePath() {
+        return resourcePath;
+    }
+
+    /**
+     * Sets the path to the resources.
+     *
+     * @param resourcePath the resource path
+     */
+    public void setResourcePath(String resourcePath) {
+        this.resourcePath = resourcePath;
+    }
+
+}
diff --git a/javite-webmvc/src/main/resources/META-INF/vite.tld b/javite-webmvc/src/main/resources/META-INF/vite.tld
index 941c56e..f134019 100644
--- a/javite-webmvc/src/main/resources/META-INF/vite.tld
+++ b/javite-webmvc/src/main/resources/META-INF/vite.tld
@@ -7,7 +7,7 @@
     <description>Vite JSP Tag Library</description>
     <tlib-version>1.0</tlib-version>
     <short-name>vite</short-name>
-    <uri>https://javite.com</uri>
+    <uri>https://javite.com/tags</uri>
 
     <tag>
         <description>Import a Vite asset.</description>