Introduce error codes core

Author: Yauhenikapl

core/esmf-aspect-model-validator/src/main/java/org/eclipse/esmf/aspectmodel/validation/services/DetailedViolationFormatter.java

@@ -141,6 +141,9 @@ private String formatViolation( final Violation violation, final Supplier<String
             builder.append( String.format( "  - %s%n", fix.description() ) );
          }
       }
+      // Add documentation link
+      builder.append( " documentation: https://eclipse-esmf.github.io/esmf-developer-guide/tooling-guide/error-codes.html"
+            + violation.errorCode().toLowerCase().replace( "_", "-" ) );
       builder.append( indent( additionalAttributesSupplier.get(), 2 ) );
       if ( violation.context() != null ) {
          builder.append( String.format( "  caused-by-shape:%n" ) );

core/esmf-aspect-model-validator/src/main/java/org/eclipse/esmf/aspectmodel/validation/services/ViolationFormatter.java

@@ -84,11 +84,17 @@ public String apply( final List<Violation> violations ) {
          final List<Violation> elementViolations = entry.getValue();
          builder.append( String.format( "> %s :%n", textFormatter.formatName( elementName ) ) );
          for ( final Violation violation : elementViolations ) {
+            // Include error code in the violation message
+            final String errorCode = violation.errorCode();
+            final String enhancedMessage = String.format( "[%s] %s", errorCode, violation.message() );
             builder.append( indent( violation.accept( this ), 2 ) ).append( System.lineSeparator() );
             for ( final Fix possibleFix : violation.fixes() ) {
                builder.append( "  > Possible fix: " )
                      .append( possibleFix.description() );
             }
+            // Add documentation link
+            builder.append( String.format( "  > For more information, see: https://eclipse-esmf.github.io/esmf-sdk/tooling-guide/error-codes.html#%s%n", 
+                  errorCode.toLowerCase().replace( "_", "-" ) ) );
             builder.append( System.lineSeparator() );
          }
          builder.append( System.lineSeparator() );
@@ -98,10 +104,20 @@ public String apply( final List<Violation> violations ) {
          if ( violation instanceof final ProcessingViolation processingViolation ) {
             builder.append( processingViolation.accept( this ) );
          } else if ( violation.violationSpecificMessage() == null || violation.violationSpecificMessage().equals( violation.message() ) ) {
-            builder.append( String.format( "> %s%n", violation.message() ) );
+            final String errorCode = violation.errorCode();
+            final String enhancedMessage = String.format( "[%s] %s", errorCode, violation.message() );
+            builder.append( String.format( "> %s%n", enhancedMessage ) );
+            // Add documentation link for context-free violations
+            builder.append( "  > For more information, see: documentation: https://eclipse-esmf.github.io/esmf-developer-guide/tooling-guide/error-codes.html"
+                  + errorCode.toLowerCase().replace( "_", "-" ) );
          } else {
-            builder.append( String.format( "> %s: %n", violation.message() ) );
+            final String errorCode = violation.errorCode();
+            final String enhancedMessage = String.format( "[%s] %s", errorCode, violation.message() );
+            builder.append( String.format( "> %s: %n", enhancedMessage ) );
             builder.append( indent( violation.accept( this ), 2 ) ).append( System.lineSeparator() );
+            // Add documentation link
+            builder.append( "  > For more information, see: documentation: https://eclipse-esmf.github.io/esmf-developer-guide/tooling-guide/error-codes.html"
+                  + errorCode.toLowerCase().replace( "_", "-" ) );
          }
          builder.append( System.lineSeparator() );
       }
@@ -111,7 +127,9 @@ public String apply( final List<Violation> violations ) {
 
    @Override
    public String visit( final Violation violation ) {
-      return formatter.constructDetailedMessage( violation.highlight(), violation.message(), violation.context().element().getModel() );
+      final String errorCode = violation.errorCode();
+      final String enhancedMessage = String.format( "[%s] %s", errorCode, violation.message() );
+      return formatter.constructDetailedMessage( violation.highlight(), enhancedMessage, violation.context().element().getModel() );
    }
 
    @Override

documentation/developer-guide/modules/tooling-guide/nav.adoc

@@ -1,4 +1,5 @@
 * xref:samm-cli.adoc[SAMM CLI]
 * xref:java-aspect-tooling.adoc[Java APIs for Aspect Models]
 * xref:maven-plugin.adoc[Maven Plugin]
+* xref:error-codes.adoc[Error Codes and Validation Results]
 * xref:bamm-migration.adoc[Migration from BAMM]