Adding support for creating sbt files #659

Sa1to · 2024-04-11T14:49:27Z

It solves https://youtrack.jetbrains.com/issue/SCL-21374/Support-sbt-files-creation-via-File-New

Screen.Recording.2024-05-08.at.13.28.40.mov

azdrojowa123 · 2024-04-12T09:22:45Z

My suspicion is that most of the users create build.sbt and plugins.sbt files. Maybe when the user selects to create an sbt file, we can display a dropdown list from which he will be able to choose whether he wants to create an build.sbt or plugins.sbt file. Or he will be able to enter his own name as if he wanted to create some custom file. Similar as it is done for javascript file (but they allow you to create files with different extensions, and we would give users the same extension but just different names )

What do you think @unkarjedy ?

unkarjedy · 2024-04-12T09:49:47Z

@azdrojowa123

I agree that it would be a more convenient UX.
Though I don't know if the current API supports it.

I created a similar feature request in IntelliJ some time ago:
https://youtrack.jetbrains.com/issue/IDEA-306704/project-view-provide-a-way-to-create-quickly-special-files-via-New-in-this-Directory-action
Though it's not completely the same.

It would be nice to have a look if the existing API allows to have some predefined file names in the dropdown list when you select "Sbt file" template

unkarjedy · 2024-04-12T09:52:05Z

@Sa1to Please append #SCL-21374 in the commit message.

See https://github.com/JetBrains/intellij-scala/blob/idea241.x/CONTRIBUTING.md#some-guidelines-for-code-commits-and-pull-requests

unkarjedy · 2024-04-12T09:57:29Z

My suspicion is that most of the users create build.sbt and plugins.sbt files.

Also some notes:

I guess users mostly don't create build.sbt files because they already exist once you create an SBT project or open an existing one. So it's mostly applicable to plugins.sbt file
We shouldn't suggest a file name if the file already exists in the selected directory

azdrojowa123 · 2024-04-12T11:25:03Z

I guess users mostly don't create build.sbt files because they already exist once you create an SBT project or open an existing one. So it's mostly applicable to plugins.sbt file

I think that it might be possible to create build.sbt files e.g. when someone creates a multi build project or build.sbt file in the project directory (such a file exists, for example, in our ultimate repository)

We shouldn't suggest a file name if the file already exists in the selected directory

Really good note, I agree

Sa1to · 2024-04-19T10:55:45Z

I was trying to use CreateFromTemplateActionBase to use dialog with different file kinds like when you create scala class
but it is difficult to add default text for each file kind. I am suggesting create separate actions for build.sbt, plugin.sbt and sbt file with custom name, and put them in dropdown like this

scala/scala-impl/resources/META-INF/scala-plugin-common.xml

scala/scala-impl/src/org/jetbrains/plugins/scala/actions/NewSbtPluginFileAction.scala

azdrojowa123 · 2024-05-08T09:49:15Z

