Repository navigation
Trailing Commas in Function Param Lists #7279
Description
https://jeffmo.github.io/es-trailing-function-commas/
This proposal is Stage 3 according to https://github.com/tc39/ecma262, so seems like its at an appropriate stability for TypeScript team to implement it.
This would allow function definitions and calls in the following style:
function foo(
bar: Bar, // Comment about bar
baz: Baz, // Comment about baz
) {
// Implementation...
}
foo(
bar,
baz,
);Benefits: https://github.com/jeffmo/es-trailing-function-commas/blob/master/proposal_presentation_slides.pdf
- Helps with VCS authorship attribution in case of added/removed parameters
- Consistency with object and array literals
- Lintable (if you don't like the style, can ban it in your codebase with a linter)
- Supported by other languages
In addition to all of the above, I suspect the extra "verbosity" of TypeScript's inline types makes this feature even more attractive in TypeScript than in vanilla JS. I feel this particularly in class constructors, which can also have private annotations, and possibly a readonly annotation coming down the pipe.
class Foo {
constructor(
private bar: Bar = new BasicBar(),
private baz: Baz = new BasicBaz(),
) {}
}
Activity
RyanCavanaugh commentedon Mar 8, 2016
Approved for whatever the Stage 3 proposal says
mhegazy commentedon Mar 8, 2016
PRs are welcomed of course. the change should be limited to the parser, so would be a rather easy change to make.
DanielRosenwasser commentedon Mar 8, 2016
Actually, signature help and overload resolution could potentially be affected by this.
nojvek commentedon May 22, 2016
Is anyone taking on this? If not I can. I spent almost my entire weekend playing with the parser and scanner.
Daniel Rosenwasser (@DanielRosenwasser), what do you mean by signature help and overload resolution?
mhegazy commentedon May 23, 2016
Noj Vek (@nojvek) there is a PR for this already in #7747. if you want to take that over and respond to code review comments we can get it in.
DanielRosenwasser commentedon May 23, 2016
Noj Vek (@nojvek) signature help is the little tooltip that shows up to show the parameters & their types when you call a function.
I mean that we specifically check if you have a trailing comma to see if there is a "better" overload in some cases.
For instance, here's a call to
localeComparewith one argument:Here's a call with one argument and a trailing comma:
DanielRosenwasser commentedon May 23, 2016
So in general, my warning is that we can't do that anymore if we support trailing commas in argument lists. If we do that, we'd impair the experience of anyone who wants to use trailing commas in calls.
mhegazy commentedon May 23, 2016
do not think this is an issue we should change the design of signature help for. you will get the pop up, you could decide to dismiss it an keep the comma.
ewinslow commentedon Jun 8, 2016
Woohoo!
basarat commentedon Jul 6, 2016
Personal opinion to any users : If you are thinking about adding a trailing comma to a function you might want to reconsider and change the function parameters to a single object https://basarat.gitbooks.io/typescript/content/docs/tips/functionParameters.html 🌹
* Moved filter functionality to the SubscriptionsManager.