Added context menu command to create new worksheet #183

alekseiAlefirov · 2020-01-22T18:31:05Z

Issue: #179
(PR for the server: scalameta/metals#1339)

From the explorer context menu:

From Command Palette:

tgodzik · 2020-01-23T13:05:10Z

I am wondering if we should have a separate TAB with also new class/object etc.

olafurpg

This is very cool! I wonder if we can generalize this feature to more kinds of files than just worksheets 🤔 it would be nice to make it work more similarly to "New" in IntelliJ with options to create a Scala file, worksheets, maybe test file (automatically inferring the matching test target), etc

alekseiAlefirov · 2020-01-24T15:15:21Z

@olafurpg , can you please elaborate on test file, how it should work?
It most likely can be done, though it seems there's no such option for multi-level context menus in VSCode, so we can do like it's in IDEA. There an issue in VSCode project for that: microsoft/vscode#9827
-- nicely, some people want it for... creating new files from templates :)
We can reconstruct submenu functionality with quick-pick API of VSCode, probably, though.

olafurpg · 2020-01-24T18:11:01Z

you have open file src/main/scala/foo/Foo.scala
Run "Create test file" command
it creates src/test/scala/foo/FooSuite.scala

olafurpg · 2020-01-24T18:11:49Z

It's just an idea. It would be good to be able to at least handle a growing number of file kinds

tgodzik · 2020-01-27T09:55:00Z

I agree it would be really good to have a couple of possible file templates, but if it's not yet supported sensibly within vs code then I agree we can start with this one.

Although we could prepare a couple of commands within Metals itself.

olafurpg · 2020-01-27T14:02:30Z

My concern is that the "Create Scala worksheet" command will demand too much attention and this approach isn't scalable to a large number of file kinds. I would prefer instead to expose this feature only as a command and a button in the Metals tree view (maybe under "build" explorer 🤔 )

tgodzik · 2020-01-27T15:58:21Z

My concern is that the "Create Scala worksheet" command will demand too much attention and this approach isn't scalable to a large number of file kinds. I would prefer instead to expose this feature only as a command and a button in the Metals tree view (maybe under "build" explorer)

I think we need to put it in the explorer - people are already super confused how to create that. I fear a button in the TreeView will too hidden and we will not achieve anything of the original purpose.

We can just have the basic file kinds for now: .worksheet.sc, .sc, .sbt, .scala. It's not perfect, but it's not that large of a menu yet.

olafurpg · 2020-01-27T17:04:41Z

How about having a single "New Scala file" button that opens a quick open dialogue for the available options?

olafurpg · 2020-01-27T17:05:07Z

I agree the button should be available in the context menu, it would not be discoverable in the tree view

alekseiAlefirov · 2020-01-29T14:04:44Z

Context menu changed to support creating new scala class:

@olafurpg please check this out.

tgodzik

Overall, great work! I love the direction this is taking.

Comments here basically the same as in the server PR - we should reduce it all to a single level and we can jsut send an object via parameters.

tgodzik · 2020-01-30T11:22:58Z

src/extension.ts

