Generate locale PO files with extracted comments (#12757)

willdurand · web-flow · commit 79fc95e3d315 · 2024-01-09T17:54:07.000+01:00
diff --git a/locale/templates/LC_MESSAGES/amo.pot b/locale/templates/LC_MESSAGES/amo.pot
diff --git a/package.json b/package.json
@@ -264,7 +264,7 @@
     "@testing-library/react": "^14.1.2",
     "@testing-library/user-event": "^14.5.2",
     "autoprefixer": "^10.4.16",
-    "babel-gettext-extractor": "^4.1.3",
+    "babel-gettext-extractor": "https://github.com/willdurand/babel-gettext-extractor#5.1.0",
     "babel-loader": "^9.1.3",
     "babel-plugin-dynamic-import-node": "^2.2.0",
     "bundlewatch": "^0.3.3",
diff --git a/src/amo/components/AddAddonToCollection/index.js b/src/amo/components/AddAddonToCollection/index.js
@@ -265,7 +265,7 @@ export class AddAddonToCollectionBase extends React.Component<InternalProps> {
       });
     }
 
-    // translators: This is a header for a list meaning Add to [some collection name]
+    // L10n: This is a header for a list meaning Add to [some collection name]
     const collectionOptLabel = i18n.gettext('Add to…');
 
     return (
diff --git a/src/amo/components/AddonAdminLinks/index.js b/src/amo/components/AddonAdminLinks/index.js
@@ -72,7 +72,7 @@ export class AddonAdminLinksBase extends React.Component<InternalProps> {
         >
           {
             // eslint-disable-next-line max-len
-            // translators: This action allows the add-on developer or an admin to edit an add-on's properties.
+            // L10n: This action allows the add-on developer or an admin to edit an add-on's properties.
             i18n.gettext('Edit add-on')
           }
         </a>
@@ -86,7 +86,7 @@ export class AddonAdminLinksBase extends React.Component<InternalProps> {
           href={`/admin/models/addons/addon/${addon.id}`}
         >
           {
-            // translators: This action allows an admin to maintain an add-on.
+            // L10n: This action allows an admin to maintain an add-on.
             i18n.gettext('Admin add-on')
           }
         </a>
@@ -100,17 +100,17 @@ export class AddonAdminLinksBase extends React.Component<InternalProps> {
           href={`/reviewers/review-content/${addon.id}`}
         >
           {
-            // translators: This action allows a reviewer to perform a content review of an add-on.
+            // L10n: This action allows a reviewer to perform a content review of an add-on.
             i18n.gettext('Content review add-on')
           }
         </a>
       </li>
     ) : null;
 
     const codeReviewLinkText = isTheme
-      ? // translators: This action allows a reviewer to perform a review of a theme.
+      ? // L10n: This action allows a reviewer to perform a review of a theme.
         i18n.gettext('Review theme')
-      : // translators: This action allows a reviewer to perform a review of an add-on's code.
+      : // L10n: This action allows a reviewer to perform a review of an add-on's code.
         i18n.gettext('Review add-on code');
     const codeReviewLink =
       showCodeReviewLink || showStaticThemeReviewLink ? (
@@ -130,7 +130,7 @@ export class AddonAdminLinksBase extends React.Component<InternalProps> {
       <DefinitionList className="AddonAdminLinks">
         <Definition
           term={
-            // translators: This is a list of links to administrative functions.
+            // L10n: This is a list of links to administrative functions.
             i18n.gettext('Admin Links')
           }
         >
diff --git a/src/amo/components/AddonAuthorLinks/index.js b/src/amo/components/AddonAuthorLinks/index.js
@@ -47,7 +47,7 @@ export class AddonAuthorLinksBase extends React.Component<InternalProps> {
         >
           {
             // eslint-disable-next-line max-len
-            // translators: This action allows the add-on developer to edit an add-on's properties.
+            // L10n: This action allows the add-on developer to edit an add-on's properties.
             i18n.gettext('Edit add-on')
           }
         </a>
@@ -58,7 +58,7 @@ export class AddonAuthorLinksBase extends React.Component<InternalProps> {
       <DefinitionList className="AddonAuthorLinks">
         <Definition
           term={
-            // translators: This is a list of links to Developer functions.
+            // L10n: This is a list of links to Developer functions.
             i18n.gettext('Author Links')
           }
         >
diff --git a/src/amo/components/AddonHead/index.js b/src/amo/components/AddonHead/index.js
@@ -65,55 +65,55 @@ export class AddonHeadBase extends React.Component<InternalProps> {
     if (clientApp === CLIENT_APP_ANDROID) {
       switch (addon.type) {
         case ADDON_TYPE_DICT:
-          // translators: please keep the fox emoji next to "Firefox Android".
+          // L10n: please keep the fox emoji next to "Firefox Android".
           localizedTitle = i18n.gettext(`%(addonName)s – Get this Dictionary
             for 🦊 Firefox Android (%(locale)s)`);
           break;
         case ADDON_TYPE_EXTENSION:
-          // translators: please keep the fox emoji next to "Firefox Android".
+          // L10n: please keep the fox emoji next to "Firefox Android".
           localizedTitle = i18n.gettext(`%(addonName)s – Get this Extension for
             🦊 Firefox Android (%(locale)s)`);
           break;
         case ADDON_TYPE_LANG:
-          // translators: please keep the fox emoji next to "Firefox Android".
+          // L10n: please keep the fox emoji next to "Firefox Android".
           localizedTitle = i18n.gettext(`%(addonName)s – Get this Language Pack
             for 🦊 Firefox Android (%(locale)s)`);
           break;
         case ADDON_TYPE_STATIC_THEME:
-          // translators: please keep the fox emoji next to "Firefox Android".
+          // L10n: please keep the fox emoji next to "Firefox Android".
           localizedTitle = i18n.gettext(
             `%(addonName)s – Get this Theme for 🦊 Firefox Android (%(locale)s)`,
           );
           break;
         default:
-          // translators: please keep the fox emoji next to "Firefox Android".
+          // L10n: please keep the fox emoji next to "Firefox Android".
           localizedTitle = i18n.gettext(`%(addonName)s – Get this Add-on for 🦊
             Firefox Android (%(locale)s)`);
       }
     } else {
       switch (addon.type) {
         case ADDON_TYPE_DICT:
-          // translators: please keep the fox emoji next to "Firefox".
+          // L10n: please keep the fox emoji next to "Firefox".
           localizedTitle = i18n.gettext(`%(addonName)s – Get this Dictionary
             for 🦊 Firefox (%(locale)s)`);
           break;
         case ADDON_TYPE_EXTENSION:
-          // translators: please keep the fox emoji next to "Firefox".
+          // L10n: please keep the fox emoji next to "Firefox".
           localizedTitle = i18n.gettext(`%(addonName)s – Get this Extension for
             🦊 Firefox (%(locale)s)`);
           break;
         case ADDON_TYPE_LANG:
-          // translators: please keep the fox emoji next to "Firefox".
+          // L10n: please keep the fox emoji next to "Firefox".
           localizedTitle = i18n.gettext(`%(addonName)s – Get this Language Pack
             for 🦊 Firefox (%(locale)s)`);
           break;
         case ADDON_TYPE_STATIC_THEME:
-          // translators: please keep the fox emoji next to "Firefox".
+          // L10n: please keep the fox emoji next to "Firefox".
           localizedTitle = i18n.gettext(`%(addonName)s – Get this Theme for 🦊
             Firefox (%(locale)s)`);
           break;
         default:
-          // translators: please keep the fox emoji next to "Firefox".
+          // L10n: please keep the fox emoji next to "Firefox".
           localizedTitle = i18n.gettext(`%(addonName)s – Get this Add-on for 🦊
             Firefox (%(locale)s)`);
       }
diff --git a/src/amo/components/AddonMoreInfo/index.js b/src/amo/components/AddonMoreInfo/index.js
@@ -211,8 +211,7 @@ export class AddonMoreInfoBase extends React.Component<InternalProps> {
       filesize: versionInfo && versionInfo.filesize,
       versionLastUpdated: lastUpdated
         ? i18n.sprintf(
-            // translators: This will output, in English:
-            // "2 months ago (Dec 12 2016)"
+            // L10n: This will output, in English: "2 months ago (Dec 12 2016)"
             i18n.gettext('%(timeFromNow)s (%(date)s)'),
             {
               timeFromNow: i18n.moment(lastUpdated).fromNow(),
diff --git a/src/amo/components/AddonReviewCard/index.js b/src/amo/components/AddonReviewCard/index.js
@@ -364,14 +364,15 @@ export class AddonReviewCardBase extends React.Component<InternalProps> {
     if (review) {
       // eslint-disable-next-line no-nested-ternary
       const byLineString = noAuthor
-        ? // translators: Example in English: "posted last week"
+        ? // L10n: Example in English: "posted last week"
           i18n.gettext('posted %(linkStart)s%(timestamp)s%(linkEnd)s')
-        : // translators: Example in English: "by UserName123, last week"
-        showUserProfileLink
-        ? i18n.gettext(
+        : showUserProfileLink
+        ? // L10n: Example in English: "by UserName123, last week"
+          i18n.gettext(
             'by %(linkUserProfileStart)s%(authorName)s%(linkUserProfileEnd)s, %(linkStart)s%(timestamp)s%(linkEnd)s',
           )
-        : i18n.gettext(
+        : // L10n: Example in English: "by UserName123, last week"
+          i18n.gettext(
             'by %(authorName)s, %(linkStart)s%(timestamp)s%(linkEnd)s',
           );
 
diff --git a/src/amo/components/AddonSummaryCard/index.js b/src/amo/components/AddonSummaryCard/index.js
@@ -74,7 +74,7 @@ export const AddonSummaryCardBase = ({
     const roundedAverage = roundToOneDigit(addon.ratings.average);
     addonAverage = i18n.sprintf(
       // eslint-disable-next-line max-len
-      // translators: roundedAverage is a number rounded to one digit, such as 4.5 in English or ٤٫٧ in Arabic.
+      // L10n: roundedAverage is a number rounded to one digit, such as 4.5 in English or ٤٫٧ in Arabic.
       i18n.ngettext(
         '%(rating)s Star out of 5',
         '%(rating)s Stars out of 5',
diff --git a/src/amo/components/AddonTitle/index.js b/src/amo/components/AddonTitle/index.js
@@ -45,7 +45,7 @@ export const AddonTitleBase = ({
   if (addon && addon.authors) {
     const addonAuthors = addon.authors;
 
-    // translators: A comma, used in a list of authors: a1, a2, a3.
+    // L10n: A comma, used in a list of authors: a1, a2, a3.
     const comma = i18n.gettext(',');
     const separator = isRTL ? ` ${comma}` : `${comma} `;
 
@@ -89,7 +89,7 @@ export const AddonTitleBase = ({
                 <>
                   {authors}{' '}
                   {
-                    // translators: Example: add-on "by" some authors
+                    // L10n: Example: add-on "by" some authors
                     i18n.gettext('by')
                   }
                 </>
diff --git a/src/amo/components/Header/index.js b/src/amo/components/Header/index.js
@@ -182,7 +182,7 @@ export class HeaderBase extends React.Component {
       >
         <span className="visually-hidden">
           {
-            // translators: "Firefox" should not be translated. :-)
+            // L10n: "Firefox" should not be translated. :-)
             i18n.gettext('Firefox Browser Add-ons')
           }
         </span>
diff --git a/src/amo/components/HeroRecommendation/index.js b/src/amo/components/HeroRecommendation/index.js
@@ -216,8 +216,7 @@ export class HeroRecommendationBase extends React.Component<InternalProps> {
     }
 
     const renderHeroTitle = () => {
-      // translators: If uppercase does not work in your locale,
-      // change it to lowercase. This is used as a secondary heading.
+      // L10n: If uppercase does not work in your locale, change it to lowercase. This is used as a secondary heading.
       let titleText = null;
 
       const promotedCategory = _getPromotedCategory({
@@ -228,12 +227,10 @@ export class HeroRecommendationBase extends React.Component<InternalProps> {
 
       if (!loading) {
         if (promotedCategory === RECOMMENDED) {
-          // translators: If uppercase does not work in your locale,
-          // change it to lowercase. This is used as a secondary heading.
+          // L10n: If uppercase does not work in your locale, change it to lowercase. This is used as a secondary heading.
           titleText = i18n.gettext('RECOMMENDED');
         } else if (promotedCategory === LINE) {
-          // translators: If uppercase does not work in your locale,
-          // change it to lowercase. This is used as a secondary heading.
+          // L10n: If uppercase does not work in your locale, change it to lowercase. This is used as a secondary heading.
           titleText = i18n.gettext('BY FIREFOX');
         } else {
           titleText = i18n.gettext('SPONSORED');
diff --git a/src/amo/i18n/utils.js b/src/amo/i18n/utils.js
@@ -259,15 +259,15 @@ export const formatFilesize = ({
     // These are the expected values for the unit of measure returned by
     // filesize. Realistically we shouldn't get anything back larger than TB.
     /* eslint-disable max-len */
-    // translators: B is an abbreviation of Bytes in English. Localize it if necessary but use a short abbreviation.
+    // L10n: B is an abbreviation of Bytes in English. Localize it if necessary but use a short abbreviation.
     B: i18n.gettext('%(localizedSize)s B'),
-    // translators: KB is an abbreviation of Kilobytes in English. Localize it if necessary but use a short abbreviation.
+    // L10n: KB is an abbreviation of Kilobytes in English. Localize it if necessary but use a short abbreviation.
     KB: i18n.gettext('%(localizedSize)s KB'),
-    // translators: MB is an abbreviation of Megabytes in English. Localize it if necessary but use a short abbreviation.
+    // L10n: MB is an abbreviation of Megabytes in English. Localize it if necessary but use a short abbreviation.
     MB: i18n.gettext('%(localizedSize)s MB'),
-    // translators: GB is an abbreviation of Gigabytes in English. Localize it if necessary but use a short abbreviation.
+    // L10n: GB is an abbreviation of Gigabytes in English. Localize it if necessary but use a short abbreviation.
     GB: i18n.gettext('%(localizedSize)s GB'),
-    // translators: TB is an abbreviation of Terabytes in English. Localize it if necessary but use a short abbreviation.
+    // L10n: TB is an abbreviation of Terabytes in English. Localize it if necessary but use a short abbreviation.
     TB: i18n.gettext('%(localizedSize)s TB'),
     /* eslint-enable max-len */
   };
diff --git a/src/amo/pages/UserProfile/index.js b/src/amo/pages/UserProfile/index.js
@@ -445,7 +445,7 @@ export class UserProfileBase extends React.Component<InternalProps> {
                   puffy
                 >
                   {
-                    // translators: This action allows an admin to maintain a user.
+                    // L10n: This action allows an admin to maintain a user.
                     i18n.gettext('Admin user')
                   }
                 </Button>
diff --git a/src/amo/pages/UserProfileEdit/index.js b/src/amo/pages/UserProfileEdit/index.js
@@ -683,7 +683,7 @@ export class UserProfileEditBase extends React.Component<InternalProps, State> {
                     title={i18n.gettext('This field is required')}
                   >
                     {
-                      // translators: the star is used to indicate a required field
+                      // L10n: the star is used to indicate a required field
                       i18n.gettext('Display Name *')
                     }
                   </label>
diff --git a/src/amo/pages/UsersUnsubscribe/index.js b/src/amo/pages/UsersUnsubscribe/index.js
@@ -121,11 +121,9 @@ export class UsersUnsubscribeBase extends React.Component<InternalProps> {
                   // eslint-disable-next-line react/no-danger
                   dangerouslySetInnerHTML={sanitizeHTML(
                     i18n.sprintf(
-                      // translators: a list of notifications will be displayed under this prompt.
-                      i18n.gettext(
-                        `The email address %(strongStart)s%(email)s%(strongEnd)s
-                      will no longer get messages when:`,
-                      ),
+                      // L10n: a list of notifications will be displayed under this prompt.
+                      i18n.gettext(`The email address %(strongStart)s%(email)s%(strongEnd)s
+                        will no longer get messages when:`),
                       {
                         strongStart: '<strong>',
                         strongEnd: '</strong>',
diff --git a/src/amo/reducers/versions.js b/src/amo/reducers/versions.js
@@ -301,11 +301,11 @@ export const getVersionInfo = ({
   if (version) {
     const { file } = version;
 
-    // translators: This is application compatibility information, such as "firefox 41 and later"
+    // L10n: This is application compatibility information, such as "firefox 41 and later"
     const noMaxString = i18n.gettext(
       '%(application)s %(minVersion)s and later',
     );
-    // translators: This is application compatibility information, such as "firefox 41 to 45"
+    // L10n: This is application compatibility information, such as "firefox 41 to 45"
     const maxAndMinString = i18n.gettext(
       '%(application)s %(minVersion)s to %(maxVersion)s',
     );
@@ -325,7 +325,7 @@ export const getVersionInfo = ({
 
     const compatibilityString = i18n.sprintf(
       // eslint-disable-next-line max-len
-      // translators: This contains a comma-delimited list of applications and versions, such as "android 41 and later, firefox 42 and later"
+      // L10n: This contains a comma-delimited list of applications and versions, such as "android 41 and later, firefox 42 and later"
       i18n.gettext('Works with %(listOfApplicatonsAndVersions)s'),
       { listOfApplicatonsAndVersions: appInfo },
     );
diff --git a/tests/unit/test_packageJson.js b/tests/unit/test_packageJson.js
@@ -18,7 +18,10 @@ const packageJson = JSON.parse(
 
 // po2json: we're using an unreleased git commit because there hasn't been a
 // release with the fixes to its dependencies.
+
+// babel-gettext-extractor: kinda the same as po2json
 const skipDevDeps = [
+  'babel-gettext-extractor',
   'prettier',
   'pretty-quick',
   'html-webpack-plugin',
diff --git a/yarn.lock b/yarn.lock
@@ -2613,10 +2613,9 @@ axobject-query@^3.1.1:
   dependencies:
     deep-equal "^2.0.5"
 
-babel-gettext-extractor@^4.1.3:
-  version "4.1.3"
-  resolved "https://registry.yarnpkg.com/babel-gettext-extractor/-/babel-gettext-extractor-4.1.3.tgz#7d3343b9c9875cf6d25f1526f9de05598bd61f83"
-  integrity sha512-R0IZVLMgmUtmqeADC1FVKAcJ1ssTZT0IUhH/QsSaoNdYP8u3z4o3y4N+qYNqBNlKrLnHqlN6n8/DJawTONSyIA==
+"babel-gettext-extractor@https://github.com/willdurand/babel-gettext-extractor#5.1.0":
+  version "5.1.0"
+  resolved "https://github.com/willdurand/babel-gettext-extractor#6d534942510315291b3a5025b4a310ccd48c567e"
   dependencies:
     "@babel/core" "^7.0.0"
     gettext-parser "1.4.0"

Original file line number	Diff line number	Diff line change
`@@ -265,7 +265,7 @@ export class AddAddonToCollectionBase extends React.Component<InternalProps> {`
`265`	`265`	`});`
`266`	`266`	`}`
`267`	`267`
`268`		`- // translators: This is a header for a list meaning Add to [some collection name]`
	`268`	`+ // L10n: This is a header for a list meaning Add to [some collection name]`
`269`	`269`	`const collectionOptLabel = i18n.gettext('Add to…');`
`270`	`270`
`271`	`271`	`return (`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ export class AddonAdminLinksBase extends React.Component<InternalProps> {`
`72`	`72`	`>`
`73`	`73`	`{`
`74`	`74`	`// eslint-disable-next-line max-len`
`75`		`- // translators: This action allows the add-on developer or an admin to edit an add-on's properties.`
	`75`	`+ // L10n: This action allows the add-on developer or an admin to edit an add-on's properties.`
`76`	`76`	`i18n.gettext('Edit add-on')`
`77`	`77`	`}`
`78`	`78`	`</a>`
`@@ -86,7 +86,7 @@ export class AddonAdminLinksBase extends React.Component<InternalProps> {`
`86`	`86`	href={`/admin/models/addons/addon/${addon.id}`}
`87`	`87`	`>`
`88`	`88`	`{`
`89`		`- // translators: This action allows an admin to maintain an add-on.`
	`89`	`+ // L10n: This action allows an admin to maintain an add-on.`
`90`	`90`	`i18n.gettext('Admin add-on')`
`91`	`91`	`}`
`92`	`92`	`</a>`
`@@ -100,17 +100,17 @@ export class AddonAdminLinksBase extends React.Component<InternalProps> {`
`100`	`100`	href={`/reviewers/review-content/${addon.id}`}
`101`	`101`	`>`
`102`	`102`	`{`
`103`		`- // translators: This action allows a reviewer to perform a content review of an add-on.`
	`103`	`+ // L10n: This action allows a reviewer to perform a content review of an add-on.`
`104`	`104`	`i18n.gettext('Content review add-on')`
`105`	`105`	`}`
`106`	`106`	`</a>`
`107`	`107`	`</li>`
`108`	`108`	`) : null;`
`109`	`109`
`110`	`110`	`const codeReviewLinkText = isTheme`
`111`		`- ? // translators: This action allows a reviewer to perform a review of a theme.`
	`111`	`+ ? // L10n: This action allows a reviewer to perform a review of a theme.`
`112`	`112`	`i18n.gettext('Review theme')`
`113`		`- : // translators: This action allows a reviewer to perform a review of an add-on's code.`
	`113`	`+ : // L10n: This action allows a reviewer to perform a review of an add-on's code.`
`114`	`114`	`i18n.gettext('Review add-on code');`
`115`	`115`	`const codeReviewLink =`
`116`	`116`	`showCodeReviewLink \|\| showStaticThemeReviewLink ? (`
`@@ -130,7 +130,7 @@ export class AddonAdminLinksBase extends React.Component<InternalProps> {`
`130`	`130`	`<DefinitionList className="AddonAdminLinks">`
`131`	`131`	`<Definition`
`132`	`132`	`term={`
`133`		`- // translators: This is a list of links to administrative functions.`
	`133`	`+ // L10n: This is a list of links to administrative functions.`
`134`	`134`	`i18n.gettext('Admin Links')`
`135`	`135`	`}`
`136`	`136`	`>`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ export class AddonAuthorLinksBase extends React.Component<InternalProps> {`
`47`	`47`	`>`
`48`	`48`	`{`
`49`	`49`	`// eslint-disable-next-line max-len`
`50`		`- // translators: This action allows the add-on developer to edit an add-on's properties.`
	`50`	`+ // L10n: This action allows the add-on developer to edit an add-on's properties.`
`51`	`51`	`i18n.gettext('Edit add-on')`
`52`	`52`	`}`
`53`	`53`	`</a>`
`@@ -58,7 +58,7 @@ export class AddonAuthorLinksBase extends React.Component<InternalProps> {`
`58`	`58`	`<DefinitionList className="AddonAuthorLinks">`
`59`	`59`	`<Definition`
`60`	`60`	`term={`
`61`		`- // translators: This is a list of links to Developer functions.`
	`61`	`+ // L10n: This is a list of links to Developer functions.`
`62`	`62`	`i18n.gettext('Author Links')`
`63`	`63`	`}`
`64`	`64`	`>`