Merge branch 'master' into update-from-template-merged

Author: xdev-gh-bot

.config/pmd/java/ruleset.xml

@@ -194,4 +194,25 @@
 	</rule>
 
 	<rule ref="category/java/security.xml"/>
+
+	<rule name="VaadinNativeHTMLUnsafe"
+		language="java"
+		message="Unescaped native HTML is unsafe and will result in XSS vulnerabilities"
+		class="net.sourceforge.pmd.lang.rule.xpath.XPathRule" >
+		<description>
+			Do not used native HTML! Use Vaadin layouts and components to create required structure.
+			If you are 100% sure that you escaped the value properly and you have no better options you can suppress this.
+		</description>
+		<priority>2</priority>
+		<properties>
+			<property name="xpath">
+				<value>
+<![CDATA[
+//ConstructorCall[pmd-java:typeIs('com.vaadin.flow.component.Html')] |
+//MethodCall[@MethodName='setAttribute' and //ImportDeclaration[starts-with(@PackageName,'com.vaadin')]]/ArgumentList/StringLiteral[1][contains(lower-case(@Image),'html')]
+]]>
+				</value>
+			</property>
+		</properties>
+	</rule>
 </ruleset>

.github/workflows/check-build.yml

@@ -44,7 +44,7 @@ jobs:
         cache: 'maven'
 
     - name: Build with Maven
-      run: ./mvnw -B clean package
+      run: ./mvnw -B clean package -Pproduction
 
     - name: Check for uncommited changes
       run: |
@@ -60,7 +60,7 @@ jobs:
           echo ----------------------------------------
           echo Troubleshooting
           echo ----------------------------------------
-          echo "::error::Unstaged changes detected. Locally try running: git clean -ffdx && ./mvnw -B clean package"
+          echo "::error::Unstaged changes detected. Locally try running: git clean -ffdx && ./mvnw -B clean package -Pproduction"
           exit 1
         fi
 

.github/workflows/release.yml

@@ -26,7 +26,7 @@ jobs:
         cache: 'maven'
 
     - name: Build with Maven
-      run: ./mvnw -B clean package -T2C
+      run: ./mvnw -B clean package -Pproduction -T2C
 
     - name: Check for uncommited changes
       run: |
@@ -42,7 +42,7 @@ jobs:
           echo ----------------------------------------
           echo Troubleshooting
           echo ----------------------------------------
-          echo "::error::Unstaged changes detected. Locally try running: git clean -ffdx && ./mvnw -B clean package"
+          echo "::error::Unstaged changes detected. Locally try running: git clean -ffdx && ./mvnw -B clean package -Pproduction"
           exit 1
         fi
 
