function-call-argument-newline complains in some cases when it logically shouldn't.

[Ferroin]

Tell us about your environment

• ESLint Version: 6.2.0
• Node Version: 11.14.0
• npm Version: 6.7.0

What parser (default, Babel-ESLint, etc.) are you using?

default

Please show your full configuration:

This config is the minimum together with the example code below to reproduce the issue.

Configuration

{
    "extends": "eslint:recommended",
    "env": {
        "browser": true
    },
    "rules": {
        "function-call-argument-newline": [
            "error",
            "consistent"
        ]
    }
}

What did you do? Please include the actual source code causing the issue, as well as the command that you used to run ESLint.

This is a minimal reproducer that I've created based on my own experimentation, not the original code that caused the issue:

document.body.addEventListener('scroll', function() {
    // do something
})

document.body.addEventListener('scroll', function() {
    // do something
}, {
    passive: true,
})

document.body.addEventListener('scroll', function() {
    // do something
}, {passive: true})

npx eslint test.js

What did you expect to happen?

In consistent mode, none of the three calls to document.body.addEventListener() above should trigger an error (the use of newlines between arguments is consistent in all three cases).

What actually happened? Please include the actual, raw output from ESLint.

/mnt/sync/eslint-test/test.js
   7:3  error  There should be no line break here  function-call-argument-newline
  13:3  error  There should be no line break here  function-call-argument-newline

✖ 2 problems (2 errors, 0 warnings)
  2 errors and 0 warnings potentially fixable with the `--fix` option.

Are you willing to submit a pull request to fix this bug?

I don't have enough background with Node.js to be comfortable submitting a PR, but I will be more than happy to help test any that does get submitted.

[kaicataldo]

It looks like the rule is expecting the following:

document.body.addEventListener(
    'scroll', 
    function() {
        // do something
    }, 
    {
        passive: true,
    }
);

document.body.addEventListener(
    'scroll', 
    function() {
        // do something
    }, 
    {passive: true}
);

That being said, I do think it's reasonable to configure it to account for multiline arguments in a way that allows for the expected behavior in the bug report. I wonder if that should be an option (something like ignoreMultilineArgs?)

[Ferroin]

I think an option would indeed be good. What's got me confused here is that if it's just two arguments, it doesn't seem to care for some reason (regardless of whether the first, the second, or both are multi-line arguments).

[kaicataldo]

Yeah, that does seem like a bug. Here's some more inconsistency in our demo.

[klimashkin]

Simple lodash _.reduce case failing with the consistent option:

[mdjermanovic]

This isn't related directly to the consistent option, e.g. this is also an error:

/*eslint function-call-argument-newline:["error", "never"] */

foo({
}, bar);

and is reporting a line break between , and bar (Demo)

The issue is with comparing first tokens instead of last vs first (there is also a similar but not same issue with multiline tokens because it compares start with start).

I believe this could be seen as a bug, because:

This rule enforces line breaks between arguments of a function call.
"always" (default) requires line breaks between arguments
"never" disallows line breaks between arguments
"consistent" requires consistent usage of line breaks between arguments

If fixed to compare last to first (and end to start) all examples from this issue should be solved, but the following would be a new error:

/*eslint function-call-argument-newline:["error", "always"] */

foo({
}, bar);