Added Template based Project Wizard #499

keinhaar · 2024-09-29T16:00:03Z

Create projects based on templates.
removed some unused code
added a multi project template without example code
added a multi project GWT project template with the example code from the existing GWT sample project, but splitted into 3 projects.

- Create projects based on templates. - removed some unused code - added a multi project template without example code - added a multi project GWT project template with the example code from the existing GWT sample project, but splitted into 3 projects.

protoism · 2024-09-30T09:33:44Z

@keinhaar this PR looks great, and the implementation looks simply reasonable.
Before reviewing / merging, I'd like to know @niloc132 opinion about it.
Multi-module templates is definitely the right way to use GWT, classpath issues bite very often, but:

Is there any overlap with what the SDK does already?
The build is Eclipse only (no maven, no gradle), does this make sense? (I think so, honestly) - @keinhaar I don't find any pom.xml file, but I see something about maven nature. Am I rigth or not, that maven is not involved?

BTW the solution is expandable either by adding to the template dir, or defining an env variable. Not bad!

keinhaar · 2024-09-30T12:11:02Z

1. Is there any overlap with what the SDK does already?

It just uses modified versions of the files that are created by the sdk.

2. The build is Eclipse only (no maven, no gradle), does this make sense? (I think so, honestly) - @keinhaar I don't find any pom.xml file, but I see something about maven nature. Am I rigth or not, that maven is not involved?

maven based example could be added easily by just providing a template with pom files. I did not create more templates, because i did not know if this would be accepted.

BTW the solution is expandable either by adding to the template dir, or defining an env variable. Not bad!

The env variable makes it possible to create and use your own custom templates. Thats what i personally would like to use, because my applications often have 5 or even 6 projects which depend on each other.

FrankHossfeld · 2024-09-30T12:12:12Z

@keinhaar Thanks for contributing.
I would suggest to provide only the multi module templates. GWT is moving to a more serverless approach. AFAIK the webappcreator inside GWT is deprecated for that reason (only one single module). And, as @protoism already mention, a Maven module artifact using the gwt-maven-plugin would be nice.

And, having a template project using Spring Boot on the server side would be fine. ;-)

FrankHossfeld · 2024-09-30T12:18:24Z

It just uses modified versions of the files that are created by the sdk

Just use the archetype creators for generating the template files:

https://github.com/tbroyer/gwt-maven-archetypes (Tomcat)
https://github.com/NaluKit/gwt-maven-springboot-archetype (Spring Boot)

These are the suggested way creating a new project: https://www.gwtproject.org/gettingstarted-v2.html

keinhaar · 2024-10-14T18:17:33Z

@niloc132 Could you please have a look on this pull request, as @protoism requested?

niloc132

A lot of this is pretty eclipse-specific, I'm not sure how helpful I can be. Here's a quick review, but I think it would make more sense for someone who knows the project more deeply to dig in than me.

niloc132 · 2024-10-15T15:08:49Z

...t.eclipse.suite/src/com/google/gdt/eclipse/suite/wizards/NewWebAppTemplateProjectWizard.java

