eslint-plugin-func-params-args 4.0.2 → 5.0.0

package/README.md

@@ -4,7 +4,7 @@ Limit the number of function parameters and arguments with ease and flexibility!
 
 This plugin intends to give you control over how many parameters are used in function definitions (declarations), function expressions, arrow function expressions, and TypeScript function type annotations. In addition to this, you can also set limits on how many arguments can be used when calling functions, where you can set a global limit, and have even finer control by providing limits for specific function calls (set by configuring/providing the name of a function).
 
-[![Travis (.com) branch](https://img.shields.io/travis/com/abdusabri/eslint-plugin-func-params-args/master)](https://app.travis-ci.com/github/abdusabri/eslint-plugin-func-params-args) [![Coveralls github branch](https://img.shields.io/coveralls/github/abdusabri/eslint-plugin-func-params-args/master?logo=coveralls&style=flat-square)](https://coveralls.io/github/abdusabri/eslint-plugin-func-params-args) [![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com)
+[![GitHub Actions Status](https://img.shields.io/github/actions/workflow/status/abdusabri/eslint-plugin-func-params-args/nodejs.yml?branch=master)](https://github.com/abdusabri/eslint-plugin-func-params-args/actions) [![Coveralls github branch](https://img.shields.io/coveralls/github/abdusabri/eslint-plugin-func-params-args/master?logo=coveralls&style=flat-square)](https://coveralls.io/github/abdusabri/eslint-plugin-func-params-args) [![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com)
 
 ## Table of contents
 
@@ -53,6 +53,8 @@ npm install eslint-plugin-func-params-args --save-dev
 
 ## General usage notes
 
+### ESLint v8 (eslintrc)
+
 Add `func-params-args` to the plugins section of your `.eslintrc.json` configuration file. You can omit the `eslint-plugin-` prefix:
 
 ```json
@@ -96,6 +98,54 @@ rules:
       '$emit': 2
 ```
 
+### ESLint v9 (flat config)
+
+For ESLint v9 with flat config (`eslint.config.js` or `eslint.config.mjs`), import the plugin and configure it as follows:
+
+```js
+import funcParamsArgs from 'eslint-plugin-func-params-args';
+
+export default [
+  {
+    plugins: {
+      'func-params-args': funcParamsArgs,
+    },
+    rules: {
+      'func-params-args/func-args': [
+        'warn',
+        {
+          global: 3,
+          $emit: 2,
+        },
+      ],
+    },
+  },
+];
+```
+
+Or using CommonJS (`eslint.config.cjs`):
+
+```js
+const funcParamsArgs = require('eslint-plugin-func-params-args');
+
+module.exports = [
+  {
+    plugins: {
+      'func-params-args': funcParamsArgs,
+    },
+    rules: {
+      'func-params-args/func-args': [
+        'warn',
+        {
+          global: 3,
+          $emit: 2,
+        },
+      ],
+    },
+  },
+];
+```
+
 As shown in the example above, the configuration approach for this plugin's rules uses a simple object structure (no arrays or nested objects), where keys like `$emit` are the options, and the value of a given key is the limit (like `2`). So, in the example above, it means that any calls to `$emit` function should have no more than `2` arguments, and the global limit for any other function call is `3`.
 
 ### No defaults
@@ -106,6 +156,8 @@ By design, this plugin's rules don't have pre-set defaults. So, you've to config
 
 ESLint's eco-system is full of parsers and plugins taking care of non-JavaScript files, like TypeScript and JSX for example. This plugin doesn't provide its own parser (nor does it have a custom AST parsing logic). So, handling non-JS files depends on your existing ESLint setup.
 
+#### ESLint v8 (eslintrc)
+
 As an example, to use this plugin in TS files, you may configure parsing options in your `.eslintrc` file as follows:
 
 If you don't have any existing parsers (or other plugins that are already taking care of handling TS files)
@@ -127,6 +179,32 @@ Or you may override only the parsing of TS files if you've other parsers or plug
 
 In both examples above, you would need to install `@typescript-eslint/parser` from npm.
 
+#### ESLint v9 (flat config)
+
+For ESLint v9 with flat config, configure the parser in `languageOptions`:
+
+```js
+import funcParamsArgs from 'eslint-plugin-func-params-args';
+import tsParser from '@typescript-eslint/parser';
+
+export default [
+  {
+    files: ['**/*.ts', '**/*.tsx'],
+    languageOptions: {
+      parser: tsParser,
+    },
+    plugins: {
+      'func-params-args': funcParamsArgs,
+    },
+    rules: {
+      'func-params-args/func-params': ['warn', { global: 3 }],
+    },
+  },
+];
+```
+
+You would need to install `@typescript-eslint/parser` from npm.
+
 ## Available rules
 
 - [enforce the number of parameters used in a function definition or expression (func-params)](./docs/rules/func-params.md)

package/dist/index.js

@@ -1 +1 @@
-"use strict";var requireIndex=require("requireindex");module.exports.rules=requireIndex(__dirname+"/rules");
+"use strict";var requireIndex=require("requireindex"),pkg=require("../package.json"),plugin={meta:{name:pkg.name,version:pkg.version},rules:requireIndex(__dirname+"/rules")};module.exports=plugin;

package/dist/rules/func-params.js

@@ -1 +1 @@
-"use strict";const{BASE_URL,isOptionConfigured}=require("../utils"),utils=require("eslint-utils");function mapTypeToConfigKey(a){return"FunctionDeclaration"===a?"funcDefinition":"ArrowFunctionExpression"===a?"arrowFuncExpression":"FunctionExpression"===a?"funcExpression":"TSFunctionType"===a||"TSMethodSignature"===a?"funcTypeAnnotation":void 0}function getFunctionNameWithKind(a){return"TSFunctionType"===a.type?"TSTypeAliasDeclaration"===a.parent?.type?`function '${a.parent.id.name}'`:"TSTypeAnnotation"===a.parent?.type&&"Identifier"===a.parent.parent?.type?`function '${a.parent.parent.name}'`:`function '${a.parent?.parent?.key?.name}'`:"TSMethodSignature"===a.type?`function '${a.key?.name}'`:utils.getFunctionNameWithKind(a)}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:"{{name}} 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,name:getFunctionNameWithKind(a)})}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,TSMethodSignature:d}}};
+"use strict";const{BASE_URL,isOptionConfigured}=require("../utils"),utils=require("@eslint-community/eslint-utils");function mapTypeToConfigKey(a){return"FunctionDeclaration"===a?"funcDefinition":"ArrowFunctionExpression"===a?"arrowFuncExpression":"FunctionExpression"===a?"funcExpression":"TSFunctionType"===a||"TSMethodSignature"===a?"funcTypeAnnotation":void 0}function getFunctionNameWithKind(a){return"TSFunctionType"===a.type?"TSTypeAliasDeclaration"===a.parent?.type?`function '${a.parent.id.name}'`:"TSTypeAnnotation"===a.parent?.type&&"Identifier"===a.parent.parent?.type?`function '${a.parent.parent.name}'`:`function '${a.parent?.parent?.key?.name}'`:"TSMethodSignature"===a.type?`function '${a.key?.name}'`:utils.getFunctionNameWithKind(a)}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:"{{name}} 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,name:getFunctionNameWithKind(a)})}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,TSMethodSignature:d}}};

package/docs/rules/func-args.md

@@ -24,6 +24,8 @@ If you want to disable this rule (removing all restrictions) for any of the opti
 
 With a config like:
 
+ESLint v8 (eslintrc):
+
 ```json
 {
   "rules": {
@@ -39,6 +41,30 @@ With a config like:
 }
 ```
 
+ESLint v9 (flat config):
+
+```js
+import funcParamsArgs from 'eslint-plugin-func-params-args';
+
+export default [
+  {
+    plugins: {
+      'func-params-args': funcParamsArgs,
+    },
+    rules: {
+      'func-params-args/func-args': [
+        'warn',
+        {
+          global: 3,
+          bar: 2,
+          baz: 1,
+        },
+      ],
+    },
+  },
+];
+```
+
 Examples of **incorrect** code for this rule:
 
 ```js
@@ -77,6 +103,8 @@ b.baz('arg1');
 
 With a config like:
 
+ESLint v8 (eslintrc):
+
 ```json
 {
   "rules": {
@@ -90,6 +118,28 @@ With a config like:
 }
 ```
 
+ESLint v9 (flat config):
+
+```js
+import funcParamsArgs from 'eslint-plugin-func-params-args';
+
+export default [
+  {
+    plugins: {
+      'func-params-args': funcParamsArgs,
+    },
+    rules: {
+      'func-params-args/func-args': [
+        'warn',
+        {
+          foo: 2,
+        },
+      ],
+    },
+  },
+];
+```
+
 Examples of **incorrect** code for this rule:
 
 ```js

package/docs/rules/func-params.md

@@ -37,6 +37,8 @@ If you want to disable this rule (removing all restrictions) for any of the opti
 
 With a config like:
 
+ESLint v8 (eslintrc):
+
 ```json
 {
   "rules": {
@@ -51,6 +53,29 @@ With a config like:
 }
 ```
 
+ESLint v9 (flat config):
+
+```js
+import funcParamsArgs from 'eslint-plugin-func-params-args';
+
+export default [
+  {
+    plugins: {
+      'func-params-args': funcParamsArgs,
+    },
+    rules: {
+      'func-params-args/func-params': [
+        'warn',
+        {
+          global: 3,
+          arrowFuncExpression: 4,
+        },
+      ],
+    },
+  },
+];
+```
+
 Examples of **incorrect** code for this rule:
 
 ```ts
@@ -140,6 +165,8 @@ type onBarFn = (param1: number, param2: number, param3: number) => void;
 
 With a config like:
 
+ESLint v8 (eslintrc):
+
 ```json
 {
   "rules": {
@@ -154,6 +181,29 @@ With a config like:
 }
 ```
 
+ESLint v9 (flat config):
+
+```js
+import funcParamsArgs from 'eslint-plugin-func-params-args';
+
+export default [
+  {
+    plugins: {
+      'func-params-args': funcParamsArgs,
+    },
+    rules: {
+      'func-params-args/func-params': [
+        'warn',
+        {
+          funcDefinition: 1,
+          funcExpression: 2,
+        },
+      ],
+    },
+  },
+];
+```
+
 Examples of **incorrect** code for this rule:
 
 ```js

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-func-params-args",
-  "version": "4.0.2",
+  "version": "5.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": ">=16"
+    "node": ">=18.18.0"
   },
   "main": "dist/index.js",
   "scripts": {
@@ -38,17 +38,17 @@
     "build": "rimraf dist && minify lib -d dist"
   },
   "dependencies": {
-    "requireindex": "~1.2.0",
-    "eslint-utils": "^3.0.0"
+    "@eslint-community/eslint-utils": "^4.4.0",
+    "requireindex": "~1.2.0"
   },
   "peerDependencies": {
-    "eslint": "^6 || ^7.1.0 || ^8.0.0"
+    "eslint": "^8.0.0 || ^9.0.0"
   },
   "devDependencies": {
     "@typescript-eslint/parser": "^8.0.0",
     "babel-minify": "^0.5.1",
     "coveralls": "^3.1.0",
-    "eslint": "^8.2.0",
+    "eslint": "^8.57.1",
     "husky": "^9.0.0",
     "lint-staged": "^16.0.0",
     "mocha": "^11.0.0",