@gitlab/eslint-plugin 18.2.0 → 18.3.0

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+# [18.3.0](https://gitlab.com/gitlab-org/frontend/eslint-plugin/compare/v18.2.1...v18.3.0) (2023-03-23)
+
+
+### Features
+
+* **i18n:** lint against namespaces in gettext ([f3f3579](https://gitlab.com/gitlab-org/frontend/eslint-plugin/commit/f3f35799f85be89ac31b8785036d9f28b97c60e9))
+* **i18n:** require matching namespaces in n_gettext ([63fcbb5](https://gitlab.com/gitlab-org/frontend/eslint-plugin/commit/63fcbb5483cda54e85244ecd716b1fea94e8ae11))
+
+## [18.2.1](https://gitlab.com/gitlab-org/frontend/eslint-plugin/compare/v18.2.0...v18.2.1) (2023-03-22)
+
+
+### Bug Fixes
+
+* disable no-restricted-syntax rules ([cf65279](https://gitlab.com/gitlab-org/frontend/eslint-plugin/commit/cf652794d8d8a87a775af5bf0805f5194a599e75)), closes [/github.com/airbnb/javascript/blob/eslint-config-airbnb-v15.0.0/packages/eslint-config-airbnb-base/rules/style.js#L257-L275](https://gitlab.com//github.com/airbnb/javascript/blob/eslint-config-airbnb-v15.0.0/packages/eslint-config-airbnb-base/rules/style.js/issues/L257-L275)
+
 # [18.2.0](https://gitlab.com/gitlab-org/frontend/eslint-plugin/compare/v18.1.0...v18.2.0) (2023-03-03)
 
 

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

@@ -5,7 +5,9 @@ following:
 
 - All helpers should be called with string-literal arguments to ensure the strings are properly
   collected by the `gettext:regenerate` script.
+- `__` 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.
 
 ## Rule Details
 
@@ -16,8 +18,15 @@ following:
 const label = __(LABEL);
 const description = __(getDescription());
 
+// Extraneous namespace
+const globalTranslation = __('Global|Translation');
+
 // Missing translation namespace
 const namespacedTranslation = s__('NamespacedTranslation');
+
+// Mismatching namespaces when pluralizing
+const namespaceMismatch1 = n__('%d apple', 'Fruits|%d apples', 1);
+const namespaceMismatch2 =n__('Vegetables|%d apple', 'Fruits|%d apples', 3);
 ```
 
 ### Examples of **correct** code for this rule
@@ -26,10 +35,17 @@ const namespacedTranslation = s__('NamespacedTranslation');
 // Valid argument type
 const label = __('Some label');
 
+// Valid gettext usage
+const globalTranslation = __('Translation');
+
 // Valid translation namespace
 const namespacedTranslation = s__('Namespace|Translation');
 // or
 const otherNamespacedTranslation = s__('Namespace', 'Other translation');
+
+// Matching namespaces
+const namespacesMatch1 = n__('%d apple', '%d apples', 1);
+const namespacesMatch2 =n__('Fruits|%d apple', 'Fruits|%d apples', 3);
 ```
 
 ## Options

package/lib/configs/default.js

@@ -55,6 +55,7 @@ module.exports = {
         ],
       },
     ],
+    'no-restricted-syntax': 'off',
     'no-sequences': [
       'error',
       {

package/lib/utils/i18n-utils.js

@@ -10,7 +10,16 @@ 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_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.';
+const ERROR_MESSAGE_NAMESPACES_MISMATCH =
+  'Both strings should use the same namesapce, or no namespace at all, when using n__.';
+
+const NAMESPACE_REGEX = /^\w.+\|/;
+
+const getArgAsString = (arg) =>
+  isTemplateLiteral(arg) ? getTemplateLiteralString(arg).trim() : arg.value;
 
 const mustBeCalledWithStringLiteralArguments = (context, node) => {
   const report = (node) => {
@@ -35,8 +44,8 @@ const mustHaveNamespace = (context, node) => {
   }
 
   const [arg] = node.arguments;
-  const value = isTemplateLiteral(arg) ? getTemplateLiteralString(arg).trim() : arg.value;
-  if (!/^\w.+\|/.test(value)) {
+  const value = getArgAsString(arg);
+  if (!NAMESPACE_REGEX.test(value)) {
     context.report({
       node,
       message: ERROR_MESSAGE_MISSING_NAMESPACE,
@@ -44,10 +53,50 @@ const mustHaveNamespace = (context, node) => {
   }
 };
 
+const mustNotHaveNamespace = (context, node) => {
+  const [arg] = node.arguments;
+
+  // We can ignore cases where no argument is provided as they will
+  // be caught by mustBeCalledWithStringLiteralArguments
+  if (arg === undefined) {
+    return;
+  }
+
+  const value = getArgAsString(arg);
+  if (NAMESPACE_REGEX.test(value)) {
+    context.report({
+      node,
+      message: ERROR_MESSAGE_EXTRANEOUS_NAMESPACE,
+    });
+  }
+};
+
+const namespacesMustMatch = (context, node) => {
+  const [arg1, arg2] = node.arguments;
+  const [value1, value2] = [arg1, arg2].map((arg) => getArgAsString(arg));
+
+  // Escape early if either value isn't defined, mustBeCalledWithStringLiteralArguments will
+  // handle those.
+  if (!value1 || !value2) {
+    return;
+  }
+
+  const [namespace1, namespace2] = [value1, value2].map((value) => {
+    const splitString = value.split('|');
+    return splitString.length > 1 ? splitString[0] : '';
+  });
+  if (namespace1 !== namespace2) {
+    context.report({
+      node,
+      message: ERROR_MESSAGE_NAMESPACES_MISMATCH,
+    });
+  }
+};
+
 const VALIDATORS = {
-  [GETTEXT]: [mustBeCalledWithStringLiteralArguments],
+  [GETTEXT]: [mustBeCalledWithStringLiteralArguments, mustNotHaveNamespace],
   [P_GETTEXT]: [mustBeCalledWithStringLiteralArguments, mustHaveNamespace],
-  [N_GETTEXT]: [mustBeCalledWithStringLiteralArguments],
+  [N_GETTEXT]: [mustBeCalledWithStringLiteralArguments, namespacesMustMatch],
 };
 
 const validateI18nHelperCallFactory = (context) => (node) => {
@@ -64,5 +113,7 @@ const validateI18nHelperCallFactory = (context) => (node) => {
 module.exports = {
   validateI18nHelperCallFactory,
   ERROR_MESSAGE_STRING_LITERAL,
+  ERROR_MESSAGE_EXTRANEOUS_NAMESPACE,
   ERROR_MESSAGE_MISSING_NAMESPACE,
+  ERROR_MESSAGE_NAMESPACES_MISMATCH,
 };

package/package.json

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