@gitlab/eslint-plugin 19.4.0 → 19.5.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [19.5.0](https://gitlab.com/gitlab-org/frontend/eslint-plugin/compare/v19.4.0...v19.5.0) (2024-03-27)
+
+
+### Features
+
+* **require-valid-i18n-helpers:** lint against string interpolation ([268d858](https://gitlab.com/gitlab-org/frontend/eslint-plugin/commit/268d858f8bd02cab06ea74f2c6844166489d0d89))
+
 # [19.4.0](https://gitlab.com/gitlab-org/frontend/eslint-plugin/compare/v19.3.0...v19.4.0) (2024-01-10)
 
 

package/docs/rules/require-valid-i18n-helpers.md

@@ -5,6 +5,8 @@ following:
 
 - All helpers should be called with string-literal arguments to ensure the strings are properly
   collected by the `gettext:regenerate` script.
+- The helpers' arguments should not use string interpolation as this also prevents the strings from
+  being collected.
 - `__` should not be called with a namespace.
 - `s__` requires a translation namespace to be provided.
 - `n__` should use the same namespace, or no namespace at all, for both the singular and plural forms.
@@ -21,6 +23,11 @@ const description = __(getDescription());
 // Extraneous namespace
 const globalTranslation = __('Global|Translation');
 
+// String interpolation
+const withStringInterpolation1 = __(`String ${interpolation}`);
+const withStringInterpolation2 = s__("SomeContext", `String ${interpolation}`);
+const withStringInterpolation3 = n__("%d apple", `%d ${apples}`, appleCount);
+
 // Missing translation namespace
 const namespacedTranslation = s__('NamespacedTranslation');
 

package/docs/rules/vue-require-valid-i18n-helpers.md

@@ -13,6 +13,11 @@ This rule is like [require-valid-i18n-helpers](./require-valid-i18n-helpers.md)
     {{ __(LABEL) }}
     {{ __(getDescription()) }}
 
+    <!-- String interpolation -->
+    {{ __(`String ${interpolation}`) }}
+    {{ s__("SomeContext", `String ${interpolation}`) }}
+    {{ n__("%d apple", `%d ${apples}`, appleCount) }}
+
     <!-- Missing translation namespace -->
     {{ s__('NamespacedTranslation') }}
   </div>

package/lib/utils/i18n-utils.js

@@ -10,6 +10,8 @@ const P_GETTEXT = 's__';
 const N_GETTEXT = 'n__';
 
 const ERROR_MESSAGE_STRING_LITERAL = 'Translation helpers must be called with a string literal.';
+const ERROR_MESSAGE_STRING_INTERPOLATION =
+  'Translation helpers should not use string interpolation.';
 const ERROR_MESSAGE_EXTRANEOUS_NAMESPACE =
   '__ should not be used with a translation namespace, consider using s__ instead.';
 const ERROR_MESSAGE_MISSING_NAMESPACE = 's__ requires a translation namespace to be provided.';
@@ -38,6 +40,16 @@ const mustBeCalledWithStringLiteralArguments = (context, node) => {
   }
 };
 
+const mustNotHaveStringInterpolation = (context, node) => {
+  const [arg1, arg2] = node.arguments;
+  if ([arg1, arg2].some((arg) => arg?.expressions?.length)) {
+    context.report({
+      node,
+      message: ERROR_MESSAGE_STRING_INTERPOLATION,
+    });
+  }
+};
+
 const mustHaveNamespace = (context, node) => {
   if (node.arguments.length === 2) {
     return;
@@ -94,9 +106,21 @@ const namespacesMustMatch = (context, node) => {
 };
 
 const VALIDATORS = {
-  [GETTEXT]: [mustBeCalledWithStringLiteralArguments, mustNotHaveNamespace],
-  [P_GETTEXT]: [mustBeCalledWithStringLiteralArguments, mustHaveNamespace],
-  [N_GETTEXT]: [mustBeCalledWithStringLiteralArguments, namespacesMustMatch],
+  [GETTEXT]: [
+    mustBeCalledWithStringLiteralArguments,
+    mustNotHaveStringInterpolation,
+    mustNotHaveNamespace,
+  ],
+  [P_GETTEXT]: [
+    mustBeCalledWithStringLiteralArguments,
+    mustNotHaveStringInterpolation,
+    mustHaveNamespace,
+  ],
+  [N_GETTEXT]: [
+    mustBeCalledWithStringLiteralArguments,
+    mustNotHaveStringInterpolation,
+    namespacesMustMatch,
+  ],
 };
 
 const validateI18nHelperCallFactory = (context) => (node) => {
@@ -113,6 +137,7 @@ const validateI18nHelperCallFactory = (context) => (node) => {
 module.exports = {
   validateI18nHelperCallFactory,
   ERROR_MESSAGE_STRING_LITERAL,
+  ERROR_MESSAGE_STRING_INTERPOLATION,
   ERROR_MESSAGE_EXTRANEOUS_NAMESPACE,
   ERROR_MESSAGE_MISSING_NAMESPACE,
   ERROR_MESSAGE_NAMESPACES_MISMATCH,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlab/eslint-plugin",
-  "version": "19.4.0",
+  "version": "19.5.0",
   "description": "GitLab package for our custom eslint rules",
   "main": "lib/index.js",
   "scripts": {