Specify cursor position when creating new files

[gabro]

Closes #1529

Previously we would set the cursor position at the beginning of the file when creating a new file. Now we place the cursor in a more convenient position, depending on the type of file.

Demo:

[gabro]

/cc @olafurpg dogfooding the new scalacheck module 👇

[tgodzik]

Do we really need Scalacheck here though? It's supposed to be used over a set of possible values and here it is just normal testing. I have never found a usage for property based testing and maybe it would be better to keep the tests consistent?

[gabro]

It's supposed to be used over a set of possible values and here it is just normal testing

I'm using Scalacheck to test "all" possible positions of the cursor inside a (fixed) document.

Do we really need Scalacheck here though?

It's not strictly necessary, but it just gives me a little more confidence that the computation is not right by chance but it holds for "all" possible cursor positions.

That said, if you prefer we can remove it.

[tgodzik]

I'm using Scalacheck to test "all" possible positions of the cursor inside a (fixed) document.

I am totally blind and have not seen it. It's a perfectly valid scenario to use it in. 👍

[tgodzik]

Thanks for adding this feature! It will be much more comfortable to create new files now.

I am not sure about using Scalacheck here though.

[tgodzik]

Should we stick to short names as in other suites?

[gabro]

Ah, absolutely, I completely forgot. Fixed

[tgodzik]

Do we really need Scalacheck here though? It's supposed to be used over a set of possible values and here it is just normal testing. I have never found a usage for property based testing and maybe it would be better to keep the tests consistent?

[gabro]

2020-03-27T08:11:21.6652922Z [error] ==> X tests.HoverLspSuite.basic-rambo  2.558s munit.FailException: D:\a\metals\metals\tests\unit\src\test\scala\tests\HoverLspSuite.scala:35 Obtained empty output!
2020-03-27T08:11:21.6653700Z [error] 34:      )
2020-03-27T08:11:21.6654013Z [error] 35:      _ <- server.assertHover(
2020-03-27T08:11:21.6654296Z [error] 36:        "a/src/main/scala/a/Main.scala",
2020-03-27T08:11:21.6654871Z [error]     at munit.Assertions.fail(Assertions.scala:178)

Unrelated flaky test (we should probably mark it as FlakyWindows)

Merging

[olafurpg]

What is the difference between forAll here and 0.to(template.length).foreach { .. }?

[gabro]

ah, good point: in this case just the number of iterations (100 with ScalaCheck). I can revert to just using a range

[olafurpg]

I think 1.to(100) would be clearer and more consistent with the rest of the tests. Property based testing is more helpful when you can't tests all possible inputs.