+                  return withName(name => {
+                    client.sendRequest(ExecuteCommandRequest.type, {
+                      command: "new-scala-class",
+                      arguments: [dir, name, classKindPick.kind]


We should be able to have an object as an argument here and we can reduce it all to a single pick. Worksheet/object/trait/class together.

alekseiAlefirov · 2020-01-31T18:13:46Z

All kinds of file (different classes along with worksheet) now in one menu:

tgodzik

LGTM!

@gabro would you be able to review the PR? I don't trust myself when it comes to typescript 😅

olafurpg · 2020-02-07T20:22:08Z

src/extension.ts

+      const worksheetPick = { label: "Worksheet", kind: "worksheet" };
+
+      return window
+        .showQuickPick(


Instead of implementing the quick pick here, I think it would be nice to add a new LSP extension so the Metals server can open a quick pick. We can use window/showMessageRequest as a fallback.

I have tried to follow the principle of avoiding too much custom logic in the vscode client and allowing the server to push behavior instead. The benefit of this strategy is that we 1) we can reuse more code to support multiple editors and 2) next time we need a quick pick we may not have to update the client code.

I have some comments about the implementation, but I too think we should move this to the server similarly to how we do for other extensions.

@olafurpg , so this way part of the logic for the dialog about a new file (it's kind and name) is going to be transferred to the server and inside of the new-scala-file command execution. Dialog parts can be cancelled, so I have a question - how this should be handled by the command? Currently it returns a string/URI of the newly created file. Would using null in case of cancellation be alright for this? Or the request should finish with failure? Or instead of just string as the return type, we can use some Cancelable interface / generic container with it inside?

If the command “create new scala file” is sent to the server with a directory as the argument (or something like that) then I think it doesn’t matter what Metals returns. Metals already knows how to do the quick pick, do input box, apply workspace edit and also change the focused window (goto locations, it’s used in tree view protocol). Does that make sense?

The directory argument can be optional, for example when triggered via the command palette. Metals already knows the focused document.

gabro · 2020-02-10T10:43:18Z

src/extension.ts

+        // NOTE(aleksei): I would return workspace folder here, but not sure if there's API for that.
+        // Moving this funcitonality to server.
+        return undefined;


moving stuff to the server makes sense, but I would change this note to something more "final".

Also, what API are you looking for? workspace.workspaceFolders[0] should give you what you want

gabro · 2020-02-10T10:46:08Z

src/protocol.ts

+export interface MetalsNewScalaFileParams {
+  directory?: string;
+  name: string;
+  kind: string;


can this kind be more specific?

Suggested change

kind: string;

kind: 'class' | 'object' | 'trait' | 'package-object' | 'worksheet' ;

gabro · 2020-02-10T10:46:41Z

src/extension.ts

+      const worksheetPick = { label: "Worksheet", kind: "worksheet" };
+
+      return window
+        .showQuickPick(


I have some comments about the implementation, but I too think we should move this to the server similarly to how we do for other extensions.

src/extension.ts

alekseiAlefirov · 2020-02-10T11:26:53Z

Thanks for the review, @tgodzik , @olafurpg , @gabro . I'll try to create "show quick pick" method in a PR to metals server and return with that soon.

alekseiAlefirov · 2020-02-17T18:58:54Z

metals/pickInput added, server side PR here: scalameta/metals#1447

tgodzik

LGTM! I think we can merge this as soon as we do the release.

…w-scala-file removed

alekseiAlefirov mentioned this pull request Jan 22, 2020

Added Command to create new worksheet scalameta/metals#1339

Merged

alekseiAlefirov force-pushed the new-files branch from c033992 to a933a8d Compare January 22, 2020 21:06

olafurpg reviewed Jan 23, 2020

View reviewed changes

tgodzik requested changes Jan 30, 2020

View reviewed changes

alekseiAlefirov force-pushed the new-files branch from a9c3680 to c9ead1f Compare January 31, 2020 18:08

gabro force-pushed the master branch from 580433f to 7179705 Compare February 4, 2020 13:38

alekseiAlefirov force-pushed the new-files branch 2 times, most recently from 2a61ae7 to 64d82b7 Compare February 4, 2020 16:48

alekseiAlefirov marked this pull request as ready for review February 7, 2020 14:51

tgodzik approved these changes Feb 7, 2020

View reviewed changes

olafurpg reviewed Feb 7, 2020

View reviewed changes

gabro requested changes Feb 10, 2020

View reviewed changes

ckipp01 mentioned this pull request Feb 10, 2020

New file command scalameta/coc-metals#73

Merged

alekseiAlefirov mentioned this pull request Feb 17, 2020

Add new LSP extension 'metals/pickInput' to implement the "Create Scala file" command scalameta/metals#1447

Merged

alekseiAlefirov force-pushed the new-files branch from a97fc87 to 1aab277 Compare February 17, 2020 18:57

alekseiAlefirov force-pushed the new-files branch 2 times, most recently from 6421ba9 to 47f5838 Compare February 20, 2020 22:07

tgodzik approved these changes Feb 24, 2020

View reviewed changes

tgodzik added the wait for Metals release label Feb 24, 2020

tgodzik force-pushed the new-files branch from 744482b to 40f3bd0 Compare February 27, 2020 11:00

Aleksei Alefirov added 6 commits February 27, 2020 12:02

Added context menu command to create new worksheet

9f49c7d

Added command to create new scala class

ff91456

One-level common menu for classes and worksheet

b63864a

Addded package object to create new

744b421

Pick-input is a generalized end-point now, it's implementation for ne…

37876e6

…w-scala-file removed

PickInput capability config added

006461e

tgodzik force-pushed the new-files branch from 40f3bd0 to cfbc09e Compare February 27, 2020 11:04

pickinput renamed to quickpick

218896e

tgodzik force-pushed the new-files branch from cfbc09e to 218896e Compare February 27, 2020 11:06

tgodzik merged commit 6dea17b into scalameta:master Feb 27, 2020

ckipp01 mentioned this pull request Mar 22, 2020

Add explicit way to create new file (a.k.a. wizard for new class/worksheet) #179

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added context menu command to create new worksheet #183

Added context menu command to create new worksheet #183

alekseiAlefirov commented Jan 22, 2020 •

edited

Loading

tgodzik commented Jan 23, 2020

olafurpg left a comment

alekseiAlefirov commented Jan 24, 2020

olafurpg commented Jan 24, 2020

olafurpg commented Jan 24, 2020

tgodzik commented Jan 27, 2020

olafurpg commented Jan 27, 2020

tgodzik commented Jan 27, 2020

olafurpg commented Jan 27, 2020

olafurpg commented Jan 27, 2020

alekseiAlefirov commented Jan 29, 2020 •

edited

Loading

tgodzik left a comment

tgodzik Jan 30, 2020

alekseiAlefirov Jan 31, 2020

alekseiAlefirov commented Jan 31, 2020

tgodzik left a comment

olafurpg Feb 7, 2020

gabro Feb 10, 2020

alekseiAlefirov Feb 12, 2020

olafurpg Feb 12, 2020

olafurpg Feb 12, 2020

gabro Feb 10, 2020

gabro Feb 10, 2020

gabro Feb 10, 2020

alekseiAlefirov commented Feb 10, 2020

alekseiAlefirov commented Feb 17, 2020

tgodzik left a comment

	kind: string;
	kind: 'class' \| 'object' \| 'trait' \| 'package-object' \| 'worksheet' ;

Added context menu command to create new worksheet #183

Added context menu command to create new worksheet #183

Conversation

alekseiAlefirov commented Jan 22, 2020 • edited Loading

tgodzik commented Jan 23, 2020

olafurpg left a comment

Choose a reason for hiding this comment

alekseiAlefirov commented Jan 24, 2020

olafurpg commented Jan 24, 2020

olafurpg commented Jan 24, 2020

tgodzik commented Jan 27, 2020

olafurpg commented Jan 27, 2020

tgodzik commented Jan 27, 2020

olafurpg commented Jan 27, 2020

olafurpg commented Jan 27, 2020

alekseiAlefirov commented Jan 29, 2020 • edited Loading

tgodzik left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alekseiAlefirov commented Jan 31, 2020

tgodzik left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alekseiAlefirov commented Feb 10, 2020

alekseiAlefirov commented Feb 17, 2020

tgodzik left a comment

Choose a reason for hiding this comment

alekseiAlefirov commented Jan 22, 2020 •

edited

Loading

alekseiAlefirov commented Jan 29, 2020 •

edited

Loading