Keep the empty line at the beginning of a function, if present

[vjpr]

With the increasing prevalence of TypeScript, I think maybe it's worth revisiting.

I find that the readability of a function is reduced any time a TypeScript return type is specified, like as follows below.

It would be nice to have an option.

I know it probably won't happen, but good to have a summary of the discussion here for longevity if I ever forget why again.

TypeScript typed return

Current

function getDependentGraph(
  compilation,
  mod: any,
  stopOnFirstMatch: false,
): webpack.compilation.Module | null {
  const graph = new Graph(true)
  const entryModules = new Set()
}

Better

function getDependentGraph(
  compilation,
  mod: any,
  stopOnFirstMatch: false,
): webpack.compilation.Module | null {

  const graph = new Graph(true)
  const entryModules = new Set()

}

Maybe Better

Moving the return type to a type alias on a separate line helps reduce the noise.

type ReturnType = {graph: any; entryModule: webpack.compilation.Module | null}
function getDependentGraph(
  compilation,
  mod: any,
  stopOnFirstMatch: false,
): ReturnType {
  const graph = new Graph(true)
  const entryModules = new Set()
}

First comment

Also when the first line is a comment:

Current

function foor(
  foo: any
): foo.bar.baz | null {
  // This is a comment for the first code block.
  const graph = new Graph(true)
  const entryModules = new Set()

  // This is another comment
  const foo = 'foo'
}

Better

function foor(
  foo: any
): foo.bar.baz | null {

  // This is a comment for the first code block.
  const graph = new Graph(true)
  const entryModules = new Set()

}

Workaround

function foor(
  foo: any
): foo.bar.baz | null {
  //
  // This is a comment for the first code block.
  const graph = new Graph(true)
  const entryModules = new Set()
  //
}

Discussion

The only rationale in all discussions is as follows:

vjeux: What I found is that the important piece is not the actual decision about having space or not in this context, but the fact that it is consistently applied.
#2599 (comment)

Current Judgement

vjeux: I'm sorry but we're not going to support this style inside of prettier :(
#2352 (comment)

Related

#3501
#2352
#2599
#879