fix(ipa): exception reason formatting

Author: yelizhenden-mdb

tools/spectral/ipa/__tests__/IPA005ExceptionExtensionFormat.test.js

@@ -46,12 +46,27 @@ testRule('xgen-IPA-005-exception-extension-format', [
             'xgen-IPA-100-rule-name': {},
           },
         },
+        '/path5': {
+          'x-xgen-IPA-exception': {
+            'xgen-IPA-1001-rule-name': {},
+          },
+        },
+        '/path6': {
+          'x-xgen-IPA-exception': {
+            'xgen-IPA-1001-rule_name': {},
+          },
+        },
+        '/path7': {
+          'x-xgen-IPA-exception': {
+            'xgen-IPA_100_rule-name': {},
+          },
+        },
       },
     },
     errors: [
       {
         code: 'xgen-IPA-005-exception-extension-format',
-        message: 'IPA exceptions must have a valid key with xgen-IPA- prefix.',
+        message: 'IPA exceptions must have a valid key following xgen-IPA-XXX-{rule-name} format.',
         path: ['paths', '/path1', 'x-xgen-IPA-exception'],
         severity: DiagnosticSeverity.Error,
       },
@@ -63,7 +78,7 @@ testRule('xgen-IPA-005-exception-extension-format', [
       },
       {
         code: 'xgen-IPA-005-exception-extension-format',
-        message: 'IPA exceptions must have a valid key with xgen-IPA- prefix.',
+        message: 'IPA exceptions must have a valid key following xgen-IPA-XXX-{rule-name} format.',
         path: ['paths', '/path3', 'x-xgen-IPA-exception'],
         severity: DiagnosticSeverity.Error,
       },
@@ -73,6 +88,24 @@ testRule('xgen-IPA-005-exception-extension-format', [
         path: ['paths', '/path4', 'x-xgen-IPA-exception'],
         severity: DiagnosticSeverity.Error,
       },
+      {
+        code: 'xgen-IPA-005-exception-extension-format',
+        message: 'IPA exceptions must have a valid key following xgen-IPA-XXX-{rule-name} format.',
+        path: ['paths', '/path5', 'x-xgen-IPA-exception'],
+        severity: DiagnosticSeverity.Error,
+      },
+      {
+        code: 'xgen-IPA-005-exception-extension-format',
+        message: 'IPA exceptions must have a valid key following xgen-IPA-XXX-{rule-name} format.',
+        path: ['paths', '/path6', 'x-xgen-IPA-exception'],
+        severity: DiagnosticSeverity.Error,
+      },
+      {
+        code: 'xgen-IPA-005-exception-extension-format',
+        message: 'IPA exceptions must have a valid key following xgen-IPA-XXX-{rule-name} format.',
+        path: ['paths', '/path7', 'x-xgen-IPA-exception'],
+        severity: DiagnosticSeverity.Error,
+      },
     ],
   },
 ]);

tools/spectral/ipa/rulesets/functions/IPA005ExceptionExtensionFormat.js

@@ -1,11 +1,9 @@
-import {
-  evaluateAndCollectAdoptionStatusWithoutExceptions,
-  handleInternalError,
-} from './utils/collectionUtils.js';
+import { evaluateAndCollectAdoptionStatusWithoutExceptions, handleInternalError } from './utils/collectionUtils.js';
 
-const ERROR_MESSAGE_RULENAME_FORMAT = 'IPA exceptions must have a valid key with xgen-IPA- prefix.';
-const ERROR_MESSAGE_REASON_FORMAT = 'IPA exceptions must have a non-empty reason that starts with uppercase and ends with a full stop.';
-const RULE_NAME_PREFIX = 'xgen-IPA-';
+const ERROR_MESSAGE_RULENAME_FORMAT = 'IPA exceptions must have a valid key following xgen-IPA-XXX-{rule-name} format.';
+const ERROR_MESSAGE_REASON_FORMAT =
+  'IPA exceptions must have a non-empty reason that starts with uppercase and ends with a full stop.';
+const RULE_NAME_PATTERN = /^xgen-IPA-\d{3}-[a-z-]+$/;
 
 // Note: This rule does not allow exceptions
 export default (input, _, { path, rule }) => {
@@ -15,7 +13,7 @@ export default (input, _, { path, rule }) => {
 };
 
 function isRuleNameValid(ruleName) {
-  return ruleName.startsWith(RULE_NAME_PREFIX);
+  return RULE_NAME_PATTERN.test(ruleName);
 }
 
 function isReasonFormatValid(reason) {