Merge pull request #1984 from oasisprotocol/lw/extend-google-translat…

…e-lint

Lint rule to detect broken Google Translate in CommissionBounds

.changelog/1984.internal.md

@@ -0,0 +1 @@
+Lint rule to detect broken Google Translate in CommissionBounds

.eslintrc.js

@@ -68,6 +68,21 @@ const noGoogleTranslateCrashingSyntax = [
       'Plain text nodes before or after a condition could break React if used with Google Translate. Identifier could possibly return a string, so wrap it into an element.',
   },
 
+  // Ban components returning text or variables inside fragments `return <>{t('text')}</>` (just in case vars return a string and parent components are conditionally inserted)
+  // TODO: doesn't catch `return t('text')`
+  {
+    selector:
+      ':matches(ArrowFunctionExpression, ReturnStatement) > JSXFragment > JSXExpressionContainer > :not(' +
+      '  JSXEmptyExpression, ' + // Allow `<>{/* Comment */}</>`
+      '  ConditionalExpression[consequent.type="JSXElement"][alternate.type="JSXElement"], ' + // Allow `<><Box></Box>{condition ? <Box></Box> : <Box></Box>}</>`
+      '  LogicalExpression[right.type="JSXElement"], ' + // Allow `<><Box></Box>{condition && <Box></Box>}</>`
+      '  Identifier[name="children"], ' + // Allow `<>{children}</>`
+      '  MemberExpression[property.name="children"]' + // Allow `<>{someProps.children}</>`
+      ')',
+    message:
+      'Text nodes inside React fragments could break React if used with Google Translate. Identifier could possibly return a string, and parent components could be conditionally inserted, so wrap it into an element.',
+  },
+
   // TODO: Nesting is not supported. Detect it as error for now
   {
     selector: 'JSXElement > JSXExpressionContainer > ConditionalExpression > ConditionalExpression',

src/app/components/DateFormatter/index.tsx

@@ -11,5 +11,5 @@ interface Props {
 }
 
 export function DateFormatter(props: Props) {
-  return <>{intlDateTimeFormat(props.date)}</>
+  return <span>{intlDateTimeFormat(props.date)}</span>
 }

src/app/components/ErrorFormatter/index.tsx

@@ -105,5 +105,5 @@ export function ErrorFormatter(props: Props) {
   }
 
   const error = errorMap[props.code]
-  return <>{error}</>
+  return <span>{error}</span>
 }

src/app/components/ImportAccountsStepFormatter/index.tsx

@@ -19,5 +19,5 @@ export const ImportAccountsStepFormatter = memo((props: Props) => {
   }
 
   const message = stepMap[step]
-  return <>{message}</>
+  return <span>{message}</span>
 })

src/app/components/TimeToEpoch/index.tsx

@@ -20,5 +20,5 @@ export function TimeToEpoch(props: Props) {
       ? relativeFormat.format(Math.round(remainingHours / 24), 'day')
       : relativeFormat.format(remainingHours, 'hour')
 
-  return <>{formattedRemainingTime}</>
+  return <span>{formattedRemainingTime}</span>
 }

src/app/components/Transaction/__tests__/index.test.tsx

@@ -19,7 +19,7 @@ jest.mock('copy-to-clipboard')
 
 type TransType = typeof Trans
 jest.mock('react-i18next', () => ({
-  Trans: (({ i18nKey }) => <>{i18nKey}</>) as TransType,
+  Trans: (({ i18nKey }) => i18nKey) as TransType,
   useTranslation: () => {
     return {
       t: (str: string) => str,

src/app/pages/ParaTimesPage/TransactionError/__tests__/__snapshots__/index.test.tsx.snap

@@ -534,7 +534,9 @@ exports[`<TransactionError /> should render component 1`] = `
                 class="c11"
                 style="vertical-align: middle;"
               >
-                Unknown ParaTime error: error message
+                <span>
+                  Unknown ParaTime error: error message
+                </span>
               </span>
             </div>
           </div>

src/app/pages/StakingPage/Features/DelegationList/__tests__/__snapshots__/DebondingDelegationList.test.tsx.snap

@@ -595,7 +595,9 @@ exports[`<DebondingDelegationList  /> should match snapshot 1`] = `
                     id="cell-debondingTimeEnd-test-validator+100"
                     role="gridcell"
                   >
-                    in 4 days
+                    <span>
+                      in 4 days
+                    </span>
                   </div>
                 </div>
               </div>

src/utils/eslint-test-noGoogleTranslateCrashingSyntax.tsx

@@ -6,6 +6,7 @@
  * these work like "expect eslint error".
  */
 /* eslint-disable @typescript-eslint/no-unused-vars */
+/* eslint-disable react-refresh/only-export-components */
 
 const condition = true
 const bad = 'bad'
@@ -194,6 +195,29 @@ const textAfterTernaryOperator = (
   </div>
 )
 
+function TextInFragment() {
+  const Arrow1 = () => <>{condition && <span>good</span>}</>
+  /* eslint-disable-next-line no-restricted-syntax */
+  const Arrow2 = () => <>{!condition ? <span>good</span> : 'bad'}</>
+
+  return (
+    <>
+      {/* good */}
+      {condition ? <Arrow1 /> : <Arrow2 />}
+      {condition && <span>good</span>}
+      {!condition ? <span>good</span> : <span>good</span>}
+      {/* eslint-disable-next-line no-restricted-syntax */}
+      {!condition ? <span>good</span> : 'bad'}
+      {/* eslint-disable-next-line no-restricted-syntax */}
+      {'bad'}
+      {/* eslint-disable-next-line no-restricted-syntax */}
+      {bad}
+      {/* eslint-disable-next-line no-restricted-syntax */}
+      {bad.toString()}
+    </>
+  )
+}
+
 const nestedConditionsAreNotSupported = (
   <div>
     <span>