@bigbinary/eslint-plugin-neeto 1.3.0 → 1.5.0

package/README.md

@@ -46,12 +46,15 @@ module.exports = {
 
 ## Exported rules
 
+ESLint rules are categorized as either errors or warnings based on the severity
+of the issues identified in JavaScript code.
+
+### Errors
+
 - [no-unnecessary-classnames](./docs/src/rules/no-unnecessary-classnames.md)
-- [no-snake-case-destructuring-for-use-query-params-and-get-query-params](./docs/src/rules/no-snake-case-destructuring-for-use-query-params-and-get-query-params.md)
 - [no-local-storage](./docs/src/rules/no-local-storage.md)
 - [no-lowercase-on-translation](./docs/src/rules/no-lowercase-on-translation.md)
 - [use-use-query-client-hook](./docs/src/rules/use-use-query-client-hook.md)
-- [use-early-return](./docs/src/rules/use-early-return.md)
 - [use-classnames-for-dynamic-classes](./docs/src/rules/use-classnames-for-dynamic-classes.md)
 - [use-use-mutation-with-invalidation-hook](./docs/src/rules/use-use-mutation-with-invalidation-hook.md)
 - [no-withT-for-smart-components](./docs/src/rules/no-withT-for-smart-components.md)
@@ -61,22 +64,16 @@ module.exports = {
 - [no-unnecessary-if-condition](./docs/src/rules/no-unnecessary-if-condition.md)
 - [api-connector-name-should-match-filename](./docs/src/rules/api-connector-name-should-match-filename.md)
 - [api-connector-should-use-default-export](./docs/src/rules/api-connector-should-use-default-export.md)
-- [combine-multiple-independent-awaits](./docs/src/rules/combine-multiple-independent-awaits.md)
-- [consistent-button-link-anchor](./docs/src/rules/consistent-button-link-anchor.md)
 - [ensure-compact-objects](./docs/src/rules/ensure-compact-objects.md)
 - [ensure-formik-eager-validation](./docs/src/rules/ensure-formik-eager-validation.md)
 - [ensure-zustand-stores-are-type-annotated](./docs/src/rules/ensure-zustand-stores-are-type-annotated.md)
 - [files-inside-react-query-folder-should-end-with-api](./docs/src/rules/files-inside-react-query-folder-should-end-with-api.md)
-- [file-name-and-export-name-standards](./docs/src/rules/file-name-and-export-name-standards.md)
-- [hard-coded-strings-should-be-localized](./docs/src/rules/hard-coded-strings-should-be-localized.md)
 - [minimize-zustand-store-access-scope](./docs/src/rules/minimize-zustand-store-access-scope.md)
-- [neetocommons-tips](./docs/src/rules/neetocommons-tips.md)
 - [no-axios-import-outside-apis](./docs/src/rules/no-axios-import-outside-apis.md)
 - [no-blacklisted-imports](./docs/src/rules/no-blacklisted-imports.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-dangling-constants](./docs/src/rules/no-dangling-constants.md)
-- [no-excess-function-arguments](./docs/src/rules/no-excess-function-arguments.md)
 - [no-globalProps-destructure](./docs/src/rules/no-globalProps-destructure.md)
 - [no-globalProps-reassignment](./docs/src/rules/no-globalProps-reassignment.md)
 - [no-missing-localization](./docs/src/rules/no-missing-localization.md)
@@ -88,27 +85,21 @@ module.exports = {
 - [no-routes-destructure-and-reassignment](./docs/src/rules/no-routes-destructure-and-reassignment.md)
 - [no-translation-functions-in-string-interpolation](./docs/src/rules/no-translation-functions-in-string-interpolation.md)
 - [prefix-neeto-ui-import-alias](./docs/src/rules/prefix-neeto-ui-import-alias.md)
-- [ramda-tips](./docs/src/rules/ramda-tips.md)
 - [routes-should-be-declared-and-default-exported](./docs/src/rules/routes-should-be-declared-and-default-exported.md)
 - [routes-should-match-object-path](./docs/src/rules/routes-should-match-object-path.md)
 - [use-array-methods](./docs/src/rules/use-array-methods.md)
 - [use-axios-config-for-passing-query-parameters](./docs/src/rules/use-axios-config-for-passing-query-parameters.md)
 - [use-camel-case-or-pascal-case-for-function-names](./docs/src/rules/use-camel-case-or-pascal-case-for-function-names.md)
-- [use-common-constants](./docs/src/rules/use-common-constants.md)
 - [use-common-routes](./docs/src/rules/use-common-routes.md)
 - [use-components-children-prop-in-trans](./docs/src/rules/use-components-children-prop-in-trans.md)
 - [use-create-subscription-util-function](./docs/src/rules/use-create-subscription-util-function.md)
 - [use-i18next-plurals](./docs/src/rules/use-i18next-plurals.md)
 - [use-inline-svg-for-render](./docs/src/rules/use-inline-svg-for-render.md)
-- [use-neeto-in-strings](./docs/src/rules/use-neeto-in-strings.md)
-- [use-neetoui-classes](./docs/src/rules/use-neetoui-classes.md)
-- [use-permissions-prop-in-private-route](./docs/src/rules/use-permissions-prop-in-private-route.md)
 - [use-pluralize-package](./docs/src/rules/use-pluralize-package.md)
 - [use-react-query-for-managing-remote-data](./docs/src/rules/use-react-query-for-managing-remote-data.md)
 - [use-snake-case-for-api-connector-filename](./docs/src/rules/use-snake-case-for-api-connector-filename.md)
 - [use-translation-hook-in-components](./docs/src/rules/use-translation-hook-in-components.md)
 - [use-trans-components-and-values-props](./docs/src/rules/use-trans-components-and-values-props.md)
-- [use-webpack-alias](./docs/src/rules/use-webpack-alias.md)
 - [use-zustand-for-global-state-management](./docs/src/rules/use-zustand-for-global-state-management.md)
 - [webpack-aliases-and-jsconfig-paths-should-be-in-sync](./docs/src/rules/webpack-aliases-and-jsconfig-paths-should-be-in-sync.md)
 - [zustand-recommend-comparator-function-usage](./docs/src/rules/zustand-recommend-comparator-function-usage.md)
@@ -118,13 +109,58 @@ module.exports = {
 - [merge-spread-attributes](./docs/src/rules/merge-spread-attributes.md)
 - [props-with-different-key-value-should-be-outside-spread-attribute](./docs/src/rules/props-with-different-key-value-should-be-outside-spread-attribute.md)
 - [no-repetition-in-prop-key-value-names](./docs/src/rules/no-repetition-in-prop-key-value-names.md)
-- [use-functions-and-hooks-from-neeto-commons-frontend.md](./docs/src/rules/use-functions-and-hooks-from-neeto-commons-frontend.md)
 - [zustand-use-with-immutable-actions-wrapper-inside-create](./docs/src/rules/zustand-use-with-immutable-actions-wrapper-inside-create.md)
 - [add-required-peer-dependencies](./docs/src/rules/add-required-peer-dependencies.md)
 - [move-spread-attributes-to-top-position](./docs/src/rules/move-spread-attributes-to-top-position.md)
-- [prefer-function-reference.md](./docs/src/rules/prefer-function-reference.md)
+- [use-show-thumbs-up-toastr](./docs/src/rules/use-show-thumbs-up-toastr)
+- [ensure-usestate-has-initial-value](./docs/src/rules/ensure-usestate-has-initial-value.md)
+
+### Warnings
+
+- [ramda-tips](./docs/src/rules/ramda-tips.md)
+- [combine-multiple-independent-awaits](./docs/src/rules/combine-multiple-independent-awaits.md)
+- [consistent-button-link-anchor](./docs/src/rules/consistent-button-link-anchor.md)
+- [file-name-and-export-name-standards](./docs/src/rules/file-name-and-export-name-standards.md)
+- [hard-coded-strings-should-be-localized](./docs/src/rules/hard-coded-strings-should-be-localized.md)
 - [jsx-prefer-guard-clause.md](./docs/src/rules/jsx-prefer-guard-clause.md)
-- [use-show-thumbs-up-toastr.md](./docs/src/rules/use-show-thumbs-up-toastr)
+- [neetocommons-tips](./docs/src/rules/neetocommons-tips.md)
+- [no-excess-function-arguments](./docs/src/rules/no-excess-function-arguments.md)
+- [no-snake-case-destructuring-for-use-query-params-and-get-query-params](./docs/src/rules/no-snake-case-destructuring-for-use-query-params-and-get-query-params.md)
+- [prefer-function-reference.md](./docs/src/rules/prefer-function-reference.md)
+- [use-common-constants](./docs/src/rules/use-common-constants.md)
+- [use-early-return](./docs/src/rules/use-early-return.md)
+- [use-functions-and-hooks-from-neeto-commons-frontend.md](./docs/src/rules/use-functions-and-hooks-from-neeto-commons-frontend.md)
+- [use-neeto-in-strings](./docs/src/rules/use-neeto-in-strings.md)
+- [use-neetoui-classes](./docs/src/rules/use-neetoui-classes.md)
+- [use-permissions-prop-in-private-route](./docs/src/rules/use-permissions-prop-in-private-route.md)
+- [use-webpack-alias](./docs/src/rules/use-webpack-alias.md)
+
+## Overriding rules
+
+### ESLint Errors
+
+ESLint errors flag the mandatory coding standards that developers must strictly
+adhere to. These errors are detected by the `pre-commit` hook and in CI checks.
+There may be instances where we intentionally choose to adopt a particular
+coding style and wish to prevent ESLint from throwing errors. In such cases, you
+can temporarily disable the rule responsible for the false alarm by adding a
+comment above the code, specifying the reason why you have disabled that
+particular rule for that line to avoid any future confusion:
+
+```js
+// Reason for disabling the rule.
+// eslint-disable-next-line <rule>
+```
+
+### ESLint Warnings
+
+When creating an ESLint rule, it may not always be possible to cover every edge
+case and eliminate all false positives. Such rules have been configured as
+warnings instead of errors. These warnings are not flagged during `pre-commit`
+hooks or CI checks. Nevertheless, ESLint warnings also need to be treated in the
+same way as ESLint errors. It's recommended to review and address them whenever
+feasible. However, if you find that the suggestion does not apply to your
+specific situation, you have the flexibility to disregard it.
 
 ## Other references
 

package/dist/index.js

@@ -165,6 +165,7 @@
     "@bigbinary/neeto/move-spread-attributes-to-top-position": "error",
     "@bigbinary/neeto/prefer-function-reference": "warn",
     "@bigbinary/neeto/jsx-prefer-guard-clause": "warn",
+    "@bigbinary/neeto/ensure-usestate-has-initial-value": "error",
     "@bigbinary/neeto/use-show-thumbs-up-toastr": "error"
   };
 
@@ -586,6 +587,7 @@
   var JSX_PREFER_GUARD_CLAUSE = "Prefer adding a guard clause for conditional statements left of JSX statments in the last return statement of the function.";
   var USE_SHOW_THUMBS_UP_TOASTR_FUNCTION = "Use 'showThumbsUpToastr' function from '@bigbinary/neeto-commons-frontend/utils' for displaying thumbs up toast message.";
   var NO_UNNECESSARY_CLASSNAMES = "classnames usage is unnecessary";
+  var USESTATE_DECLARATIONS_SHOULD_HAVE_INITIAL_VALUE = '"useState" declarations should have an initial value.';
 
   var PACKAGES_TO_CHECK = ["@bigbinary/neeto-molecules", "@bigbinary/neetoui", "@bigbinary/neeto-commons-frontend"];
 
@@ -2092,6 +2094,15 @@
 
   var _require = require("prettier"),
     resolveConfig = _require.resolveConfig;
+  var getPrettierConfig = function getPrettierConfig(fileName) {
+    var options = {
+      useCache: true,
+      editorconfig: true
+    };
+    if (resolveConfig.sync) return resolveConfig.sync(fileName, options);
+    var resolveConfigSync = require("synckit").createSyncFn(require.resolve("./resolveConfigWorker.js"));
+    return resolveConfigSync(fileName, options);
+  };
   var ensureCompactObjects = {
     meta: {
       type: "problem",
@@ -2102,9 +2113,9 @@
       fixable: "whitespace"
     },
     create: function create(context) {
+      var prettierConfig = getPrettierConfig(context.getFilename());
       return {
         ObjectExpression: function ObjectExpression(node) {
-          var _resolveConfig$sync;
           if (isExcludedFile(EXCLUDED_FILES, context.getFilename())) return;
           if (!neetoCist.matches(OBJECT_EXPRESSION_PATTERN$1, node)) return;
           var sourceCode = context.getSourceCode();
@@ -2120,10 +2131,7 @@
           if (/\r|\n/.test(_fix)) return;
           var openingBraceColumn = node.loc.start.column;
           var closingBraceColumn = node.loc.end.column;
-          var printWidth = ((_resolveConfig$sync = resolveConfig.sync(context.getFilename(), {
-            useCache: true,
-            editorconfig: true
-          })) === null || _resolveConfig$sync === void 0 ? void 0 : _resolveConfig$sync.printWidth) || 80;
+          var printWidth = (prettierConfig === null || prettierConfig === void 0 ? void 0 : prettierConfig.printWidth) || 80;
           var countOfTokensAfterClosingBrace = sourceCode.lines[closingBraceLine - 1].slice(closingBraceColumn).length;
           var resultLength = openingBraceColumn + _fix.length + countOfTokensAfterClosingBrace;
           if (resultLength > printWidth - 10) return;
@@ -2352,6 +2360,36 @@
     }
   };
 
+  var USESTATE_WITHOUT_ARGUMENTS_PATTERN = {
+    callee: {
+      type: TYPES.IDENTIFIER,
+      name: "useState"
+    },
+    arguments: ramda.isEmpty
+  };
+
+  var ensureUseStateHasInitialValue = {
+    meta: {
+      type: "problem",
+      docs: {
+        url: "https://github.com/bigbinary/eslint-plugin-neeto/blob/main/docs/src/rules/ensure-usestate-has-initial-value.md",
+        description: "useState declarations should have an initial value."
+      }
+    },
+    create: function create(context) {
+      return {
+        CallExpression: function CallExpression(node) {
+          if (neetoCist.matches(USESTATE_WITHOUT_ARGUMENTS_PATTERN, node)) {
+            context.report({
+              node: node,
+              message: USESTATE_DECLARATIONS_SHOULD_HAVE_INITIAL_VALUE
+            });
+          }
+        }
+      };
+    }
+  };
+
   const isWindows = typeof process === 'object' &&
     process &&
     process.platform === 'win32';
@@ -10662,6 +10700,7 @@
       "move-spread-attributes-to-top-position": moveSpreadAttributesToTopPosition,
       "prefer-function-reference": preferFunctionReference,
       "jsx-prefer-guard-clause": jsxPreferGuardClause,
+      "ensure-usestate-has-initial-value": ensureUseStateHasInitialValue,
       "use-show-thumbs-up-toastr": useShowThumbsUpToastr
     },
     configs: {

package/dist/resolveConfigWorker.js

@@ -0,0 +1,8 @@
+const { runAsWorker } = require("synckit");
+
+runAsWorker(async (path, options) => {
+  const prettier = await import("prettier");
+  const config = await prettier.resolveConfig(path, options);
+
+  return config;
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbinary/eslint-plugin-neeto",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "main": "dist/index.js",
   "license": "UNLICENSED",
   "scripts": {
@@ -18,7 +18,8 @@
     ]
   },
   "files": [
-    "dist/index.js"
+    "dist/index.js",
+    "dist/resolveConfigWorker.js"
   ],
   "engines": {
     "node": ">=18.12",
@@ -76,7 +77,9 @@
     "rollup": "^2.75.7",
     "rollup-plugin-analyzer": "^4.0.0",
     "rollup-plugin-cleaner": "^1.0.0",
-    "rollup-plugin-peer-deps-external": "^2.2.4"
+    "rollup-plugin-copy": "^3.5.0",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "synckit": "^0.9.0"
   },
   "peerDependencies": {
     "@bigbinary/neeto-cist": "latest",