eslint-plugin-func-params-args 1.0.6 → 2.0.0

package/dist/rules/func-params.js

@@ -1 +1 @@
-'use strict';const{BASE_URL,isOptionConfigured}=require("../utils");function mapTypeToConfigKey(a){return"FunctionDeclaration"===a?"funcDefinition":"ArrowFunctionExpression"===a?"arrowFuncExpression":"FunctionExpression"===a?"funcExpression":void 0}module.exports={meta:{type:"problem",docs:{description:"enforce the number of parameters used in a function definition or expression",url:BASE_URL+"func-params.md"},schema:[{type:"object",properties:{global:{type:"integer",minimum:-1},funcDefinition:{type:"integer",minimum:-1},funcExpression:{type:"integer",minimum:-1},arrowFuncExpression:{type:"integer",minimum:-1}},additionalProperties:!1}],messages:{exceed:"function has too many parameters ({{count}}). Maximum allowed is ({{max}})."}},create(a){function b(b,c){a.report({node:b,messageId:"exceed",data:c})}function c(a,c){0<=c&&a.params.length>c&&b(a,{count:a.params.length,max:c})}function d(a){const b=mapTypeToConfigKey(a.type);let d=-1;isOptionConfigured(e,b)?d=e[b]:isOptionConfigured(e,"global")&&(d=e.global),c(a,d)}const e=a.options[0]||{};return{FunctionDeclaration:d,ArrowFunctionExpression:d,FunctionExpression:d}}};
+'use strict';const{BASE_URL,isOptionConfigured}=require("../utils");function mapTypeToConfigKey(a){return"FunctionDeclaration"===a?"funcDefinition":"ArrowFunctionExpression"===a?"arrowFuncExpression":"FunctionExpression"===a?"funcExpression":"TSFunctionType"===a?"funcTypeAnnotation":void 0}module.exports={meta:{type:"problem",docs:{description:"enforce the number of parameters used in a function definition or expression",url:BASE_URL+"func-params.md"},schema:[{type:"object",properties:{global:{type:"integer",minimum:-1},funcDefinition:{type:"integer",minimum:-1},funcExpression:{type:"integer",minimum:-1},arrowFuncExpression:{type:"integer",minimum:-1},funcTypeAnnotation:{type:"integer",minimum:-1}},additionalProperties:!1}],messages:{exceed:"function has too many parameters ({{count}}). Maximum allowed is ({{max}})."}},create(a){function b(b,c){a.report({node:b,messageId:"exceed",data:c})}function c(a,c){0<=c&&a.params.length>c&&b(a,{count:a.params.length,max:c})}function d(a){const b=mapTypeToConfigKey(a.type);let d=-1;isOptionConfigured(e,b)?d=e[b]:isOptionConfigured(e,"global")&&(d=e.global),c(a,d)}const e=a.options[0]||{};return{FunctionDeclaration:d,ArrowFunctionExpression:d,FunctionExpression:d,TSFunctionType:d}}};

package/docs/rules/func-params.md

@@ -18,6 +18,8 @@ Here are the available options for this rule:
 
 - `arrowFuncExpression`: accepts an integer indicating the max number of parameters used in an arrow function expression. This overrides the global limit
 
+- `funcTypeAnnotation`: accepts an integer indicating the max number of parameters used in a TypeScript function type annotation. This overrides the global limit
+
 If you have a need to set the value of an option to `0`, it is a valid limit that's supported by this rule.
 
 If you want to disable this rule (removing all restrictions) for any of the options, you can set its value to `-1`. For example, setting an option like `"arrowFuncExpression": -1` in the config, allows you to use arrow functions with any number of parameters (basically from 0 to an unlimited number of parameters). This overrides the global limit.
@@ -44,7 +46,7 @@ With a config like:
 
 Examples of **incorrect** code for this rule:
 
-```js
+```ts
 function foo(param1, param2, param3, param4) {}
 
 a = function (param1, param2, param3, param4) {};
@@ -52,11 +54,29 @@ a = function (param1, param2, param3, param4) {};
 b = (param1, param2, param3, param4, param5) => {};
 
 c.reduce((param1, param2, param3, param4, param5) => {});
+
+interface IFoo {
+  onBar: (
+    param1: string,
+    param2: string,
+    param3: string,
+    param4: string
+  ) => void;
+}
+
+type FooType = {
+  onBar: (
+    param1: number,
+    param2: number,
+    param3: number,
+    param4: number
+  ) => void;
+};
 ```
 
 Examples of **correct** code for this rule:
 
-```js
+```ts
 function foo(param1, param2, param3) {}
 
 a = function (param1, param2, param3) {};
@@ -72,6 +92,14 @@ a = function (param1, param2) {};
 b = () => {};
 
 c.reduce((param1, param2, param3) => {});
+
+interface IFoo {
+  onBar: (param1: string, param2: string, param3: string) => void;
+}
+
+type FooType = {
+  onBar: (param1: number, param2: number, param3: number) => void;
+};
 ```
 
 #### Example (B)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-func-params-args",
-  "version": "1.0.6",
+  "version": "2.0.0",
   "description": "Limit the number of function parameters and arguments with ease and flexibility",
   "author": "Abdulrahman (Abdu) Assabri <abdusabri@abdusabri.com>",
   "keywords": [
@@ -24,7 +24,7 @@
   },
   "license": "MIT",
   "engines": {
-    "node": ">=10"
+    "node": ">=12"
   },
   "main": "dist/index.js",
   "scripts": {
@@ -41,18 +41,20 @@
     "requireindex": "~1.2.0"
   },
   "peerDependencies": {
-    "eslint": "^4 || ^5 || ^6 || ^7.1.0"
+    "eslint": "^4 || ^5 || ^6 || ^7.1.0 || ^8.0.0"
   },
   "devDependencies": {
+    "@typescript-eslint/parser": "^5.4.0",
     "babel-minify": "^0.5.1",
     "coveralls": "^3.1.0",
-    "eslint": "^7.25.0",
-    "husky": "^6.0.0",
-    "lint-staged": "^11.0.0",
-    "mocha": "^8.3.2",
+    "eslint": "^8.2.0",
+    "husky": "^7.0.1",
+    "lint-staged": "^12.1.2",
+    "mocha": "^9.0.2",
     "nyc": "^15.1.0",
     "prettier": "^2.2.1",
-    "rimraf": "^3.0.2"
+    "rimraf": "^3.0.2",
+    "typescript": "^4.3.4"
   },
   "files": [
     "*.md",