Search code examples
javascriptecmascript-6ecmascript-2017ecmascript-2016

Why does javascript let you add comma in the end of function parameters?


I have encountered a change in the javascript function declaration that seems to be off. You can make a function like this:

let a = function (b,) {
    console.log(b);
}

I have found that the trailing comma in function parameters is allowed because of git differences between:

let a = function (
    b,
) {
    console.log(b);
}

and

let a = function (
    b,
    c,
) {
    console.log(b);
}

is the git diffs really the reason for that as it works I believe only in the ECMAScript-2017.


Solution

  • Is the git diffs really the reason for that as it works I believe only in the ECMAScript-2017.

    Basically, the answer is yes. Quoting original proposal (bold text is mine)

    In some codebases/style guides there are scenarios that arise where function calls and definitions are split across multiple lines in the style of:

     1: function clownPuppiesEverywhere(
     2:   param1,
     3:   param2
     4: ) { /* ... */ }
     5: 
     6: clownPuppiesEverywhere(
     7:   'foo',
     8:   'bar'
     9: );
    

    In these cases, when some other code contributor comes along and adds another parameter to one of these parameter lists, they must make two line updates:

     1: function clownPuppiesEverywhere(
     2:   param1,
     3:   param2, // updated to add a comma
     4:   param3  // updated to add new parameter
     5: ) { /* ... */ }
     6: 
     7: clownPuppiesEverywhere(
     8:   'foo',
     9:   'bar', // updated to add a comma
    10:   'baz'  // updated to add new parameter
    11: );
    

    In the process of doing this change on code managed by a version control system (git, subversion, mercurial, etc), the blame/annotation code history information for lines 3 and 9 get updated to point at the person who added the comma (rather than the person who originally added the parameter).

    To help mitigate this problem, some other languages (Python, D, Hack, ...probably others...) have added grammar support to allow a trailing comma in these parameter lists. This allows code contributors to always end a parameter addition with a trailing comma in one of these per-line parameter lists and never have to worry about the code attribution problem again