no-array-push-push: Add ignore option (sindresorhus#1168)

Co-authored-by: Sindre Sorhus <[email protected]>

Author: fisker

docs/rules/no-array-push-push.md

@@ -27,3 +27,39 @@ foo.push(1);
 bar();
 foo.push(2);
 ```
+
+## Options
+
+Type: `object`
+
+### ignore
+
+Type: `string[]`
+
+Ignore objects, `stream`, `this`, `this.stream` are ignored by default.
+
+Example:
+
+```js
+{
+	'unicorn/no-array-push-push': [
+		'error',
+		{
+			ignore: [
+				'readable',
+				'foo.stream'
+			]
+		}
+	]
+}
+```
+
+```js
+// eslint unicorn/no-array-push-push: ["error", {"ignore": ["readable"]}]
+const {Readable} = require('stream');
+
+const readable = new Readable();
+readable.push('one');
+readable.push('another');
+readable.push(null);
+```

rules/no-array-push-push.js

@@ -4,6 +4,7 @@ const getDocumentationUrl = require('./utils/get-documentation-url');
 const methodSelector = require('./utils/method-selector');
 const getCallExpressionArgumentsText = require('./utils/get-call-expression-arguments-text');
 const isSameReference = require('./utils/is-same-reference');
+const {isNodeMatches} = require('./utils/is-node-matches');
 
 const ERROR = 'error';
 const SUGGESTION = 'suggestion';
@@ -42,16 +43,25 @@ function getFirstExpression(node, sourceCode) {
 }
 
 function create(context) {
+	const {ignore} = {
+		ignore: [],
+		...context.options[0]
+	};
+	const ignoredObjects = ['stream', 'this', 'this.stream', ...ignore];
 	const sourceCode = context.getSourceCode();
 
 	return {
 		[selector](secondExpression) {
-			const firstExpression = getFirstExpression(secondExpression, sourceCode);
-			const firstCall = firstExpression.expression;
 			const secondCall = secondExpression.expression;
+			const secondCallArray = secondCall.callee.object;
+
+			if (isNodeMatches(secondCallArray, ignoredObjects)) {
+				return;
+			}
 
+			const firstExpression = getFirstExpression(secondExpression, sourceCode);
+			const firstCall = firstExpression.expression;
 			const firstCallArray = firstCall.callee.object;
-			const secondCallArray = secondCall.callee.object;
 
 			// Not same array
 			if (!isSameReference(firstCallArray, secondCallArray)) {
@@ -100,6 +110,19 @@ function create(context) {
 	};
 }
 
+const schema = [
+	{
+		type: 'object',
+		properties: {
+			ignore: {
+				type: 'array',
+				uniqueItems: true
+			}
+		},
+		additionalProperties: false
+	}
+];
+
 module.exports = {
 	create,
 	meta: {
@@ -108,6 +131,7 @@ module.exports = {
 			url: getDocumentationUrl(__filename)
 		},
 		fixable: 'code',
-		messages
+		messages,
+		schema
 	}
 };

rules/utils/is-node-matches.js

@@ -16,12 +16,16 @@ function isNodeMatchesNameOrPath(node, nameOrPath) {
 		}
 
 		if (index === 0) {
-			return node.type === 'Identifier' && node.name === name;
+			return (
+				(node.type === 'Identifier' && node.name === name) ||
+				(name === 'this' && node.type === 'ThisExpression')
+			);
 		}
 
 		if (
 			node.type !== 'MemberExpression' ||
 			node.optional ||
+			node.computed ||
 			node.property.type !== 'Identifier' ||
 			node.property.name !== name
 		) {

test/no-array-push-push.mjs

@@ -48,7 +48,42 @@ test.snapshot({
 		outdent`
 			foo().bar.push(1);
 			foo().bar.push(2);
-		`
+		`,
+		// Ignored
+		outdent`
+			const stream = new Readable();
+			stream.push('one string');
+			stream.push('another string');
+		`,
+		outdent`
+			class FooReadable extends Readable {
+				pushAndEnd(chunk) {
+					this.push(chunk);
+					this.push(null);
+				}
+			}
+		`,
+		outdent`
+			class Foo {
+				pushAndEnd(chunk) {
+					this.stream.push(chunk);
+					this.stream.push(null);
+				}
+			}
+		`,
+		{
+			code: outdent`
+				foo.push(1);
+				foo.push(2);
+				foo.bar.push(1);
+				foo.bar.push(2);
+			`,
+			options: [
+				{
+					ignore: ['foo', 'foo.bar']
+				}
+			]
+		}
 	],
 	invalid: [
 		outdent`
@@ -144,7 +179,29 @@ test.snapshot({
 		outdent`
 			foo.bar.push(1);
 			(foo)['bar'].push(2);
-		`
+		`,
+		// Ignored
+		outdent`
+			foo.push(1);
+			foo.push(2);
+			stream.push(1);
+			stream.push(2);
+		`,
+		{
+			code: outdent`
+				foo.bar.push(1);
+				foo.bar.push(2);
+				foo.push(1);
+				foo.push(2);
+				bar.foo.push(1);
+				bar.foo.push(2);
+			`,
+			options: [
+				{
+					ignore: ['foo', 'foo.bar']
+				}
+			]
+		}
 	]
 });
 
