@bigbinary/eslint-plugin-neeto 1.8.3 → 1.8.5

package/README.md

@@ -75,6 +75,7 @@ of the issues identified in JavaScript code.
 - [no-buildurl-call-with-empty-params](./docs/src/rules/no-buildurl-call-with-empty-params.md)
 - [no-conditional-overlays](./docs/src/rules/no-conditional-overlays.md)
 - [no-deprecated-imports-from-zustand](./docs/src/rules/no-deprecated-imports-from-zustand.md)
+- [no-edits-to-generated-translation-files](./docs/src/rules/no-edits-to-generated-translation-files.md)
 - [no-dangling-constants](./docs/src/rules/no-dangling-constants.md)
 - [no-globalProps-destructure](./docs/src/rules/no-globalProps-destructure.md)
 - [no-globalProps-reassignment](./docs/src/rules/no-globalProps-reassignment.md)

package/dist/index.js

@@ -109,6 +109,7 @@
     "@bigbinary/neeto/no-buildurl-call-with-empty-params": "error",
     "@bigbinary/neeto/no-conditional-overlays": "error",
     "@bigbinary/neeto/no-deprecated-imports-from-zustand": "error",
+    "@bigbinary/neeto/no-edits-to-generated-translation-files": "error",
     "@bigbinary/neeto/no-dangling-constants": "error",
     "@bigbinary/neeto/no-excess-function-arguments": "warn",
     "@bigbinary/neeto/no-globalProps-destructure": "error",
@@ -138,7 +139,6 @@
     "@bigbinary/neeto/use-i18next-plurals": "error",
     "@bigbinary/neeto/use-inline-svg-for-render": "error",
     "@bigbinary/neeto/use-title-case-neeto-in-strings": "warn",
-    "@bigbinary/neeto/use-neetoui-classes": "warn",
     "@bigbinary/neeto/use-permissions-prop-in-private-route": "warn",
     "@bigbinary/neeto/use-pluralize-package": "error",
     "@bigbinary/neeto/use-react-query-for-managing-remote-data": "warn",
@@ -280,12 +280,11 @@
       "@bigbinary/neeto/use-react-query-for-managing-remote-data": "off",
       "@bigbinary/neeto/use-webpack-alias": ["error", resolve.alias],
       "@bigbinary/neeto/webpack-aliases-and-jsconfig-paths-should-be-in-sync": "off",
-      "@bigbinary/neeto/use-neetoui-classes": "off",
       "@bigbinary/neeto/hard-coded-strings-should-be-localized": "off"
     }
   });
 
-  var version = "1.8.2";
+  var version = "1.8.4";
   var packageJson = {
   	version: version};
 
@@ -315,6 +314,8 @@
   const REACT_QUERY_DIRECTORY = "app/javascript/src/hooks/reactQuery";
   const ROUTES_FILE_PATH = "app/javascript/src/routes.js";
   const COMPONENTS_DIRECTORY = "app/javascript/src/components";
+  const TRANSLATIONS_DIRECTORY = "app/javascript/src/translations";
+  const TRANSLATION_SOURCE_LOCALE = "en";
   const BLACKLISTED_PACKAGES = ["moment", "bootstrap", "blueprint", "react-spinners", "react-table", "remixicon", "mjml", "react-select", "@bigbinary/neeto-utils"];
   const TYPES = {
     ARRAY_EXPRESSION: "ArrayExpression",
@@ -545,6 +546,7 @@
   const HELP_URL_INCORRECT_FORMAT = "Incorrect help URL format. Please use the 'help.neeto<product>.com' format instead of 'neeto<product>help.neetokb.com'.";
   const INVALID_SWITCH_CHILD_MESSAGE = "Switch component can only contain Route, Redirect, or PrivateRoute as direct children";
   const PREFER_RADIO_BUTTONS_FOR_FEW_OPTIONS = "Consider using Radio buttons instead of Dropdown/Select when there are fewer than 4 options.";
+  const NO_EDITS_TO_GENERATED_TRANSLATION_FILES = "This translation file is auto-generated. Only edit 'en.json'; translations for all other locales are generated from it automatically. Please revert your changes in this file.";
 
   const PACKAGES_TO_CHECK = ["@bigbinary/neeto-molecules", "@bigbinary/neetoui", "@bigbinary/neeto-commons-frontend"];
 
@@ -716,6 +718,19 @@
     return filename.startsWith(componentsDirectory);
   };
 
+  /**
+   * Checks if the file is an auto-generated translation file, i.e. a JSON locale
+   * file inside the `translations` directory other than the source locale
+   * (en.json), which is the only file meant to be edited by hand.
+   * @param {Object} context eslint context
+   * @returns true if the file is a generated (non-source) translation file
+   */
+  const isGeneratedTranslationFile = context => {
+    const [filename, extension] = getFilenameAndExtension(context);
+    const translationsDirectory = path$1.resolve(TRANSLATIONS_DIRECTORY);
+    return context.getFilename().startsWith(translationsDirectory) && extension === "json" && filename !== TRANSLATION_SOURCE_LOCALE;
+  };
+
   /**
    * Checks if the specified package is imported or not
    * using the package name or any alias
@@ -789,8 +804,7 @@
   const parseJsonData = filePath => {
     try {
       const jsonData = fs.readFileSync(filePath).toString();
-      const parsedJsonData = JSON.parse(removeComments(jsonData));
-      return parsedJsonData;
+      return JSON.parse(removeComments(jsonData));
     } catch {
       return {};
     }
@@ -7518,6 +7532,26 @@
     })
   };
 
+  var noEditsToGeneratedTranslationFiles = {
+    meta: {
+      type: "problem",
+      docs: {
+        url: "https://github.com/neetozone/eslint-plugin-neeto/blob/main/docs/src/rules/no-edits-to-generated-translation-files.md",
+        description: "Disallows manual edits to auto-generated translation files. Only the source locale (en.json) should be edited by hand."
+      }
+    },
+    create: context => ({
+      Program(node) {
+        if (isGeneratedTranslationFile(context)) {
+          context.report({
+            node,
+            message: NO_EDITS_TO_GENERATED_TRANSLATION_FILES
+          });
+        }
+      }
+    })
+  };
+
   const nonDefaultParam = ({
     type
   }) => type !== TYPES.ASSIGNMENT_PATTERN;
@@ -12217,6 +12251,7 @@
       "no-axios-import-outside-apis": noAxiosImportOutsideApis,
       "no-conditional-overlays": noConditionalOverlays,
       "no-deprecated-imports-from-zustand": noDeprecatedImportsFromZustand,
+      "no-edits-to-generated-translation-files": noEditsToGeneratedTranslationFiles,
       "no-excess-function-arguments": noExcessFunctionArguments,
       "no-dangling-constants": noDanglingConstants,
       "no-globalProps-destructure": noGlobalPropsDestructure,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbinary/eslint-plugin-neeto",
-  "version": "1.8.3",
+  "version": "1.8.5",
   "main": "dist/index.js",
   "license": "UNLICENSED",
   "scripts": {