100 custom code snippet (#102)

* Impl custom code snippet
* Update javadoc
* Update ts dependencies

Author: cuzfrog

annotation/src/main/java/online/sharedtype/SharedType.java

@@ -26,10 +26,10 @@
  * <p>
  * <b>Configurations:</b><br>
  * Global properties can be defined in a client provided property file or system properties.
- * By default, SharedType will look for file name "sharedtype.properties" on cmd current path.
+ * By default, SharedType will look for file name "sharedtype.properties" on cmd path.
  * The property file path can be changed via compiler option "sharedtype.propsFile", see web for details.
  * System properties will override property file values.
- * Configs on class level (via this annotation) will take precedence over global properties.
+ * Some properties are also defined at class level, i.e. via this annotation, which will take precedence over global properties.
  * </p>
  *
  * <p>
@@ -121,6 +121,14 @@
  * Type mapped this way will take the highest precedence.
  * E.g. a date type is configured to be emitted as string, you can override the particular mapping to emit a {@code Date}.
  * Type mapping will override name configured in {@link SharedType#name()}.
+ * </p><br>
+ *
+ * <p>
+ * <b>Custom code snippet:</b><br>
+ * Clients can provide custom code snippets to be injected into the emitted file.
+ * This can be useful when e.g. a 3rd party type is referenced at client code.
+ * By default, SharedType will search files "sharedtype-custom-code.ts", "sharedtype-custom-code.rs" respectively on cmd path.
+ * File paths can be configured via global properties.
  * </p>
  *
  * <br>

client-test/rust/src/lib.rs

@@ -1,5 +1,9 @@
 mod types;
 
+pub static CUSTOM_CODE_TYPE: types::CustomInjectedStruct = types::CustomInjectedStruct {
+    field: 33,
+};
+
 #[cfg(test)]
 mod tests {
     use std::collections::HashMap;

client-test/typescript/package-lock.json

@@ -12,6 +12,6 @@
   "description": "typescript-client-test",
   "devDependencies": {
     "typescript": "5.6.3",
-    "vitest": "3.0.9"
+    "vitest": "3.1.1"
   }
 }

client-test/typescript/package.json

@@ -1,4 +1,4 @@
-import type { JavaClass } from "./index.java8.js";
+import type { CustomCode, JavaClass } from "./index.java8.js";
 
 export const javaClass: JavaClass = {
   string: "",
@@ -7,3 +7,6 @@ export const javaClass: JavaClass = {
   a: 0,
   value: 0
 };
+
+export const customCodeType: CustomCode = {
+}

client-test/typescript/src/types.java8.ts

@@ -79,6 +79,16 @@ You can customize the path by config `maven-compiler-plugin`:
 </compilerArgs>
 ```
 
+Properties can also be passed in as system properties, which will override the properties files, e.g.
+```bash
+./mvnw clean compile -Dsharedtype.typescript.custom-code-path=it/custom-code.ts
+```
+or
+```bash
+MAVEN_OPTS="-Dsharedtype.typescript.custom-code-path=it/custom-code.ts" ./mvnw clean compile
+```
+or can use [properties-maven-plugin](https://www.mojohaus.org/properties-maven-plugin/usage.html#set-system-properties) to set system properties for the build.
+
 See [Default Properties](../processor/src/main/resources/sharedtype-default.properties) for details.
 
 #### Per annotation options

doc/Usage.md

@@ -0,0 +1,4 @@
+// test code snippet
+pub struct CustomInjectedStruct {
+    pub field: i32,
+}

it/custom-code.rs

@@ -0,0 +1,3 @@
+// test code snippet
+export interface CustomCode {
+}

it/custom-code.ts

@@ -106,6 +106,30 @@
                     <includes>${compileClasses}</includes>
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>properties-maven-plugin</artifactId>
+                <version>1.2.1</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>set-system-properties</goal>
+                        </goals>
+                        <configuration>
+                            <properties>
+                                <property>
+                                    <name>sharedtype.typescript.custom-code-path</name>
+                                    <value>it/custom-code.ts</value>
+                                </property>
+                                <property>
+                                    <name>sharedtype.rust.custom-code-path</name>
+                                    <value>it/custom-code.rs</value>
+                                </property>
+                            </properties>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
     <profiles>

it/pom.xml

@@ -41,6 +41,7 @@ public static final class Typescript {
         private final EnumFormat enumFormat;
         private final FieldReadonlyType fieldReadonlyType;
         private final Map<String, String> typeMappings;
+        private final String customCodePath;
 
         @Getter
         public enum OptionalFieldFormat {
@@ -88,5 +89,6 @@ public static final class Rust {
         private final Set<String> defaultTypeMacros;
         private final String targetDatetimeTypeLiteral;
         private final Map<String, String> typeMappings;
+        private final String customCodePath;
     }
 }