feat(mf2): Merge the unsupported-annotation sigil into its source in the data model (unicode-org/message-format-wg#655)

eemeli · eemeli · commit 067fe2f0e973 · 2024-02-17T14:36:40.000+02:00
diff --git a/packages/mf2-messageformat/src/data-model/from-cst.ts b/packages/mf2-messageformat/src/data-model/from-cst.ts
@@ -126,8 +126,7 @@ function asExpression(
         case 'reserved-annotation':
           annotation = {
             type: 'unsupported-annotation',
-            sigil: ca.open.value,
-            source: ca.source.value
+            source: ca.open.value + ca.source.value
           };
           break;
         default:
diff --git a/packages/mf2-messageformat/src/data-model/resolve-unsupported-annotation.ts b/packages/mf2-messageformat/src/data-model/resolve-unsupported-annotation.ts
@@ -7,8 +7,9 @@ import type { Literal, UnsupportedAnnotation, VariableRef } from './types.js';
 export function resolveUnsupportedAnnotation(
   ctx: Context,
   operand: Literal | VariableRef | undefined,
-  { sigil = '�' }: UnsupportedAnnotation
+  { source = '�' }: UnsupportedAnnotation
 ) {
+  const sigil = source[0];
   const msg = `Reserved ${sigil} annotation is not supported`;
   ctx.onError(new MessageResolutionError('unsupported-annotation', msg, sigil));
   return fallback(getValueSource(operand) ?? sigil);
diff --git a/packages/mf2-messageformat/src/data-model/stringify.ts b/packages/mf2-messageformat/src/data-model/stringify.ts
@@ -16,7 +16,6 @@ import type {
   Message,
   Option,
   Pattern,
-  UnsupportedAnnotation,
   VariableRef
 } from './types.js';
 
@@ -136,21 +135,14 @@ function stringifyExpression({ arg, annotation, attributes }: Expression) {
     res +=
       annotation.type === 'function'
         ? stringifyFunctionAnnotation(annotation)
-        : stringifyUnsupportedAnnotation(annotation);
+        : annotation.source ?? '�';
   }
   if (attributes) {
     for (const attr of attributes) res += ' ' + stringifyAttribute(attr);
   }
   return `{${res}}`;
 }
 
-function stringifyUnsupportedAnnotation({
-  sigil,
-  source = '�'
-}: UnsupportedAnnotation) {
-  return (sigil ?? '�') + source;
-}
-
 function stringifyVariableRef(ref: VariableRef) {
   return '$' + ref.name;
 }
diff --git a/packages/mf2-messageformat/src/data-model/types.ts b/packages/mf2-messageformat/src/data-model/types.ts
@@ -222,7 +222,6 @@ export interface FunctionAnnotation {
  */
 export interface UnsupportedAnnotation {
   type: 'unsupported-annotation';
-  sigil: '!' | '%' | '^' | '&' | '*' | '+' | '<' | '>' | '?' | '~' | '�';
   source: string;
   name?: never;
   options?: never;
diff --git a/packages/mf2-xliff/src/mf2xliff.ts b/packages/mf2-xliff/src/mf2xliff.ts
@@ -397,7 +397,6 @@ function resolveExpression({
       resFunc = {
         type: 'element',
         name: 'mf:unsupported',
-        attributes: { sigil: annotation.sigil ?? '�' },
         elements: [asText(annotation.source ?? '�')]
       };
     }
diff --git a/packages/mf2-xliff/src/xliff-spec.ts b/packages/mf2-xliff/src/xliff-spec.ts
@@ -1233,9 +1233,6 @@ export interface MessageOption extends Element {
 
 export interface MessageUnsupported extends Element {
   name: 'mf:unsupported';
-  attributes: {
-    sigil: '!' | '%' | '^' | '&' | '*' | '+' | '<' | '>' | '?' | '~' | '�';
-  };
   elements: (Text | CharCode)[];
 }
 
diff --git a/packages/mf2-xliff/src/xliff2mf.ts b/packages/mf2-xliff/src/xliff2mf.ts
@@ -337,7 +337,6 @@ function resolveExpression(elements: X.MessageElements): MF.Expression {
   } else {
     annotation = {
       type: 'unsupported-annotation',
-      sigil: xFunc.attributes.sigil ?? '�',
       source: resolveText(xFunc.elements)
     };
   }

Original file line number	Diff line number	Diff line change
`@@ -397,7 +397,6 @@ function resolveExpression({`
`397`	`397`	`resFunc = {`
`398`	`398`	`type: 'element',`
`399`	`399`	`name: 'mf:unsupported',`
`400`		`- attributes: { sigil: annotation.sigil ?? '�' },`
`401`	`400`	`elements: [asText(annotation.source ?? '�')]`
`402`	`401`	`};`
`403`	`402`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1233,9 +1233,6 @@ export interface MessageOption extends Element {`
`1233`	`1233`
`1234`	`1234`	`export interface MessageUnsupported extends Element {`
`1235`	`1235`	`name: 'mf:unsupported';`
`1236`		`- attributes: {`
`1237`		`- sigil: '!' \| '%' \| '^' \| '&' \| '*' \| '+' \| '<' \| '>' \| '?' \| '~' \| '�';`
`1238`		`- };`
`1239`	`1236`	`elements: (Text \| CharCode)[];`
`1240`	`1237`	`}`
`1241`	`1238`
Original file line number	Diff line number	Diff line change
`@@ -337,7 +337,6 @@ function resolveExpression(elements: X.MessageElements): MF.Expression {`
`337`	`337`	`} else {`
`338`	`338`	`annotation = {`
`339`	`339`	`type: 'unsupported-annotation',`
`340`		`- sigil: xFunc.attributes.sigil ?? '�',`
`341`	`340`	`source: resolveText(xFunc.elements)`
`342`	`341`	`};`
`343`	`342`	`}`