eslint-plugin-nima 1.2.3 → 1.2.5

package/README.md

@@ -12,12 +12,13 @@ It includes opinionated rules for naming, React, parameters, and restrictions on
 
 ## Table of Contents
 
+- [Table of Contents](#table-of-contents)
 - [Installation](#installation)
 - [Usage](#usage)
-  - [Recommended setup](#recommended-setup)
-  - [Custom setup](#custom-setup)
+    - [Recommended setup](#recommended-setup)
+    - [Custom setup](#custom-setup)
 - [Rules](#rules)
-- [Contributing](#contributing)
+- [Configurations](#configurations)
 - [License](#license)
 
 ---
@@ -52,8 +53,8 @@ Add the following to your `eslint.config.js`:
 import pluginNIMA from "eslint-plugin-nima";
 
 export default [
-  pluginNIMA.configs["flat/recommended"],
-  // Any other config...
+    pluginNIMA.configs["flat/recommended"],
+    // Any other config...
 ];
 ```
 
@@ -67,14 +68,14 @@ If you prefer to configure rules manually, load the plugin and specify only the
 import pluginNIMA from "eslint-plugin-nima";
 
 export default [
-  {
-    plugins: {
-      nima: pluginNIMA,
+    {
+        plugins: {
+            nima: pluginNIMA,
+        },
+        rules: {
+            "nima/restrict-console-methods": "error",
+        },
     },
-    rules: {
-      "nima/restrict-console-methods": "error",
-    },
-  },
 ];
 ```
 
@@ -84,13 +85,13 @@ You can also extend the recommended config and override specific rules:
 import pluginNIMA from "eslint-plugin-nima";
 
 export default [
-  {
-    ...pluginNIMA.configs["flat/recommended"],
-    rules: {
-      ...pluginNIMA.configs["flat/recommended"].rules,
-      "nima/restrict-console-methods": "off",
+    {
+        ...pluginNIMA.configs["flat/recommended"],
+        rules: {
+            ...pluginNIMA.configs["flat/recommended"].rules,
+            "nima/restrict-console-methods": "off",
+        },
     },
-  },
 ];
 ```
 
@@ -108,16 +109,18 @@ Before diving deep into what each rule does, I recommend reading the [Rule Overv
 
 The plugin currently provides these rules:
 
+- [boolean-naming-convention](documentation/rules/boolean-naming-convention.md)
 - [no-handler-suffix](documentation/rules/no-handler-suffix.md)
-- [restrict-console-methods](documentation/rules/restrict-console-methods.md)
+- [no-objects-in-deps](documentation/rules/no-objects-in-deps.md)
+- [params-naming-convention](documentation/rules/params-naming-convention.md)
+- [prefer-arrow-functions](documentation/rules/prefer-arrow-functions.md)
+- [prefer-void-for-optional-param](documentation/rules/prefer-void-for-optional-param.md)
 - [prefer-export-under-component](documentation/rules/prefer-export-under-component.md)
 - [prefer-react-fc](documentation/rules/prefer-react-fc.md)
-- [prefer-arrow-functions](documentation/rules/prefer-arrow-functions.md)
 - [prefer-react-with-hooks](documentation/rules/prefer-react-with-hooks.md)
+- [restrict-console-methods](documentation/rules/restrict-console-methods.md)
 - [restrict-function-usage](documentation/rules/restrict-function-usage.md)
-- [no-objects-in-deps](documentation/rules/no-objects-in-deps.md)
-- [params-naming-convention](documentation/rules/params-naming-convention.md)
-- [boolean-naming-convention](documentation/rules/boolean-naming-convention.md)
+- [restrict-imports](documentation/rules/restrict-imports.md)
 
 See the full [Rules overview](documentation/rules/index.md).
 

package/dist/constants/boolean-prefixes.js.map

@@ -1 +1 @@
-{"version":3,"file":"boolean-prefixes.js","sourceRoot":"","sources":["../../src/constants/boolean-prefixes.ts"],"names":[],"mappings":";;;AAAa,QAAA,gBAAgB,GAAG;IAC9B,IAAI;IACJ,KAAK;IACL,KAAK;IACL,QAAQ;IACR,MAAM;IACN,KAAK;IACL,MAAM;IACN,KAAK;IACL,IAAI;CACL,CAAC"}
+{"version":3,"file":"boolean-prefixes.js","sourceRoot":"","sources":["../../src/constants/boolean-prefixes.ts"],"names":[],"mappings":";;;AAAa,QAAA,gBAAgB,GAAG;IAC5B,IAAI;IACJ,KAAK;IACL,KAAK;IACL,QAAQ;IACR,MAAM;IACN,KAAK;IACL,MAAM;IACN,KAAK;IACL,IAAI;CACP,CAAC"}

package/dist/constants/consoles.js.map

@@ -1 +1 @@
-{"version":3,"file":"consoles.js","sourceRoot":"","sources":["../../src/constants/consoles.ts"],"names":[],"mappings":";;;AAAa,QAAA,QAAQ,GAAG,IAAI,GAAG,CAAC;IAC9B,QAAQ;IACR,OAAO;IACP,OAAO;IACP,YAAY;IACZ,OAAO;IACP,KAAK;IACL,QAAQ;IACR,OAAO;IACP,OAAO;IACP,UAAU;IACV,MAAM;IACN,KAAK;IACL,SAAS;IACT,YAAY;IACZ,OAAO;IACP,MAAM;IACN,SAAS;IACT,OAAO;IACP,MAAM;CACP,CAAC,CAAC"}
+{"version":3,"file":"consoles.js","sourceRoot":"","sources":["../../src/constants/consoles.ts"],"names":[],"mappings":";;;AAAa,QAAA,QAAQ,GAAG,IAAI,GAAG,CAAC;IAC5B,QAAQ;IACR,OAAO;IACP,OAAO;IACP,YAAY;IACZ,OAAO;IACP,KAAK;IACL,QAAQ;IACR,OAAO;IACP,OAAO;IACP,UAAU;IACV,MAAM;IACN,KAAK;IACL,SAAS;IACT,YAAY;IACZ,OAAO;IACP,MAAM;IACN,SAAS;IACT,OAAO;IACP,MAAM;CACT,CAAC,CAAC"}

package/dist/constants/hooks.js.map

@@ -1 +1 @@
-{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../src/constants/hooks.ts"],"names":[],"mappings":";;;AAAa,QAAA,WAAW,GAAG,IAAI,GAAG,CAAC;IACjC,KAAK;IACL,aAAa;IACb,YAAY;IACZ,eAAe;IACf,kBAAkB;IAClB,WAAW;IACX,OAAO;IACP,qBAAqB;IACrB,oBAAoB;IACpB,iBAAiB;IACjB,SAAS;IACT,YAAY;IACZ,QAAQ;IACR,UAAU;IACV,sBAAsB;IACtB,eAAe;CAChB,CAAC,CAAC;AAEU,QAAA,eAAe,GAAG,IAAI,GAAG,CAAC;IACrC,aAAa;IACb,WAAW;IACX,oBAAoB;IACpB,iBAAiB;IACjB,SAAS;CACV,CAAC,CAAC"}
+{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../src/constants/hooks.ts"],"names":[],"mappings":";;;AAAa,QAAA,WAAW,GAAG,IAAI,GAAG,CAAC;IAC/B,KAAK;IACL,aAAa;IACb,YAAY;IACZ,eAAe;IACf,kBAAkB;IAClB,WAAW;IACX,OAAO;IACP,qBAAqB;IACrB,oBAAoB;IACpB,iBAAiB;IACjB,SAAS;IACT,YAAY;IACZ,QAAQ;IACR,UAAU;IACV,sBAAsB;IACtB,eAAe;CAClB,CAAC,CAAC;AAEU,QAAA,eAAe,GAAG,IAAI,GAAG,CAAC;IACnC,aAAa;IACb,WAAW;IACX,oBAAoB;IACpB,iBAAiB;IACjB,SAAS;CACZ,CAAC,CAAC"}

package/dist/index.d.ts

@@ -1,37 +1,41 @@
 import type { RuleModule } from "@typescript-eslint/utils/ts-eslint";
 import type { ESLint, Linter } from "eslint";
+import { BooleanNamingConvention, NoHandlerSuffix, NoObjectsInDeps, ParamsNamingConvention, PreferArrowFunctions, PreferExportUnderComponent, PreferReactFc, PreferReactWithHooks, PreferVoidForOptionalParam, RestrictConsoleMethods, RestrictFunctionUsage, RestrictImports } from "./rules";
 declare const rules: {
-    "boolean-naming-convention": RuleModule<import("./models/boolean-naming-convention.model").Messages, import("./models/boolean-naming-convention.model").Options, {
+    "boolean-naming-convention": RuleModule<BooleanNamingConvention.Messages, import("./rules/boolean-naming-convention/config").Options, {
         recommended: boolean;
     }, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-    "restrict-function-usage": RuleModule<import("./models/restrict-function-usage.model").Messages, import("./models/restrict-function-usage.model").Options, {
+    "no-handler-suffix": RuleModule<NoHandlerSuffix.Messages, [], {
         recommended: boolean;
     }, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-    "no-handler-suffix": RuleModule<import("./models/no-handler-suffix.model").Messages, [], {
+    "no-objects-in-deps": RuleModule<NoObjectsInDeps.Messages, [], {
         recommended: boolean;
     }, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-    "no-objects-in-deps": RuleModule<import("./models/no-objects-in-deps.model").Messages, [], {
+    "params-naming-convention": RuleModule<ParamsNamingConvention.Messages, import("./rules/params-naming-convention/config").Options, {
         recommended: boolean;
     }, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-    "params-naming-convention": RuleModule<import("./models/params-naming-convention.model").Messages, import("./models/params-naming-convention.model").Options, {
+    "prefer-arrow-functions": RuleModule<PreferArrowFunctions.Messages, import("./rules/prefer-arrow-functions/config").Options, {
         recommended: boolean;
     }, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-    "prefer-arrow-functions": RuleModule<import("./models/prefer-arrow-functions.model").Messages, import("./models/prefer-arrow-functions.model").Options, {
+    "prefer-export-under-component": RuleModule<PreferExportUnderComponent.Messages, [], {
         recommended: boolean;
     }, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-    "prefer-export-under-component": RuleModule<import("./models/prefer-export-under-component.model").Messages, import("./models/prefer-export-under-component.model").Options, {
+    "prefer-react-fc": RuleModule<PreferReactFc.Messages, import("./rules/prefer-react-fc/config").Options, {
         recommended: boolean;
     }, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-    "prefer-react-fc": RuleModule<import("./models/prefer-react-fc.model").Messages, import("./models/prefer-react-fc.model").Options, {
+    "prefer-react-with-hooks": RuleModule<PreferReactWithHooks.Messages, [], {
         recommended: boolean;
     }, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-    "prefer-react-with-hooks": RuleModule<import("./models/prefer-react-with-hooks.model").Messages, [], {
+    "prefer-void-for-optional-param": RuleModule<PreferVoidForOptionalParam.Messages, [], {
         recommended: boolean;
     }, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-    "restrict-console-methods": RuleModule<import("./models/restrict-console-methods.model").Messages, import("./models/restrict-console-methods.model").Options, {
+    "restrict-console-methods": RuleModule<RestrictConsoleMethods.Messages, import("./rules/restrict-console-methods/config").Options, {
         recommended: boolean;
     }, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-    "restrict-imports": RuleModule<import("./models/restrict-imports.model").Messages, import("./models/restrict-imports.model").Options, {
+    "restrict-function-usage": RuleModule<RestrictFunctionUsage.Messages, import("./rules/restrict-function-usage/config").Options, {
+        recommended: boolean;
+    }, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+    "restrict-imports": RuleModule<RestrictImports.Messages, import("./rules/restrict-imports/config").Options, {
         recommended: boolean;
     }, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
 };
@@ -49,37 +53,40 @@ declare const plugin: {
         name: string;
     };
     rules: {
-        "boolean-naming-convention": RuleModule<import("./models/boolean-naming-convention.model").Messages, import("./models/boolean-naming-convention.model").Options, {
+        "boolean-naming-convention": RuleModule<BooleanNamingConvention.Messages, import("./rules/boolean-naming-convention/config").Options, {
+            recommended: boolean;
+        }, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+        "no-handler-suffix": RuleModule<NoHandlerSuffix.Messages, [], {
             recommended: boolean;
         }, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        "restrict-function-usage": RuleModule<import("./models/restrict-function-usage.model").Messages, import("./models/restrict-function-usage.model").Options, {
+        "no-objects-in-deps": RuleModule<NoObjectsInDeps.Messages, [], {
             recommended: boolean;
         }, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        "no-handler-suffix": RuleModule<import("./models/no-handler-suffix.model").Messages, [], {
+        "params-naming-convention": RuleModule<ParamsNamingConvention.Messages, import("./rules/params-naming-convention/config").Options, {
             recommended: boolean;
         }, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        "no-objects-in-deps": RuleModule<import("./models/no-objects-in-deps.model").Messages, [], {
+        "prefer-arrow-functions": RuleModule<PreferArrowFunctions.Messages, import("./rules/prefer-arrow-functions/config").Options, {
             recommended: boolean;
         }, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        "params-naming-convention": RuleModule<import("./models/params-naming-convention.model").Messages, import("./models/params-naming-convention.model").Options, {
+        "prefer-export-under-component": RuleModule<PreferExportUnderComponent.Messages, [], {
             recommended: boolean;
         }, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        "prefer-arrow-functions": RuleModule<import("./models/prefer-arrow-functions.model").Messages, import("./models/prefer-arrow-functions.model").Options, {
+        "prefer-react-fc": RuleModule<PreferReactFc.Messages, import("./rules/prefer-react-fc/config").Options, {
             recommended: boolean;
         }, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        "prefer-export-under-component": RuleModule<import("./models/prefer-export-under-component.model").Messages, import("./models/prefer-export-under-component.model").Options, {
+        "prefer-react-with-hooks": RuleModule<PreferReactWithHooks.Messages, [], {
             recommended: boolean;
         }, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        "prefer-react-fc": RuleModule<import("./models/prefer-react-fc.model").Messages, import("./models/prefer-react-fc.model").Options, {
+        "prefer-void-for-optional-param": RuleModule<PreferVoidForOptionalParam.Messages, [], {
             recommended: boolean;
         }, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        "prefer-react-with-hooks": RuleModule<import("./models/prefer-react-with-hooks.model").Messages, [], {
+        "restrict-console-methods": RuleModule<RestrictConsoleMethods.Messages, import("./rules/restrict-console-methods/config").Options, {
             recommended: boolean;
         }, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        "restrict-console-methods": RuleModule<import("./models/restrict-console-methods.model").Messages, import("./models/restrict-console-methods.model").Options, {
+        "restrict-function-usage": RuleModule<RestrictFunctionUsage.Messages, import("./rules/restrict-function-usage/config").Options, {
             recommended: boolean;
         }, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-        "restrict-imports": RuleModule<import("./models/restrict-imports.model").Messages, import("./models/restrict-imports.model").Options, {
+        "restrict-imports": RuleModule<RestrictImports.Messages, import("./rules/restrict-imports/config").Options, {
             recommended: boolean;
         }, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
     };

package/dist/index.js

@@ -1,60 +1,18 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-const BooleanNamingConvention = __importStar(require("./rules/boolean-naming-convention"));
-const NoHandlerSuffix = __importStar(require("./rules/no-handler-suffix"));
-const NoObjectsInDeps = __importStar(require("./rules/no-objects-in-deps"));
-const ParamsNamingConvention = __importStar(require("./rules/params-naming-convention"));
-const PreferArrowFunctions = __importStar(require("./rules/prefer-arrow-functions"));
-const PreferNamedExport = __importStar(require("./rules/prefer-export-under-component"));
-const PreferReactFc = __importStar(require("./rules/prefer-react-fc"));
-const PreferReactWithHooks = __importStar(require("./rules/prefer-react-with-hooks"));
-const RestrictConsoleMethods = __importStar(require("./rules/restrict-console-methods"));
-const ManageFunctions = __importStar(require("./rules/restrict-function-usage"));
-const RestrictImports = __importStar(require("./rules/restrict-imports"));
+const rules_1 = require("./rules");
 const rules = {
-    [BooleanNamingConvention.name]: BooleanNamingConvention.rule,
-    [ManageFunctions.name]: ManageFunctions.rule,
-    [NoHandlerSuffix.name]: NoHandlerSuffix.rule,
-    [NoObjectsInDeps.name]: NoObjectsInDeps.rule,
-    [ParamsNamingConvention.name]: ParamsNamingConvention.rule,
-    [PreferArrowFunctions.name]: PreferArrowFunctions.rule,
-    [PreferNamedExport.name]: PreferNamedExport.rule,
-    [PreferReactFc.name]: PreferReactFc.rule,
-    [PreferReactWithHooks.name]: PreferReactWithHooks.rule,
-    [RestrictConsoleMethods.name]: RestrictConsoleMethods.rule,
-    [RestrictImports.name]: RestrictImports.rule,
+    [rules_1.BooleanNamingConvention.name]: rules_1.BooleanNamingConvention.rule,
+    [rules_1.NoHandlerSuffix.name]: rules_1.NoHandlerSuffix.rule,
+    [rules_1.NoObjectsInDeps.name]: rules_1.NoObjectsInDeps.rule,
+    [rules_1.ParamsNamingConvention.name]: rules_1.ParamsNamingConvention.rule,
+    [rules_1.PreferArrowFunctions.name]: rules_1.PreferArrowFunctions.rule,
+    [rules_1.PreferExportUnderComponent.name]: rules_1.PreferExportUnderComponent.rule,
+    [rules_1.PreferReactFc.name]: rules_1.PreferReactFc.rule,
+    [rules_1.PreferReactWithHooks.name]: rules_1.PreferReactWithHooks.rule,
+    [rules_1.PreferVoidForOptionalParam.name]: rules_1.PreferVoidForOptionalParam.rule,
+    [rules_1.RestrictConsoleMethods.name]: rules_1.RestrictConsoleMethods.rule,
+    [rules_1.RestrictFunctionUsage.name]: rules_1.RestrictFunctionUsage.rule,
+    [rules_1.RestrictImports.name]: rules_1.RestrictImports.rule,
 };
 const plugin = {
     configs: {},

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAMA,0FAA4E;AAC5E,0EAA4D;AAC5D,2EAA6D;AAC7D,wFAA0E;AAC1E,oFAAsE;AACtE,wFAA0E;AAC1E,sEAAwD;AACxD,qFAAuE;AACvE,wFAA0E;AAC1E,gFAAkE;AAClE,yEAA2D;AAE3D,MAAM,KAAK,GAAG;IACZ,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE,uBAAuB,CAAC,IAAI;IAC5D,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,eAAe,CAAC,IAAI;IAC5C,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,eAAe,CAAC,IAAI;IAC5C,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,eAAe,CAAC,IAAI;IAC5C,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAE,sBAAsB,CAAC,IAAI;IAC1D,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,oBAAoB,CAAC,IAAI;IACtD,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,iBAAiB,CAAC,IAAI;IAChD,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC,IAAI;IACxC,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,oBAAoB,CAAC,IAAI;IACtD,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAE,sBAAsB,CAAC,IAAI;IAC1D,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,eAAe,CAAC,IAAI;CAC7C,CAAC;AAYF,MAAM,MAAM,GAAG;IACb,OAAO,EAAE,EAAuB;IAEhC,IAAI,EAAE;QACJ,IAAI,EAAE,oBAAoB;KAC3B;IAED,KAAK;CACN,CAAC;AAEF,MAAM,WAAW,GAEb;IACF,wBAAwB,EAAE,OAAO;IACjC,oCAAoC,EAAE,OAAO;IAC7C,sBAAsB,EAAE,MAAM;IAC9B,+BAA+B,EAAE,OAAO;CACzC,CAAC;AAEF,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE;IAC5B,kBAAkB,EAAE;QAClB,OAAO,EAAE;YACP,IAAI,EAAE,MAAM;SACb;QACD,KAAK,EAAE,WAAW;KACnB;IACD,WAAW,EAAE;QACX,OAAO,EAAE,CAAC,MAAM,CAAC;QACjB,KAAK,EAAE,WAAW;KACnB;CACF,CAAC,CAAC;AAEH,iBAAS,MAAM,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAMA,mCAaiB;AAEjB,MAAM,KAAK,GAAG;IACV,CAAC,+BAAuB,CAAC,IAAI,CAAC,EAAE,+BAAuB,CAAC,IAAI;IAC5D,CAAC,uBAAe,CAAC,IAAI,CAAC,EAAE,uBAAe,CAAC,IAAI;IAC5C,CAAC,uBAAe,CAAC,IAAI,CAAC,EAAE,uBAAe,CAAC,IAAI;IAC5C,CAAC,8BAAsB,CAAC,IAAI,CAAC,EAAE,8BAAsB,CAAC,IAAI;IAC1D,CAAC,4BAAoB,CAAC,IAAI,CAAC,EAAE,4BAAoB,CAAC,IAAI;IACtD,CAAC,kCAA0B,CAAC,IAAI,CAAC,EAAE,kCAA0B,CAAC,IAAI;IAClE,CAAC,qBAAa,CAAC,IAAI,CAAC,EAAE,qBAAa,CAAC,IAAI;IACxC,CAAC,4BAAoB,CAAC,IAAI,CAAC,EAAE,4BAAoB,CAAC,IAAI;IACtD,CAAC,kCAA0B,CAAC,IAAI,CAAC,EAAE,kCAA0B,CAAC,IAAI;IAClE,CAAC,8BAAsB,CAAC,IAAI,CAAC,EAAE,8BAAsB,CAAC,IAAI;IAC1D,CAAC,6BAAqB,CAAC,IAAI,CAAC,EAAE,6BAAqB,CAAC,IAAI;IACxD,CAAC,uBAAe,CAAC,IAAI,CAAC,EAAE,uBAAe,CAAC,IAAI;CAC/C,CAAC;AAYF,MAAM,MAAM,GAAG;IACX,OAAO,EAAE,EAAuB;IAEhC,IAAI,EAAE;QACF,IAAI,EAAE,oBAAoB;KAC7B;IAED,KAAK;CACR,CAAC;AAEF,MAAM,WAAW,GAEb;IACA,wBAAwB,EAAE,OAAO;IACjC,oCAAoC,EAAE,OAAO;IAC7C,sBAAsB,EAAE,MAAM;IAC9B,+BAA+B,EAAE,OAAO;CAC3C,CAAC;AAEF,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE;IAC1B,kBAAkB,EAAE;QAChB,OAAO,EAAE;YACL,IAAI,EAAE,MAAM;SACf;QACD,KAAK,EAAE,WAAW;KACrB;IACD,WAAW,EAAE;QACT,OAAO,EAAE,CAAC,MAAM,CAAC;QACjB,KAAK,EAAE,WAAW;KACrB;CACJ,CAAC,CAAC;AAEH,iBAAS,MAAM,CAAC"}

package/dist/{models/boolean-naming-convention.model.d.ts → rules/boolean-naming-convention/config.d.ts}

@@ -1,3 +1,5 @@
+import { RuleModule } from "@typescript-eslint/utils/ts-eslint";
+export declare const name = "boolean-naming-convention";
 export declare const enum Messages {
     BAD_FUNCTION_BOOLEAN_PREFIX = "BAD_FUNCTION_BOOLEAN_PREFIX",
     BAD_PARAMETER_BOOLEAN_PREFIX = "BAD_PARAMETER_BOOLEAN_PREFIX",
@@ -11,5 +13,14 @@ export type Options = [
         checkParameters: boolean;
         checkProperties: boolean;
         checkVariables: boolean;
+        ignore: string;
     }>
 ];
+type ExtendedPluginProperties = {
+    recommended: boolean;
+};
+export declare const config: {
+    docs: ExtendedPluginProperties & RuleModule<Messages, Options>["meta"]["docs"];
+} & Omit<RuleModule<Messages, Options>["meta"], "defaultOptions">;
+export declare const defaultOptions: Options;
+export {};

package/dist/rules/boolean-naming-convention/config.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultOptions = exports.config = exports.Messages = exports.name = void 0;
+const boolean_prefixes_1 = require("../../constants/boolean-prefixes");
+exports.name = "boolean-naming-convention";
+var Messages;
+(function (Messages) {
+    Messages["BAD_FUNCTION_BOOLEAN_PREFIX"] = "BAD_FUNCTION_BOOLEAN_PREFIX";
+    Messages["BAD_PARAMETER_BOOLEAN_PREFIX"] = "BAD_PARAMETER_BOOLEAN_PREFIX";
+    Messages["BAD_PROPERTY_BOOLEAN_PREFIX"] = "BAD_PROPERTY_BOOLEAN_PREFIX";
+    Messages["BAD_VARIABLE_BOOLEAN_PREFIX"] = "BAD_VARIABLE_BOOLEAN_PREFIX";
+})(Messages || (exports.Messages = Messages = {}));
+exports.config = {
+    docs: {
+        description: "Enforces boolean variables to use appropriate prefixes (is, has, can, should, etc.)",
+        recommended: false,
+        url: "https://github.com/NIMA-Enterprises/eslint-plugin-nima/blob/main/documentation/rules/boolean-naming-convention.md",
+    },
+    messages: {
+        [Messages.BAD_FUNCTION_BOOLEAN_PREFIX]: "NIMA: Function '{{name}}' returns a boolean, use a prefix like {{suggestion}}",
+        [Messages.BAD_PARAMETER_BOOLEAN_PREFIX]: "NIMA: Boolean parameter '{{name}}' should use a prefix like {{suggestion}}",
+        [Messages.BAD_PROPERTY_BOOLEAN_PREFIX]: "NIMA: Boolean property '{{name}}' should use a prefix like {{suggestion}}",
+        [Messages.BAD_VARIABLE_BOOLEAN_PREFIX]: "NIMA: Boolean variable '{{name}}' should use a prefix like {{suggestion}}",
+    },
+    schema: [
+        {
+            additionalProperties: false,
+            properties: {
+                allowedPrefixes: {
+                    description: "Allowed boolean name prefixes (is, has, can, etc.)",
+                    items: { type: "string" },
+                    type: "array",
+                },
+                checkFunctions: {
+                    description: "Check top-level functions",
+                    type: "boolean",
+                },
+                checkParameters: {
+                    description: "Check function parameters",
+                    type: "boolean",
+                },
+                checkProperties: {
+                    description: "Check object properties",
+                    type: "boolean",
+                },
+                checkVariables: {
+                    description: "Check variable declarators",
+                    type: "boolean",
+                },
+                ignore: {
+                    description: "Regex string to ignore certain names",
+                    type: "string",
+                },
+            },
+            type: "object",
+        },
+    ],
+    type: "suggestion",
+};
+exports.defaultOptions = [
+    {
+        allowedPrefixes: boolean_prefixes_1.DEFAULT_PREFIXES,
+        checkFunctions: true,
+        checkParameters: true,
+        checkProperties: true,
+        checkVariables: true,
+        ignore: "filter",
+    },
+];
+//# sourceMappingURL=config.js.map

package/dist/rules/boolean-naming-convention/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/rules/boolean-naming-convention/config.ts"],"names":[],"mappings":";;;AAAA,kEAA+D;AAGlD,QAAA,IAAI,GAAG,2BAA2B,CAAC;AAEhD,IAAkB,QAKjB;AALD,WAAkB,QAAQ;IACtB,uEAA2D,CAAA;IAC3D,yEAA6D,CAAA;IAC7D,uEAA2D,CAAA;IAC3D,uEAA2D,CAAA;AAC/D,CAAC,EALiB,QAAQ,wBAAR,QAAQ,QAKzB;AAiBY,QAAA,MAAM,GAGiD;IAChE,IAAI,EAAE;QACF,WAAW,EACP,qFAAqF;QACzF,WAAW,EAAE,KAAK;QAClB,GAAG,EAAE,mHAAmH;KAC3H;IACD,QAAQ,EAAE;QACN,CAAC,QAAQ,CAAC,2BAA2B,CAAC,EAClC,+EAA+E;QACnF,CAAC,QAAQ,CAAC,4BAA4B,CAAC,EACnC,4EAA4E;QAChF,CAAC,QAAQ,CAAC,2BAA2B,CAAC,EAClC,2EAA2E;QAC/E,CAAC,QAAQ,CAAC,2BAA2B,CAAC,EAClC,2EAA2E;KAClF;IACD,MAAM,EAAE;QACJ;YACI,oBAAoB,EAAE,KAAK;YAC3B,UAAU,EAAE;gBACR,eAAe,EAAE;oBACb,WAAW,EACP,oDAAoD;oBACxD,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACzB,IAAI,EAAE,OAAO;iBAChB;gBACD,cAAc,EAAE;oBACZ,WAAW,EAAE,2BAA2B;oBACxC,IAAI,EAAE,SAAS;iBAClB;gBACD,eAAe,EAAE;oBACb,WAAW,EAAE,2BAA2B;oBACxC,IAAI,EAAE,SAAS;iBAClB;gBACD,eAAe,EAAE;oBACb,WAAW,EAAE,yBAAyB;oBACtC,IAAI,EAAE,SAAS;iBAClB;gBACD,cAAc,EAAE;oBACZ,WAAW,EAAE,4BAA4B;oBACzC,IAAI,EAAE,SAAS;iBAClB;gBACD,MAAM,EAAE;oBACJ,WAAW,EAAE,sCAAsC;oBACnD,IAAI,EAAE,QAAQ;iBACjB;aACJ;YACD,IAAI,EAAE,QAAQ;SACjB;KACJ;IACD,IAAI,EAAE,YAAY;CACrB,CAAC;AACW,QAAA,cAAc,GAAY;IACnC;QACI,eAAe,EAAE,mCAAgB;QACjC,cAAc,EAAE,IAAI;QACpB,eAAe,EAAE,IAAI;QACrB,eAAe,EAAE,IAAI;QACrB,cAAc,EAAE,IAAI;QACpB,MAAM,EAAE,QAAQ;KACnB;CACJ,CAAC"}

package/dist/rules/boolean-naming-convention/create.d.ts

@@ -0,0 +1,11 @@
+import { type TSESTree } from "@typescript-eslint/utils";
+import { RuleContext } from "@typescript-eslint/utils/ts-eslint";
+import { Messages, type Options } from "./config";
+export declare const create: (context: RuleContext<Messages, Options>, [options]: readonly Options[number][]) => {
+    ArrowFunctionExpression: (node: TSESTree.ArrowFunctionExpression) => void;
+    FunctionDeclaration: (node: TSESTree.FunctionDeclaration) => void;
+    FunctionExpression: (node: TSESTree.FunctionExpression) => void;
+    ObjectExpression: (node: TSESTree.ObjectExpression) => void;
+    Property: (node: TSESTree.Property) => void;
+    VariableDeclarator: (node: TSESTree.VariableDeclarator) => void;
+};