在 DOM 对象上设置属性时如何避免无参数重新分配

Question

我有一个主要目的是在 DOM 对象上设置属性的方法

function (el) {
  el.expando = {};
}

我使用 AirBnB 的代码风格，这使得 ESLint 抛出 no-param-reassign 错误：

错误赋值给函数参数'el' no-param-reassign

如何操作作为参数传递的 DOM 对象，同时符合 AirBnB 的代码样式？

有人建议使用/* eslint react/prop-types: 0 */ 指代another issue，但如果我没记错的话，这适用于react，但不适用于本机DOM 操作。

我也不认为改变代码风格是一个答案。我相信使用标准样式的好处之一是在项目之间具有一致的代码，并且随意更改规则感觉就像对 AirBnB 等主要代码样式的滥用。

为了记录，我在 GitHub 上询问了 AirBnB，他们认为在这些情况下该怎么办in issue #766。

Answer 1

正如@Mathletics 建议的那样，您可以通过将其添加到您的.eslintrc.json 文件中来完全disable the rule：

"rules": {
  "no-param-reassign": 0
}

或者您可以专门为参数属性禁用规则

"rules": {
  "no-param-reassign": [2, { "props": false }]
}

或者，您可以禁用该功能的规则

/* eslint-disable no-param-reassign */
function (el) {
  el.expando = {};
}
/* eslint-enable no-param-reassign */

或者只针对那一行

function (el) {
  el.expando = {}; // eslint-disable-line no-param-reassign
}

Answer 2

作为this article explains，此规则旨在避免arguments object 发生变异。如果您分配给一个参数，然后尝试通过arguments 对象访问某些参数，则可能会导致意外结果。

您可以通过使用另一个变量来获取对 DOM 元素的引用，然后对其进行修改，从而保持规则不变并保持 AirBnB 样式：

function (el) {
  var theElement = el;
  theElement.expando = {};
}

在JS中对象（包括DOM节点）是通过引用传递的，所以这里el和theElement是对同一个DOM节点的引用，但是修改theElement不会改变arguments对象，因为@987654333 @ 仍然只是对该 DOM 元素的引用。

documentation for the rule 中暗示了这种方法：

此规则的正确代码示例：

/*eslint no-param-reassign: "error"*/

function foo(bar) {
    var baz = bar;
}

就我个人而言，我只会使用"no-param-reassign": ["error", { "props": false }] 方法提到的其他几个答案。修改作为参数传递的对象的属性不会更改对象引用，因此不应遇到此规则试图避免的问题。

Answer 3

您可以在 .eslintrc 文件中覆盖此规则，并为此类参数属性禁用它

{
    "rules": {
        "no-param-reassign": [2, { 
            "props": false
        }]
    },
    "extends": "eslint-config-airbnb"
}

这种方式规则仍然有效，但不会对属性发出警告。 更多信息：http://eslint.org/docs/rules/no-param-reassign

Answer 4

no-param-reassign 警告对于常用函数是有意义的，但对于您打算改变的数组上的经典 Array.forEach 循环是不合适的。

但是，为了解决这个问题，您还可以将 Array.map 与新对象一起使用（如果您像我一样，不喜欢使用 cmets 发出打盹警告）：

someArray = someArray.map((_item) => {
    let item = Object.assign({}, _item); // decouple instance
    item.foo = "bar"; // assign a property
    return item; // replace original with new instance
});

Answer 5

function (el) {
  el.setAttribute('expando', {});
}

其他一切都只是丑陋的黑客。

Answer 6

那些希望有选择地停用此规则的人可能会对proposed new option 的no-param-reassign 规则感兴趣，该规则将允许对象名称的“白名单”与应该忽略哪些参数重新分配有关。

Answer 7

您还可以使用 lodash assignIn 来改变对象。 assignIn(obj, { someNewObj });

https://lodash.com/docs/4.17.2#assignIn

Answer 8

关注documentation：

function (el) {
  const element = el
  element.expando = {}
}

Answer 9

如果您真的不想禁用规则，则可以使用更新的替代方法，例如：

function (el) {
  Object.defineProperty(el, 'expando',{
    value: {},
    writable: true,
    configurable: true,
    enumerable: true
  });
}

参考：https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/defineProperty

Answer 10

您可以使用方法来更新数据。例如。 “res.status(404)”而不是“res.statusCode = 404” 我找到了解决方案。 https://github.com/eslint/eslint/issues/6505#issuecomment-282325903

/*eslint no-param-reassign: ["error", { "props": true, "ignorePropertyModificationsFor": ["$scope"] }]*/

app.controller('MyCtrl', function($scope) {
  $scope.something = true;
});

Answer 11

根据 eslint (https://eslint.org/docs/2.0.0/rules/no-param-reassign) 的文档，我使用.eslintrc.js 文件中的以下书面配置解决了这个问题。

rules: {
  "no-param-reassign": [2, {"props": false}]
},

Answer 12

你可以使用：

(param) => {
  const data = Object.assign({}, param);
  data.element = 'some value';
}