@@ -173,8 +230,8 @@ test({
 			code: outdent`
 				class A extends B {
 					foo() {
-						this.push(1);
-						this.push(2);
+						this.x.push(1);
+						this.x.push(2);
 
 						super.x.push(1);
 						super.x.push(2);
@@ -205,7 +262,7 @@ test({
 			output: outdent`
 				class A extends B {
 					foo() {
-						this.push(1, 2);
+						this.x.push(1, 2);
 
 						super.x.push(1, 2);
 

test/snapshots/no-array-push-push.mjs.md

@@ -395,3 +395,70 @@ Generated by [AVA](https://avajs.dev).
     > 2 | (foo)['bar'].push(2);␊
         |              ^^^^ Do not call \`Array#push()\` multiple times.␊
     `
+
+## Invalid #21
+      1 | foo.push(1);
+      2 | foo.push(2);
+      3 | stream.push(1);
+      4 | stream.push(2);
+
+> Output
+
+    `␊
+      1 | foo.push(1, 2);␊
+      2 | stream.push(1);␊
+      3 | stream.push(2);␊
+    `
+
+> Error 1/1
+
+    `␊
+      1 | foo.push(1);␊
+    > 2 | foo.push(2);␊
+        |     ^^^^ Do not call \`Array#push()\` multiple times.␊
+      3 | stream.push(1);␊
+      4 | stream.push(2);␊
+    `
+
+## Invalid #22
+      1 | foo.bar.push(1);
+      2 | foo.bar.push(2);
+      3 | foo.push(1);
+      4 | foo.push(2);
+      5 | bar.foo.push(1);
+      6 | bar.foo.push(2);
+
+> Options
+
+    `␊
+    [␊
+      {␊
+        "ignore": [␊
+          "foo",␊
+          "foo.bar"␊
+        ]␊
+      }␊
+    ]␊
+    `
+
+> Output
+
+    `␊
+      1 | foo.bar.push(1);␊
+      2 | foo.bar.push(2);␊
+      3 | foo.push(1);␊
+      4 | foo.push(2);␊
+      5 | bar.foo.push(1, 2);␊
+    `
+
+> Error 1/1
+
+    `␊
+      1 | foo.bar.push(1);␊
+      2 | foo.bar.push(2);␊
+      3 | foo.push(1);␊
+      4 | foo.push(2);␊
+      5 | bar.foo.push(1);␊
+    > 6 | bar.foo.push(2);␊
+        |         ^^^^ Do not call \`Array#push()\` multiple times.␊
+    `