Skip to content

Commit

Permalink
Update: Allow regex in no-param-reassign ignore option array
Browse files Browse the repository at this point in the history
  • Loading branch information
lbennett-stacki committed May 7, 2019
1 parent f2e7828 commit 6575df5
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 3 deletions.
20 changes: 19 additions & 1 deletion docs/rules/no-param-reassign.md
Expand Up @@ -34,7 +34,7 @@ function foo(bar) {

## Options

This rule takes one option, an object, with a boolean property `"props"` and an array `"ignorePropertyModificationsFor"`. `"props"` is `false` by default. If `"props"` is set to `true`, this rule warns against the modification of parameter properties unless they're included in `"ignorePropertyModificationsFor"`, which is an empty array by default.
This rule takes one option, an object, with a boolean property `"props"`, and arrays `"ignorePropertyModificationsFor"` and `"ignorePropertyModificationsForRegex"`. `"props"` is `false` by default. If `"props"` is set to `true`, this rule warns against the modification of parameter properties unless they're included in `"ignorePropertyModificationsFor"` or `"ignorePropertyModificationsForRegex"`, which is an empty array by default.

### props

Expand Down Expand Up @@ -92,6 +92,24 @@ function foo(bar) {
}
```

Examples of **correct** code for the `{ "props": true }` option with `"ignorePropertyModificationsForRegex"` set:

```js
/*eslint no-param-reassign: ["error", { "props": true, "ignorePropertyModificationsForRegex": ["^bar"] }]*/

function foo(bar) {
barVar.prop = "value";
}

function foo(bar) {
delete barrito.aaa;
}

function foo(bar) {
bar_.aaa++;
}
```


## When Not To Use It

Expand Down
24 changes: 22 additions & 2 deletions lib/rules/no-param-reassign.js
Expand Up @@ -45,6 +45,13 @@ module.exports = {
type: "string"
},
uniqueItems: true
},
ignorePropertyModificationsForRegex: {
type: "array",
items: {
type: "string"
},
uniqueItems: true
}
},
additionalProperties: false
Expand All @@ -56,7 +63,8 @@ module.exports = {

create(context) {
const props = context.options[0] && context.options[0].props;
const ignoredPropertyAssignmentsFor = context.options[0] && context.options[0].ignorePropertyModificationsFor || [];
const ignoredPropertyAssignments = context.options[0] && context.options[0].ignorePropertyModificationsFor || [];
const ignoredPropertyAssignmentsRegex = context.options[0] && context.options[0].ignorePropertyModificationsForRegex || [];

/**
* Checks whether or not the reference modifies properties of its variable.
Expand Down Expand Up @@ -125,6 +133,18 @@ module.exports = {
return false;
}

/**
* Tests that a string matches any of the ignored property assignment regular expressions.
*
* @param {string} identifierName - A string that describes the name of an identifier to
* ignore property assignments for.
* @returns {boolean} Whether the string matches an ignored property assignment regular expression or not.
*/
function isIgnoredPropertyAssignment(identifierName) {
return ignoredPropertyAssignments.includes(identifierName) ||
ignoredPropertyAssignmentsRegex.some(ignored => new RegExp(ignored, "u").test(identifierName));
}

/**
* Reports a reference if is non initializer and writable.
* @param {Reference} reference - A reference to check.
Expand All @@ -146,7 +166,7 @@ module.exports = {
) {
if (reference.isWrite()) {
context.report({ node: identifier, message: "Assignment to function parameter '{{name}}'.", data: { name: identifier.name } });
} else if (props && isModifyingProp(reference) && ignoredPropertyAssignmentsFor.indexOf(identifier.name) === -1) {
} else if (props && isModifyingProp(reference) && !isIgnoredPropertyAssignment(identifier.name)) {
context.report({ node: identifier, message: "Assignment to property of function parameter '{{name}}'.", data: { name: identifier.name } });
}
}
Expand Down
17 changes: 17 additions & 0 deletions tests/lib/rules/no-param-reassign.js
Expand Up @@ -39,6 +39,11 @@ ruleTester.run("no-param-reassign", rule, {
{ code: "function foo(a) { delete a.b; }", options: [{ props: true, ignorePropertyModificationsFor: ["a"] }] },
{ code: "function foo(a, z) { a.b = 0; x.y = 0; }", options: [{ props: true, ignorePropertyModificationsFor: ["a", "x"] }] },
{ code: "function foo(a) { a.b.c = 0;}", options: [{ props: true, ignorePropertyModificationsFor: ["a"] }] },
{ code: "function foo(aFoo) { aFoo.b = 0; }", options: [{ props: true, ignorePropertyModificationsForRegex: ["^a.*$"] }] },
{ code: "function foo(aFoo) { ++aFoo.b; }", options: [{ props: true, ignorePropertyModificationsForRegex: ["^a.*$"] }] },
{ code: "function foo(aFoo) { delete aFoo.b; }", options: [{ props: true, ignorePropertyModificationsForRegex: ["^a.*$"] }] },
{ code: "function foo(a, z) { aFoo.b = 0; x.y = 0; }", options: [{ props: true, ignorePropertyModificationsForRegex: ["^a.*$", "^x.*$"] }] },
{ code: "function foo(aFoo) { aFoo.b.c = 0;}", options: [{ props: true, ignorePropertyModificationsForRegex: ["^a.*$"] }] },
{
code: "function foo(a) { ({ [a]: variable } = value) }",
options: [{ props: true }],
Expand Down Expand Up @@ -106,6 +111,18 @@ ruleTester.run("no-param-reassign", rule, {
parserOptions: { ecmaVersion: 6 },
errors: [{ message: "Assignment to property of function parameter 'bar'." }]
},
{
code: "function foo(bar) { [bar.a] = []; }",
options: [{ props: true, ignorePropertyModificationsForRegex: ["^a.*$"] }],
parserOptions: { ecmaVersion: 6 },
errors: [{ message: "Assignment to property of function parameter 'bar'." }]
},
{
code: "function foo(bar) { [bar.a] = []; }",
options: [{ props: true, ignorePropertyModificationsForRegex: ["^B.*$"] }],
parserOptions: { ecmaVersion: 6 },
errors: [{ message: "Assignment to property of function parameter 'bar'." }]
},
{
code: "function foo(bar) { ({foo: bar.a} = {}); }",
options: [{ props: true }],
Expand Down

0 comments on commit 6575df5

Please sign in to comment.