@@ -108,6 +108,9 @@ jobs:
           </dependency>
           ```
 
+          ### Additional notes
+          * [Spring-Boot] You may have to include ``software/xdev`` inside [``vaadin.allowed-packages``](https://vaadin.com/docs/latest/integrations/spring/configuration#configure-the-scanning-of-packages)
+
   publish-maven:
     runs-on: ubuntu-latest
     needs: [prepare-release]

.github/workflows/update-from-template.yml

@@ -21,7 +21,7 @@ on:
 env:
   UPDATE_BRANCH: update-from-template
   UPDATE_BRANCH_MERGED: update-from-template-merged
-  REMOTE_URL: https://github.com/xdev-software/standard-maven-template.git
+  REMOTE_URL: https://github.com/xdev-software/vaadin-addon-template.git
   REMOTE_BRANCH: master
 
 permissions:

.gitignore

@@ -57,6 +57,29 @@ hs_err_pid*
 /*/.project
 /*/RemoteSystemsTempFiles/
 
+
+#vaadin/node webpack/frontend stuff
+# Ignore Node
+node/
+
+# The following files are generated/updated by vaadin-maven-plugin
+node_modules/
+
+# Vaadin
+package.json
+package-lock.json
+webpack.generated.js
+webpack.config.js
+tsconfig.json
+types.d.ts
+vite.config.ts
+vite.generated.ts
+/*/src/main/frontend/generated/
+/*/src/main/frontend/index.html
+/*/src/main/dev-bundle/
+/*/src/main/bundles/
+*.lock
+
 #custom
 .flattened-pom.xml
 .tern-project

.run/Run Demo.run.xml

@@ -1,11 +1,11 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Run Demo" type="Application" factoryName="Application">
-    <option name="MAIN_CLASS_NAME" value="software.xdev.Application" />
+    <option name="MAIN_CLASS_NAME" value="software.xdev.vaadin.Application" />
     <module name="template-placeholder-demo" />
     <option name="WORKING_DIRECTORY" value="$MODULE_DIR$" />
     <extension name="coverage">
       <pattern>
-        <option name="PATTERN" value="software.xdev.*" />
+        <option name="PATTERN" value="software.xdev.vaadin.*" />
         <option name="ENABLED" value="true" />
       </pattern>
     </extension>

CONTRIBUTING.md

@@ -32,7 +32,20 @@ You should have the following things installed:
   * Import the project
   * Ensure that everything is encoded in ``UTF-8``
   * Ensure that the JDK/Java-Version is correct
-
+  * To enable AUTOMATIC reloading/restarting while developing and running the app do this (further information in "
+    SpringBoot-Devtools" section below; [Source](https://stackoverflow.com/q/33349456)):
+    * ``Settings > Build, Execution, Deployment > Compiler``:<br/>
+      Enable [``Build project automatically``](https://www.jetbrains.com/help/idea/compiling-applications.html#auto-build)
+    * ``Settings > Advanced Settings``:<br/>
+    Enable [``Allow auto-make to start even if developed application is currently running``](https://www.jetbrains.com/help/idea/advanced-settings.html#advanced_compiler)
+  * To launch the Demo execute the predefined (launch) configuration ``Run Demo``
+
+#### [SpringBoot-Developer-Tools](https://docs.spring.io/spring-boot/docs/current/reference/html/using.html#using.devtools) 
+... should automatically be enabled.<br/>
+If you are changing a file and build the project, parts of the app get  restarted.<br/>
+Bigger changes may require a complete restart.
+  * [Vaadin automatically reloads the UI on each restart](https://vaadin.com/docs/latest/configuration/live-reload/spring-boot).<br/>
+  You can control this behavior with the ``vaadin.devmode.liveReload.enabled`` property (default: ``true``).
 
 ## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/template-placeholder/release.yml?branch=master)](https://github.com/xdev-software/template-placeholder/actions/workflows/release.yml)
 
@@ -44,6 +57,7 @@ If the ``develop`` is ready for release, create a pull request to the ``master``
 
 When the release is finished do the following:
 * Merge the auto-generated PR (with the incremented version number) back into the ``develop``
+* Ensure that [Vaadin Directory](https://vaadin.com/directory) syncs the update and maybe update the component / version there
 
 ### Release failures
 

README.md

@@ -1,13 +1,32 @@
+[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0?logo=vaadin)](https://vaadin.com/directory/component/template-placeholder)
 [![Latest version](https://img.shields.io/maven-central/v/software.xdev/template-placeholder?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/template-placeholder)
 [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/template-placeholder/check-build.yml?branch=develop)](https://github.com/xdev-software/template-placeholder/actions/workflows/check-build.yml?query=branch%3Adevelop)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xdev-software_template-placeholder&metric=alert_status)](https://sonarcloud.io/dashboard?id=xdev-software_template-placeholder)
+![Vaadin 24+](https://img.shields.io/badge/Vaadin%20Platform/Flow-24+-00b4f0)
 
 # template-placeholder
+A Vaadin Template Repo
+
+![demo](assets/demo.png)
 
 
 ## Installation
 [Installation guide for the latest release](https://github.com/xdev-software/template-placeholder/releases/latest#Installation)
 
+### Spring-Boot
+* You may have to include ``software/xdev`` inside [``vaadin.allowed-packages``](https://vaadin.com/docs/latest/integrations/spring/configuration#configure-the-scanning-of-packages)
+
+## Run the Demo
+* Checkout the repo
+* Run ``mvn install && mvn -f template-placeholder-demo spring-boot:run``
+* Open http://localhost:8080
+
+<details>
+  <summary>Show example</summary>
+  
+  ![demo](assets/demo.avif)
+</details>
+
 ## Support
 If you need support as soon as possible and you can't wait for any pull request, feel free to use [our support](https://xdev.software/en/services/support).