]> source.dussan.org Git - vaadin-framework.git/commitdiff
Remove whitespace-maven-plugin and formatter-maven-plugin. (#12213)
authorAnna Koskinen <Ansku@users.noreply.github.com>
Wed, 3 Mar 2021 11:59:50 +0000 (13:59 +0200)
committerGitHub <noreply@github.com>
Wed, 3 Mar 2021 11:59:50 +0000 (13:59 +0200)
- These plugins cause significant problems for many Windows developers,
and since most active maintainers are currently included in that group,
the plugins have been deemed more trouble than they are worth.

.github/CONTRIBUTING.md
README-DEV.md
client/pom.xml
pom.xml
server/pom.xml
shared/pom.xml
testbench-api/pom.xml
uitest/pom.xml

index 4e5c692ad4bf7cc5fe7f2ce7d10818aa5340c1ad..cbae52717d03ec1647b3b93cee274f448beff4d0 100644 (file)
@@ -14,8 +14,6 @@ Unless the issue is specific to a single version of the Framework, you should al
 
 In your repo, make a new branch from `master`. Make your code changes in that branch, and once you're done make a pull request to the `vaadin/framework` branch `master`.
 
-The `vaadin/framework` project uses `formatter-maven-plugin` to format the code. It will be executed as part of the Maven build. Make sure to run `mvn compile` before making the commit.
-
 We recommend making sure that the "Allow edits from maintainers" checkbox on the pull request page is checked. This allows us to commit minor fixes, like correcting typos, without bothering you.
 
 ### Getting feedback and responding to it
index c8135f4580d0090b463e5cb36fbaf3b30a407b7f..2cb1e2f0dd63ec9eee5d0f541de2dca5a72a89af 100644 (file)
@@ -119,7 +119,6 @@ After that is done, you should have 9 of 28 save actions activated and listed as
 Run <code>install</code> maven goal for the project root to get started.
 In Eclipse this is done by right-clicking on the project root in Project Explorer and choosing *Run As* -> *Maven Build...*. If you choose to skip tests you may need to run the <code>install</code> maven goal for `vaadin-uitest` project separately.
 * Note that the first compilation takes a while to finish as Maven downloads dependencies used in the projects.
-* In some Windows environments the compilation doesn't respect the `core.autocrlf=false` and the workspace preferences listed in the previous section, and running <code>install</code> converts all line endings from six core projects (root, `vaadin-client`, `vaadin-server`,  `vaadin-shared`, `vaadin-testbench-api`, `vaadin-uitest`) to Windows-style. As a quick-and-dirty workaround you can change the line endings back through *File* -> *Convert Line Delimiters To* -> *Unix* and comment out references to plugins `net.revelc.code.formatter` and `com.github.dantwining.whitespace-maven-plugin` from each affected module's pom.xml (root project references them twice) to prevent it from happening again. *Do not* include those changes or any files with Windows-style line endings in any pull request. Because you consequently lose the formatting benefits of those plugins, you also need to be more careful about not including irrelevant formatting changes in your commits.
 
 Now the project should compile without further configuration.
 
index 9b77989bc8377934f04570ee72c67d1b3215e836..1af8b0af5f7436a8e7e2cede58636293b8c1a710 100644 (file)
 
     <build>
         <plugins>
-            <plugin>
-                <groupId>net.revelc.code.formatter</groupId>
-                <artifactId>formatter-maven-plugin</artifactId>
-            </plugin>
-            <plugin>
-                <groupId>com.github.dantwining.whitespace-maven-plugin</groupId>
-                <artifactId>whitespace-maven-plugin</artifactId>
-            </plugin>
-
             <plugin>
                 <artifactId>maven-resources-plugin</artifactId>
                 <executions>
diff --git a/pom.xml b/pom.xml
index fb75074ef268d2b8228dedbe87cbf334090695ef..300ee9715a3d416c35a0c34cbe3585d4ea19f5aa 100644 (file)
--- a/pom.xml
+++ b/pom.xml
                     <artifactId>vaadin-maven-plugin</artifactId>
                     <version>${vaadin.plugin.version}</version>
                 </plugin>
-                <plugin>
-                    <groupId>net.revelc.code.formatter</groupId>
-                    <artifactId>formatter-maven-plugin</artifactId>
-                    <version>2.7.2</version>
-                    <configuration>
-                        <configFile>${project.basedir}/../eclipse/VaadinJavaConventions.xml</configFile>
-                        <skipJsFormatting>true</skipJsFormatting>
-                    </configuration>
-                    <executions>
-                        <execution>
-                            <id>format-source</id>
-                            <goals>
-                                <goal>format</goal>
-                            </goals>
-                            <phase>process-sources</phase>
-                        </execution>
-                    </executions>
-                </plugin>
-                <plugin>
-                    <groupId>com.github.dantwining.whitespace-maven-plugin</groupId>
-                    <artifactId>whitespace-maven-plugin</artifactId>
-                    <version>1.0.4</version>
-                    <executions>
-                        <execution>
-                            <id>trim-trailing-spaces-source</id>
-                            <goals>
-                                <goal>trim</goal>
-                            </goals>
-                            <phase>process-sources</phase>
-                        </execution>
-                    </executions>
-                </plugin>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-checkstyle-plugin</artifactId>
                                         <ignore></ignore>
                                     </action>
                                 </pluginExecution>
-                                <pluginExecution>
-                                    <pluginExecutionFilter>
-                                        <groupId>
-                                            net.revelc.code.formatter
-                                        </groupId>
-                                        <artifactId>
-                                            formatter-maven-plugin
-                                        </artifactId>
-                                        <versionRange>
-                                            [2.7.2,)
-                                        </versionRange>
-                                        <goals>
-                                            <goal>format</goal>
-                                        </goals>
-                                    </pluginExecutionFilter>
-                                    <action>
-                                        <ignore></ignore>
-                                    </action>
-                                </pluginExecution>
-                                <pluginExecution>
-                                    <pluginExecutionFilter>
-                                        <groupId>
-                                            com.github.dantwining.whitespace-maven-plugin
-                                        </groupId>
-                                        <artifactId>
-                                            whitespace-maven-plugin
-                                        </artifactId>
-                                        <versionRange>
-                                            [1.0.4,)
-                                        </versionRange>
-                                        <goals>
-                                            <goal>trim</goal>
-                                        </goals>
-                                    </pluginExecutionFilter>
-                                    <action>
-                                        <ignore></ignore>
-                                    </action>
-                                </pluginExecution>
                             </pluginExecutions>
                         </lifecycleMappingMetadata>
                     </configuration>
index 98040a56015a5dfa2c89501cb107275e596a5d4b..977ec0c9fb2c1f29816840f76383de2c75830549 100644 (file)
 
     <build>
         <plugins>
-            <plugin>
-                <groupId>net.revelc.code.formatter</groupId>
-                <artifactId>formatter-maven-plugin</artifactId>
-            </plugin>
-            <plugin>
-                <groupId>com.github.dantwining.whitespace-maven-plugin</groupId>
-                <artifactId>whitespace-maven-plugin</artifactId>
-            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-dependency-plugin</artifactId>
index f6e4c0e99bbb05b2868569600354e32264ea2cac..d339becaeed0d5b151f04cc30cbaa76d30dc4a34 100644 (file)
 
     <build>
         <plugins>
-            <plugin>
-                <groupId>net.revelc.code.formatter</groupId>
-                <artifactId>formatter-maven-plugin</artifactId>
-            </plugin>
-            <plugin>
-                <groupId>com.github.dantwining.whitespace-maven-plugin</groupId>
-                <artifactId>whitespace-maven-plugin</artifactId>
-            </plugin>
-
             <!-- Generated Version.java -->
             <plugin>
                 <groupId>org.codehaus.mojo</groupId>
index 23a7a5b5c886b8d9576606c35962be4c0dbd35f3..5d2ddb2dc52c56942eb47a5efdd98683bf80b678 100644 (file)
 
     <build>
         <plugins>
-            <plugin>
-                <groupId>net.revelc.code.formatter</groupId>
-                <artifactId>formatter-maven-plugin</artifactId>
-            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-checkstyle-plugin</artifactId>
index ff2589ad3a73a8437a5b094dcd9be6445af39fea..0dd06d073e4d71b7190be746076f811fcdf90116 100644 (file)
 
 
         <plugins>
-            <plugin>
-                <groupId>net.revelc.code.formatter</groupId>
-                <artifactId>formatter-maven-plugin</artifactId>
-            </plugin>
-            <plugin>
-                <groupId>com.github.dantwining.whitespace-maven-plugin</groupId>
-                <artifactId>whitespace-maven-plugin</artifactId>
-            </plugin>
-
             <plugin>
                 <groupId>com.vaadin</groupId>
                 <artifactId>vaadin-maven-plugin</artifactId>