support comment and context extraction

Author: timofei-iatsenko

Cargo.lock

@@ -27,7 +27,7 @@
     "id": "Nu4oKW",
     "message": "Description",
     "context": null,
-    "comment": null,
+    "comment": "description",
     "placeholders": {},
     "origin": {
       "filename": "js-with-macros.js",
@@ -88,7 +88,7 @@
   {
     "id": "Some ID",
     "message": null,
-    "context": null,
+    "context": "Context1",
     "comment": null,
     "placeholders": {},
     "origin": {
@@ -100,7 +100,7 @@
   {
     "id": "Some other ID",
     "message": null,
-    "context": null,
+    "context": "Context1",
     "comment": null,
     "placeholders": {},
     "origin": {
@@ -112,7 +112,7 @@
   {
     "id": "Some ID",
     "message": null,
-    "context": null,
+    "context": "Context2",
     "comment": null,
     "placeholders": {},
     "origin": {
@@ -124,7 +124,7 @@
   {
     "id": "Some ID",
     "message": null,
-    "context": null,
+    "context": "Context2",
     "comment": null,
     "placeholders": {},
     "origin": {
@@ -170,5 +170,17 @@
       "line": 57,
       "column": 14
     }
+  },
+  {
+    "id": "AZczQP",
+    "message": "Some ID",
+    "context": "Context2",
+    "comment": "This is a comment for a message",
+    "placeholders": {},
+    "origin": {
+      "filename": "js-with-macros.js",
+      "line": 65,
+      "column": 36
+    }
   }
 ]

crates/lingui_extractor/tests/__snapshots__/js-with-macros.js.json

@@ -9,8 +9,8 @@
     },
     "origin": {
       "filename": "jsx-with-macros.js",
-      "line": 3,
-      "column": 9
+      "line": 4,
+      "column": 8
     }
   },
   {
@@ -21,7 +21,7 @@
     "placeholders": {},
     "origin": {
       "filename": "jsx-with-macros.js",
-      "line": 4,
+      "line": 5,
       "column": 28
     }
   },
@@ -33,7 +33,7 @@
     "placeholders": {},
     "origin": {
       "filename": "jsx-with-macros.js",
-      "line": 5,
+      "line": 6,
       "column": 28
     }
   },
@@ -45,7 +45,7 @@
     "placeholders": {},
     "origin": {
       "filename": "jsx-with-macros.js",
-      "line": 6,
+      "line": 7,
       "column": 28
     }
   },
@@ -57,7 +57,7 @@
     "placeholders": {},
     "origin": {
       "filename": "jsx-with-macros.js",
-      "line": 7,
+      "line": 8,
       "column": 16
     }
   },
@@ -71,8 +71,20 @@
     },
     "origin": {
       "filename": "jsx-with-macros.js",
-      "line": 9,
+      "line": 10,
       "column": 17
     }
+  },
+  {
+    "id": "TFdOtc",
+    "message": "Some message with comment",
+    "context": null,
+    "comment": "This is comment",
+    "placeholders": {},
+    "origin": {
+      "filename": "jsx-with-macros.js",
+      "line": 15,
+      "column": 35
+    }
   }
 ]

crates/lingui_extractor/tests/__snapshots__/jsx-with-macros.js.json