@Sa1to for me this PR is not working :(
I mean build.sbt and plugin.sbt are not being generated correctly

scala/scala-impl/src/org/jetbrains/plugins/scala/actions/NewSbtBuildFileAction.scala

azdrojowa123 · 2024-05-15T15:55:09Z

scala/scala-impl/src/org/jetbrains/plugins/scala/actions/NewPredefinedSbtFileAction.scala

+
+import javax.swing.Icon
+
+abstract class NewPredefinedSbtFileAction(@NlsActions.ActionText title: String, @NlsActions.ActionDescription description: String, icon: Icon, fileName: String) extends CreateFromTemplateActionBase(title, description, icon) {


this line with class parameters is too long. Each parameter should be in a separate line. The same like in methods.

azdrojowa123 · 2024-05-15T15:55:51Z

scala/scala-impl/src/org/jetbrains/plugins/scala/actions/NewPredefinedSbtFileAction.scala

+
+abstract class NewPredefinedSbtFileAction(@NlsActions.ActionText title: String, @NlsActions.ActionDescription description: String, icon: Icon, fileName: String) extends CreateFromTemplateActionBase(title, description, icon) {
+
+  override def getTemplate(project: Project, dir: PsiDirectory): FileTemplate = FileTemplateManager.getDefaultInstance.getInternalTemplate(ScalaBundle.message("newclassorfile.menu.action.sbt.text"))


FileTemplateManager.getDefaultInstance.getInternalTemplate(ScalaBundle.message("newclassorfile.menu.action.sbt.text")) should be in a new line. It is not readable in IDE

azdrojowa123 · 2024-05-15T15:56:39Z

scala/scala-impl/src/org/jetbrains/plugins/scala/actions/NewPredefinedSbtFileAction.scala

+  override def getTargetDirectory(dataContext: DataContext, view: IdeView): PsiDirectory = {
+    val directories: Array[PsiDirectory] = view.getDirectories
+    directories.find(directory => directory.findFile(fileName + ".sbt") != null).exists(dir => {
+      Messages.showErrorDialog(CommonDataKeys.PROJECT.getData(dataContext),


each operation on directories should be in a new line

exists takes a predicate as a parameter. What's your predicate here?

azdrojowa123 · 2024-05-15T16:01:00Z

scala/scala-impl/src/org/jetbrains/plugins/scala/actions/NewSbtBuildFileAction.scala

+  Icons.SBT_FILE,
+  ScalaBundle.message("newclassorfile.menu.action.build.sbt.defaultName")
+) {
+  protected override def getAttributesDefaults(dataContext: DataContext): AttributesDefaults = new AttributesDefaults(ScalaBundle.message("newclassorfile.menu.action.build.sbt.defaultName")).withFixedName(true)


new AttributesDefaults(ScalaBundle.message("newclassorfile.menu.action.build.sbt.defaultName")).withFixedName(true) should be in a new line

azdrojowa123 · 2024-05-15T16:01:33Z

scala/scala-impl/src/org/jetbrains/plugins/scala/actions/NewSbtFileAction.scala

+  Icons.SBT_FILE
+) {
+
+  override def getTemplate(project: Project, dir: PsiDirectory): FileTemplate = FileTemplateManager.getDefaultInstance.getInternalTemplate(ScalaBundle.message("newclassorfile.menu.action.sbt.text"))


FileTemplateManager.getDefaultInstance.getInternalTemplate(ScalaBundle.message("newclassorfile.menu.action.sbt.text")) should be in a new line

azdrojowa123 · 2024-05-15T16:02:25Z

scala/scala-impl/src/org/jetbrains/plugins/scala/actions/NewSbtPluginFileAction.scala

+  Icons.SBT_FILE,
+  ScalaBundle.message("newclassorfile.menu.action.plugin.sbt.defaultName")
+) {
+  protected override def getAttributesDefaults(dataContext: DataContext): AttributesDefaults = new AttributesDefaults(ScalaBundle.message("newclassorfile.menu.action.plugin.sbt.defaultName")).withFixedName(true)


the same comment about the new line as above

unkarjedy · 2024-09-10T11:41:56Z

Do I understand that only cosmetic/formatting fixes are left and everything works?

azdrojowa123 · 2024-09-10T12:00:40Z

As I remember yes.
@Sa1to could you fix these cosmetic changes and recheck if everything works?

azdrojowa123 self-requested a review April 12, 2024 08:53

azdrojowa123 requested a review from unkarjedy April 12, 2024 09:23

Adding support for creating sbt files #SCL-21374

b1ca3b2

Sa1to force-pushed the fix/SCL-21374 branch from 518c8e5 to b1ca3b2 Compare April 12, 2024 13:15

azdrojowa123 reviewed May 8, 2024

View reviewed changes

scala/scala-impl/resources/META-INF/scala-plugin-common.xml Show resolved Hide resolved

azdrojowa123 reviewed May 8, 2024

View reviewed changes

scala/scala-impl/src/org/jetbrains/plugins/scala/actions/NewSbtPluginFileAction.scala Outdated Show resolved Hide resolved

Adding predefined plugin.sbt and build.sbt files #SCL-21374

af09862

Sa1to force-pushed the fix/SCL-21374 branch from f1c0d84 to af09862 Compare May 8, 2024 10:06

azdrojowa123 reviewed May 8, 2024

View reviewed changes

scala/scala-impl/src/org/jetbrains/plugins/scala/actions/NewSbtBuildFileAction.scala Outdated Show resolved Hide resolved

azdrojowa123 reviewed May 8, 2024

View reviewed changes

scala/scala-impl/src/org/jetbrains/plugins/scala/actions/NewSbtBuildFileAction.scala Outdated Show resolved Hide resolved

Sa1to force-pushed the fix/SCL-21374 branch from 8933a69 to 6d06454 Compare May 13, 2024 13:34

Abstracting away common part for plugin and build file #SCL-21374

c633f55

Sa1to force-pushed the fix/SCL-21374 branch from 6d06454 to c633f55 Compare May 13, 2024 13:55

azdrojowa123 reviewed May 15, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding support for creating sbt files #659

Adding support for creating sbt files #659

Sa1to commented Apr 11, 2024 •

edited

Loading

azdrojowa123 commented Apr 12, 2024 •

edited

Loading

unkarjedy commented Apr 12, 2024

unkarjedy commented Apr 12, 2024

unkarjedy commented Apr 12, 2024

azdrojowa123 commented Apr 12, 2024 •

edited

Loading

Sa1to commented Apr 19, 2024

azdrojowa123 commented May 8, 2024

azdrojowa123 May 15, 2024

azdrojowa123 May 15, 2024

azdrojowa123 May 15, 2024

azdrojowa123 May 15, 2024

azdrojowa123 May 15, 2024

azdrojowa123 May 15, 2024

azdrojowa123 May 15, 2024

unkarjedy commented Sep 10, 2024

azdrojowa123 commented Sep 10, 2024


		import javax.swing.Icon

		abstract class NewPredefinedSbtFileAction(@NlsActions.ActionText title: String, @NlsActions.ActionDescription description: String, icon: Icon, fileName: String) extends CreateFromTemplateActionBase(title, description, icon) {


		abstract class NewPredefinedSbtFileAction(@NlsActions.ActionText title: String, @NlsActions.ActionDescription description: String, icon: Icon, fileName: String) extends CreateFromTemplateActionBase(title, description, icon) {

		override def getTemplate(project: Project, dir: PsiDirectory): FileTemplate = FileTemplateManager.getDefaultInstance.getInternalTemplate(ScalaBundle.message("newclassorfile.menu.action.sbt.text"))

Adding support for creating sbt files #659

Are you sure you want to change the base?

Adding support for creating sbt files #659

Conversation

Sa1to commented Apr 11, 2024 • edited Loading

azdrojowa123 commented Apr 12, 2024 • edited Loading

unkarjedy commented Apr 12, 2024

unkarjedy commented Apr 12, 2024

unkarjedy commented Apr 12, 2024

azdrojowa123 commented Apr 12, 2024 • edited Loading

Sa1to commented Apr 19, 2024

azdrojowa123 commented May 8, 2024

azdrojowa123 May 15, 2024

Choose a reason for hiding this comment

azdrojowa123 May 15, 2024

Choose a reason for hiding this comment

azdrojowa123 May 15, 2024

Choose a reason for hiding this comment

azdrojowa123 May 15, 2024

Choose a reason for hiding this comment

azdrojowa123 May 15, 2024

Choose a reason for hiding this comment

azdrojowa123 May 15, 2024

Choose a reason for hiding this comment

azdrojowa123 May 15, 2024

Choose a reason for hiding this comment

unkarjedy commented Sep 10, 2024

azdrojowa123 commented Sep 10, 2024

Sa1to commented Apr 11, 2024 •

edited

Loading

azdrojowa123 commented Apr 12, 2024 •

edited

Loading

azdrojowa123 commented Apr 12, 2024 •

edited

Loading