eslint-plugin-func-params-args 3.0.0 → 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +18 -25
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -2,35 +2,28 @@
2
2
 
3
3
  Limit the number of function parameters and arguments with ease and flexibility!
4
4
 
5
- This plugin intends to give you control over how many parameters are used in function definitions (declarations), function expressions, and arrow function expressions. 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).
5
+ 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).
6
6
 
7
7
  [![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) ![Depfu](https://img.shields.io/depfu/abdusabri/eslint-plugin-func-params-args?style=flat-square)
8
8
 
9
9
  ## Table of contents
10
10
 
11
- - [Why](#why)
12
-
13
- - [Installation](#installation)
14
-
15
- - [General usage notes](#general-usage-notes)
16
-
17
- - [No defaults](#no-defaults)
18
-
19
- - [Non-JavaScript files](#non-javascript-files)
20
-
21
- - [Available rules](#available-rules)
22
-
23
- - [What is next](#what-is-next)
24
-
25
- - [Contributing](#contributing)
26
-
27
- - [General guidelines](#general-guidelines)
28
-
29
- - [Development guidelines](#general-guidelines)
30
-
31
- - [Code of conduct](#code-of-conduct)
32
-
33
- - [Inspiration and credits](#Inspiration-and-credits)
11
+ - [eslint-plugin-func-params-args](#eslint-plugin-func-params-args)
12
+ - [Table of contents](#table-of-contents)
13
+ - [Why](#why)
14
+ - [Installation](#installation)
15
+ - [General usage notes](#general-usage-notes)
16
+ - [No defaults](#no-defaults)
17
+ - [Non-JavaScript files](#non-javascript-files)
18
+ - [Available rules](#available-rules)
19
+ - [What is next](#what-is-next)
20
+ - [Contributing](#contributing)
21
+ - [General guidelines](#general-guidelines)
22
+ - [Documentation notes](#documentation-notes)
23
+ - [Development guidelines](#development-guidelines)
24
+ - [Development notes](#development-notes)
25
+ - [Code of conduct](#code-of-conduct)
26
+ - [Inspiration and credits](#inspiration-and-credits)
34
27
 
35
28
  ## Why
36
29
 
@@ -148,7 +141,7 @@ In general, all feedback is welcome, and I would love to get more ideas and cont
148
141
 
149
142
  - Add more examples on how to handle non-JS files, like `.vue` files for instance
150
143
 
151
- - Currently, in `func-params` rule, when there is an error reported, in addition to the code location (file and line number), an error message like `function has too many parameters (3). Maximum allowed is (2).` is reported. An improvement would be to report the name of the function (or the variable name in the case of a function expression) in the message instead of the generic `function`. For example, a message like `function has too many parameters...` could be `handleSubmit has too many parameters...` instead
144
+ - ~~Currently, in `func-params` rule, when there is an error reported, in addition to the code location (file and line number), an error message like `function has too many parameters (3). Maximum allowed is (2).` is reported. An improvement would be to report the name of the function (or the variable name in the case of a function expression) in the message instead of the generic `function`. For example, a message like `function has too many parameters...` could be `handleSubmit has too many parameters...` instead~~ **Added in v3**
152
145
 
153
146
  - Consider adding options for pattern matching. Maybe as a start, support `startsWith` and `endsWith` options. Could be useful if you use or have Node-style function names that end with a specific pattern like `[whatever]Sync` or `[whatever]Async`
154
147
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "eslint-plugin-func-params-args",
3
- "version": "3.0.0",
3
+ "version": "3.0.1",
4
4
  "description": "Limit the number of function parameters and arguments with ease and flexibility",
5
5
  "author": "Abdulrahman (Abdu) Assabri <abdusabri@abdusabri.com>",
6
6
  "keywords": [