@@ -0,0 +1,130 @@
+/*******************************************************************************
+ * Copyright 2011 Google Inc. All Rights Reserved.


new files, should have updated copyright date, and owner

niloc132 · 2024-10-15T15:09:24Z

...m.gwtplugins.gdt.eclipse.suite/src/com/google/gdt/eclipse/suite/wizards/ProjectTemplate.java

@@ -0,0 +1,171 @@
+/**
+ *


should be populated, or removed?

niloc132 · 2024-10-15T15:12:03Z

...ugins.gwt.eclipse.wtp/src/com/google/gwt/eclipse/wtp/projects/WtpFacetCreatorParicipant.java

+    javaProjects = webAppProjectCreator.getCreatedJavaProjects();
+    if (javaProjects == null) {


it doesnt appear that this should never return null - would it make more sense to test if empty? also, what do you think about List<IJavaProject>?

changed this to list

niloc132 · 2024-10-15T15:12:16Z

pom.xml

@@ -11,7 +11,7 @@
  <properties>
    <tycho.version>3.0.1</tycho.version>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-    <eclipse.target>2022-09</eclipse.target> <!-- TODO change to neon -->
+    <eclipse.target>2023-09</eclipse.target> <!-- TODO change to neon -->


probably can remove that TODO as long as you're updating the line...

removed todo

niloc132 · 2024-10-15T15:12:52Z

...gdt.eclipse.suite/project_templates/client_server_shared/client/src/_PACKAGENAME_/ui.gwt.xml

+  <!-- allow Super Dev Mode -->
+  <add-linker name="xsiframe"/>


No longer needed since GWT 2.7, almost 10 years gwtproject/gwt@22865ad

removed the xsiframe

niloc132 · 2024-10-15T15:24:32Z

...gdt.eclipse.suite/src/com/google/gdt/eclipse/suite/wizards/WebAppTemplateProjectCreator.java

+        throw new IOException("File to large");
+      }
+      byte[] data = Files.readAllBytes(path);
+      String str = new String(data, cset);


Are you sure we want the default charset here, rather than just assuming utf8 everywhere?

changed to UTF-8

niloc132 · 2024-10-15T15:25:12Z

...gdt.eclipse.suite/src/com/google/gdt/eclipse/suite/wizards/WebAppTemplateProjectCreator.java

+      BufferedWriter writer = Files.newBufferedWriter(path, cset);
+      writer.write(newStr);
+      writer.close();


try-with-resources, otherwise if the write fails this might not get closed (and then you've got a broken project, and windows won't let it be deleted or the like)

(goes away if you use Files.write())

changed to Files.writeString()

niloc132 · 2024-10-15T15:37:11Z

....gwtplugins.gdt.eclipse.core/src/com/google/gdt/eclipse/core/resources/ProjectResources.java

   * @param file
   * @throws CoreException
   */
  public static void reformatJavaSource(File file) throws CoreException {
    try {
-      String generatedSource = textFromFile(file);
+      String generatedSource = Files.readString(file.toPath(), Charset.defaultCharset());


consider if we really want the default charset here, or just assume utf8?

This has been default charset in the previous implementation. Didn't want to change that. Just simplified the Code by using an existing JRE method.

niloc132 · 2024-10-15T15:38:42Z

...gdt.eclipse.suite/src/com/google/gdt/eclipse/suite/wizards/WebAppTemplateProjectCreator.java

+      String str = new String(data, cset);
+      String newStr = str.replaceAll(pattern, replacement);
+      BufferedWriter writer = Files.newBufferedWriter(path, cset);
+      writer.write(newStr);


if we've got the full string in memory... why buffer? why not just use Files.write(...)?

see comment above

niloc132 · 2024-10-15T15:39:53Z

...gdt.eclipse.suite/src/com/google/gdt/eclipse/suite/wizards/WebAppTemplateProjectCreator.java

+        String name = file.getName();
+        name = name.replace("_PACKAGENAME_", packageBaseName.replace('.', File.separatorChar));
+        File newFile = new File(file.getParentFile(), name);
+        newFile.getParentFile().mkdirs();


consider using java.nio.Files.createDirectories(..) here - the Files class will throw instead of silently fail (or letting you ignore the return value, as you're doing here).

changed to createDirectories

- javaProjects as List instead of Array - Copyright information updated / inserted - Fixed multithreading bug - removed xsiframe from gwt.xml file - replaced mkdirs() with Files.createDirectories() - Use UTF-8 instead of defaultCharset -Use Files.writeString() instead of BufferedWriter

- all renaming of files is done by using the same method. - allow filenames to contain the placeholder _PROJECTNAME_

keinhaar · 2024-10-27T16:31:20Z

It just uses modified versions of the files that are created by the sdk

Just use the archetype creators for generating the template files:
* https://github.com/tbroyer/gwt-maven-archetypes (Tomcat)

* https://github.com/NaluKit/gwt-maven-springboot-archetype (Spring Boot)
These are the suggested way creating a new project: https://www.gwtproject.org/gettingstarted-v2.html

I've created a maven based template using the instructions on the gettingstarted-v2 page. It runs just fine if used with maven, but there are some problems running it from eclipse:

It uses the jakarta enabled version of gwt-servlet, which is currently not supported by the plugin (maybe if you rename it manually?)
The module.gwt.xml specifies an empty source path, which will not be accepted when running from eclipse
The Eclipse Plugin can't create a valid launch command. I was able to create it manually and it works, but then maven will no longer work because of the changed source path.

To make it work from eclipse the following steps are required:

change <source path=""/> to <source path="MAINPACKAGE"/>
create a launcher manually with these arguments:
-remoteUI "${gwt_remote_ui_server_port}:${unique_id}" -startupUrl index.html -logLevel INFO -codeServerPort 9997 -port 8888 -war /YOURPATH/PROJECTNAME/PROJECTNAME-server/src/main/webapp module module

I'm in doubt if i should add it in this state.
Because i don't use maven, some maven user may decide this. @protoism, @FrankHossfeld? What do you think?

keinhaar · 2024-10-27T16:32:40Z

@protoism
I've fixed all the things that collin suggested.

keinhaar requested a review from protoism September 29, 2024 16:00

Updated eclipse base to 2023-09

ddb8276

niloc132 reviewed Oct 15, 2024

View reviewed changes

keinhaar added 2 commits October 27, 2024 14:14

Unified the File renaming

d741ee5

- all renaming of files is done by using the same method. - allow filenames to contain the placeholder _PROJECTNAME_

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added Template based Project Wizard #499

Added Template based Project Wizard #499

keinhaar commented Sep 29, 2024

protoism commented Sep 30, 2024

keinhaar commented Sep 30, 2024 •

edited

Loading

FrankHossfeld commented Sep 30, 2024 •

edited

Loading

FrankHossfeld commented Sep 30, 2024 •

edited

Loading

keinhaar commented Oct 14, 2024

niloc132 left a comment

niloc132 Oct 15, 2024

keinhaar Oct 27, 2024

niloc132 Oct 15, 2024

keinhaar Oct 27, 2024

niloc132 Oct 15, 2024

keinhaar Oct 27, 2024

niloc132 Oct 15, 2024

keinhaar Oct 27, 2024

niloc132 Oct 15, 2024

keinhaar Oct 27, 2024

niloc132 Oct 15, 2024

keinhaar Oct 27, 2024

niloc132 Oct 15, 2024

keinhaar Oct 27, 2024

niloc132 Oct 15, 2024

keinhaar Oct 27, 2024

niloc132 Oct 15, 2024

keinhaar Oct 27, 2024

niloc132 Oct 15, 2024

keinhaar Oct 27, 2024

keinhaar commented Oct 27, 2024

keinhaar commented Oct 27, 2024

		@@ -0,0 +1,130 @@
		/*******************************************************************************
		* Copyright 2011 Google Inc. All Rights Reserved.

		javaProjects = webAppProjectCreator.getCreatedJavaProjects();
		if (javaProjects == null) {

Added Template based Project Wizard #499

Are you sure you want to change the base?

Added Template based Project Wizard #499

Conversation

keinhaar commented Sep 29, 2024

protoism commented Sep 30, 2024

keinhaar commented Sep 30, 2024 • edited Loading

FrankHossfeld commented Sep 30, 2024 • edited Loading

FrankHossfeld commented Sep 30, 2024 • edited Loading

keinhaar commented Oct 14, 2024

niloc132 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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

keinhaar commented Oct 27, 2024

keinhaar commented Oct 27, 2024

keinhaar commented Sep 30, 2024 •

edited

Loading

FrankHossfeld commented Sep 30, 2024 •

edited

Loading

FrankHossfeld commented Sep 30, 2024 •

edited

Loading