feat(@formatjs/cli): extract object-type description from message, fix formatjs#3373

longlho · longlho · commit d463673ac28a · 2022-01-20T00:28:59.000-05:00
diff --git a/packages/cli/src/formatters/crowdin.ts b/packages/cli/src/formatters/crowdin.ts
@@ -13,7 +13,10 @@ export const format: FormatFn<SmartlingJson> = msgs => {
   for (const [id, msg] of Object.entries(msgs)) {
     results[id] = {
       message: msg.defaultMessage!,
-      description: msg.description,
+      description:
+        typeof msg.description === 'string'
+          ? msg.description
+          : JSON.stringify(msg.description),
     }
   }
   return results
diff --git a/packages/cli/src/formatters/lokalise.ts b/packages/cli/src/formatters/lokalise.ts
@@ -15,7 +15,10 @@ export const format: FormatFn<StructuredJson> = msgs => {
   for (const [id, msg] of Object.entries(msgs)) {
     results[id] = {
       translation: msg.defaultMessage!,
-      notes: msg.description,
+      notes:
+        typeof msg.description === 'string'
+          ? msg.description
+          : JSON.stringify(msg.description),
     }
   }
   return results
diff --git a/packages/cli/src/formatters/smartling.ts b/packages/cli/src/formatters/smartling.ts
@@ -41,7 +41,10 @@ export const format: FormatFn<SmartlingJson> = msgs => {
   for (const [id, msg] of Object.entries(msgs)) {
     results[id] = {
       message: msg.defaultMessage!,
-      description: msg.description,
+      description:
+        typeof msg.description === 'string'
+          ? msg.description
+          : JSON.stringify(msg.description),
     }
   }
   return results
diff --git a/packages/cli/src/formatters/transifex.ts b/packages/cli/src/formatters/transifex.ts
@@ -15,7 +15,10 @@ export const format: FormatFn<StructuredJson> = msgs => {
   for (const [id, msg] of Object.entries(msgs)) {
     results[id] = {
       string: msg.defaultMessage!,
-      developer_comment: msg.description,
+      developer_comment:
+        typeof msg.description === 'string'
+          ? msg.description
+          : JSON.stringify(msg.description),
     }
   }
   return results

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,10 @@ export const format: FormatFn<SmartlingJson> = msgs => {`
`13`	`13`	`for (const [id, msg] of Object.entries(msgs)) {`
`14`	`14`	`results[id] = {`
`15`	`15`	`message: msg.defaultMessage!,`
`16`		`- description: msg.description,`
	`16`	`+ description:`
	`17`	`+ typeof msg.description === 'string'`
	`18`	`+ ? msg.description`
	`19`	`+ : JSON.stringify(msg.description),`
`17`	`20`	`}`
`18`	`21`	`}`
`19`	`22`	`return results`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,10 @@ export const format: FormatFn<StructuredJson> = msgs => {`
`15`	`15`	`for (const [id, msg] of Object.entries(msgs)) {`
`16`	`16`	`results[id] = {`
`17`	`17`	`translation: msg.defaultMessage!,`
`18`		`- notes: msg.description,`
	`18`	`+ notes:`
	`19`	`+ typeof msg.description === 'string'`
	`20`	`+ ? msg.description`
	`21`	`+ : JSON.stringify(msg.description),`
`19`	`22`	`}`
`20`	`23`	`}`
`21`	`24`	`return results`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,10 @@ export const format: FormatFn<SmartlingJson> = msgs => {`
`41`	`41`	`for (const [id, msg] of Object.entries(msgs)) {`
`42`	`42`	`results[id] = {`
`43`	`43`	`message: msg.defaultMessage!,`
`44`		`- description: msg.description,`
	`44`	`+ description:`
	`45`	`+ typeof msg.description === 'string'`
	`46`	`+ ? msg.description`
	`47`	`+ : JSON.stringify(msg.description),`
`45`	`48`	`}`
`46`	`49`	`}`
`47`	`50`	`return results`