@@ -14,7 +14,7 @@
     }
   },
   {
-    "id": "8qNz+K",
+    "id": "8qNz-K",
     "message": "{count, plural, one {# book} other {# books}}",
     "context": "Some context",
     "comment": null,

crates/lingui_extractor/tests/__snapshots__/jsx-without-trans.js.json

@@ -1,5 +1,5 @@
-import { t, defineMessage, msg, plural } from "@lingui/core/macro"
-import { useLingui } from "@lingui/react/macro"
+import {t, defineMessage, msg, plural} from "@lingui/core/macro"
+import {useLingui} from "@lingui/react/macro"
 
 t`Message`
 
@@ -49,7 +49,7 @@ const defineMessageAlias = msg({
 const defineMessageAlias2 = msg`TplLiteral`
 
 function MyComponent() {
-  const { t } = useLingui()
+  const {t} = useLingui()
 
   t`[useLingui]: TplLiteral`
 
@@ -61,3 +61,9 @@ function MyComponent() {
     other: "# books",
   })}`
 }
+
+const defineMessageWithAllFields = msg({
+  message: "Some ID",
+  context: "Context2",
+  comment: "This is a comment for a message"
+})

crates/lingui_extractor/tests/fixtures/js-with-macros.js

@@ -1,13 +1,16 @@
-import { Trans } from "@lingui/react/macro"
-import { t, plural } from "@lingui/core/macro"
-;<Trans>Hi, my name is {name}</Trans>
+import {Trans} from "@lingui/react/macro";
+import {t, plural} from "@lingui/core/macro";
+
+<Trans>Hi, my name is {name}</Trans>
 ;<Trans context="Context1">Some message</Trans>
 ;<Trans context="Context1">Some other message</Trans>
 ;<Trans context="Context2">Some message</Trans>
-;<span title={t`Title`} />
+;<span title={t`Title`}/>
 ;<span
   title={plural(count, {
     one: "# book",
     other: "# books",
   })}
 />
+;<Trans comment="This is comment">Some message with comment</Trans>
+

crates/lingui_extractor/tests/fixtures/jsx-with-macros.js

@@ -3,7 +3,7 @@ use lingui_extractor::{extract_messages, ExtractorOptions};
 
 fn extract_and_sort(source_code: &str, filename: &str) -> (Vec<ExtractedMessage>, Vec<String>) {
     let options = ExtractorOptions {
-        syntax: Syntax::Typescript(TsSyntax {
+        parser: Syntax::Typescript(TsSyntax {
             tsx: true,
 
             ..Default::default()

crates/lingui_extractor/tests/message_extractor.rs

@@ -122,7 +122,7 @@ where
                         "id",
                         generate_message_id(
                             &parsed.message_str,
-                            &(context_val.unwrap_or_default()),
+                            context_val.as_deref().unwrap_or_default(),
                         )
                         .into(),
                     ))
@@ -137,6 +137,19 @@ where
                 }
             }
 
+            if !self.ctx.options.strip_non_essential_fields {
+                if let Some(context) = context_val {
+                    new_props.push(create_key_value_prop("context", context.into()));
+                }
+
+                let comment = get_object_prop(&obj.props, "comment")
+                    .and_then(|prop| get_expr_as_string(&prop.value));
+
+                if let Some(comment) = comment {
+                    new_props.push(create_key_value_prop("comment", comment.into()));
+                }
+            }
+
             let message_descriptor = Box::new(Expr::Object(ObjectLit {
                 span,
                 props: new_props,

crates/lingui_macro/src/js_macro_folder.rs

@@ -117,6 +117,7 @@ where
 
         let parsed = MessageBuilder::parse(trans_visitor.tokens);
         let id_attr = get_jsx_attr(&el.opening, "id").and_then(|attr| attr.value.as_ref());
+
         let context_attr =
             get_jsx_attr(&el.opening, "context").and_then(|attr| attr.value.as_ref());
 
@@ -148,6 +149,14 @@ where
         }
 
         if !self.ctx.options.strip_non_essential_fields {
+            let comment_attr = get_jsx_attr(&el.opening, "comment")
+                .and_then(|attr| attr.value.as_ref())
+                .and_then(get_jsx_attr_value_as_string);
+
+            if let Some(comment) = comment_attr {
+                message_descriptor_props.push(create_key_value_prop("comment", comment.into()));
+            }
+
             message_descriptor_props.push(create_key_value_prop("message", parsed.message));
 
             if let Some(context_attr) = context_attr {

crates/lingui_macro/src/lib.rs

@@ -3,5 +3,6 @@ const message = /*i18n*/ {
     message: "{count, plural, one {book} other {books}}",
     values: {
         count: count
-    }
+    },
+    comment: "Description"
 };