Skip to content

[POC] editorconfig-maven-plugin: implement IDE agnostic configuration #2321

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

[POC] editorconfig-maven-plugin: implement IDE agnostic configuration #2321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff92b84
Editorconfig maven plugin: implement IDE agnostic configuration with …
May 11, 2025
13d6477
Update .editorconfig to import only
Pankraz76 May 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions .editorconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.

[*]
charset = utf-8
end_of_line = lf
Copy link
Contributor Author

@Pankraz76 Pankraz76 May 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could merge without this. Try activating, then you see much files broken. preventing more. ATM dev setup seems broken, as not configured properly: https://dev.to/kevinshu/git-and-normalization-of-line-endings-228j

Suggested change
end_of_line = lf
#end_of_line = lf

Copy link
Contributor Author

@Pankraz76 Pankraz76 May 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need rewrite recipe for this

indent_style = space
insert_final_newline = true

[*.java]
ij_java_class_count_to_use_import_on_demand = 999
ij_java_names_count_to_use_import_on_demand = 999
Copy link
Contributor Author

@Pankraz76 Pankraz76 May 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe only the imports, as everything else is covered by spot.

Copy link
Member

@slawekjaranowski slawekjaranowski May 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

imports with asterix are forbidden be checkstyle

Copy link
Contributor Author

@Pankraz76 Pankraz76 May 12, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes but they will still happen. We need out of the box solution follow convention over config. ATM we have to config by hand this is the automat for whole world.

Copy link
Contributor Author

@Pankraz76 Pankraz76 May 12, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

intellij default is using * when having more then 5 imports. https://en.wikipedia.org/wiki/Convention_over_configuration
we have broken the contract therefore need to fix up again.

Copy link
Contributor Author

@Pankraz76 Pankraz76 May 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

openrewrite/rewrite#5413

2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@
.factorypath
.vscode/
repo/
/*.svg
/*.svg
2 changes: 1 addition & 1 deletion .mvn/readme.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
The .mvn directory is needed to be able to use the ${maven.multiModuleProjectDirectory} property.
The .mvn directory is needed to be able to use the ${maven.multiModuleProjectDirectory} property.
2 changes: 1 addition & 1 deletion apache-maven/src/assembly/maven/conf/toolchains.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,4 +101,4 @@ under the License.

-->

</toolchains>
</toolchains>
2 changes: 1 addition & 1 deletion apache-maven/src/main/appended-resources/licenses/BSD-2-Clause.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2 changes: 1 addition & 1 deletion apache-maven/src/main/appended-resources/licenses/BSD-3-Clause.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2 changes: 1 addition & 1 deletion apache-maven/src/main/appended-resources/licenses/EPL-2.0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,4 +274,4 @@ version(s), and exceptions or additional permissions here}."
file in a relevant directory) where a recipient would be likely to
look for such a notice.

You may add additional accurate notices of copyright ownership.
You may add additional accurate notices of copyright ownership.
2 changes: 1 addition & 1 deletion apache-maven/src/main/appended-resources/licenses/Public-Domain.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Public Domain
Public Domain
2 changes: 1 addition & 1 deletion api/maven-api-di/src/main/resources/META-INF/services/javax.annotation.processing.Processor
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
org.apache.maven.di.tool.DiIndexProcessor
org.apache.maven.di.tool.DiIndexProcessor
2 changes: 1 addition & 1 deletion api/maven-api-settings/src/site/apt/index.apt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ Maven 4 API - Immutable Settings Model
* {{{./apidocs/index.html}Java sources}} with <<<Builder>>> inner classes for immutable instances creation.

See also corresponding {{{../../maven-settings/index.html}Maven classical settings model documentation}}.


2 changes: 1 addition & 1 deletion api/maven-api-toolchain/src/site/apt/index.apt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ Maven 4 API - Immutable Toolchains Model
* {{{./apidocs/index.html}Java sources}} with <<<Builder>>> inner classes for immutable instances creation.

See also corresponding {{{../../maven-toolchain-model/index.html}Maven classical toolchains model documentation}}.


2 changes: 1 addition & 1 deletion compat/maven-builder-support/src/test/resources/source.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Hello World!
Hello World!
2 changes: 1 addition & 1 deletion ...at/maven-compat/src/main/resources/META-INF/maven/plugin-expressions/project.paramdoc.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,4 +169,4 @@ under the License.
]]></description>
</expression>
</expressions>
</paramdoc>
</paramdoc>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t00/maven/poms/p0-1.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@
<organization>
<name>Codehaus</name>
</organization>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t00/maven/poms/p1-1.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@
<scm>
<url>scm-url</url>
</scm>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t00/maven/poms/p2-1.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@
<name>mailing-list</name>
</mailingList>
</mailingLists>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t00/maven/poms/p3-1.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@
<name>p3</name>
<version>1.0</version>
<inceptionYear>2000</inceptionYear>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t00/maven/poms/p4-1.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@
<packaging>jar</packaging>
<name>p4</name>
<version>1.0</version>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t04/maven-test/poms/t04-a-1.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@
<version>2.0</version>
</dependency>
</dependencies>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t04/maven-test/poms/t04-b-1.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
<artifactId>t04-b</artifactId>
<packaging>jar</packaging>
<version>1.0</version>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t04/maven-test/poms/t04-b-2.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
<artifactId>t04-b</artifactId>
<packaging>jar</packaging>
<version>2.0</version>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t04/maven-test/poms/t04-c-1.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
<artifactId>t04-c</artifactId>
<packaging>jar</packaging>
<version>1.0</version>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t04/maven-test/poms/t04-c-2.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
<artifactId>t04-b</artifactId>
<packaging>jar</packaging>
<version>2.0</version>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t04/p0/p1/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@
</plugin>
</plugins>
</build>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t05/maven-test/poms/t05-a-1.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@
<scope>compile</scope>
</dependency>
</dependencies>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t05/maven-test/poms/t05-a-2.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@
<scope>compile</scope>
</dependency>
</dependencies>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t05/maven-test/poms/t05-b-1.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@
<optional>false</optional>
</dependency>
</dependencies>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t05/maven-test/poms/t05-b-1.1.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@
<optional>false</optional>
</dependency>
</dependencies>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t05/maven-test/poms/t05-b-2.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@
<optional>false</optional>
</dependency>
</dependencies>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t05/maven-test/poms/t05-c-1.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@
<optional>true</optional>
</dependency>
</dependencies>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t05/maven-test/poms/t05-d-1.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
<artifactId>t05-d</artifactId>
<packaging>jar</packaging>
<version>1.0</version>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t05/maven-test/poms/t05-d-1.1.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
<artifactId>t05-d</artifactId>
<packaging>jar</packaging>
<version>1.1</version>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t05/maven-test/poms/t05-d-1.2.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
<artifactId>t05-d</artifactId>
<packaging>jar</packaging>
<version>1.2</version>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t05/p0/p1/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@
</plugin>
</plugins>
</build>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t05/p0/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@
</dependency>
</dependencies>
</dependencyManagement>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t06/maven-test/poms/t06-a-1.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@
<scope>compile</scope>
</dependency>
</dependencies>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t06/maven-test/poms/t06-b-1.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@
<optional>false</optional>
</dependency>
</dependencies>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t06/maven-test/poms/t06-b-1.1.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@
<optional>false</optional>
</dependency>
</dependencies>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t06/maven-test/poms/t06-c-1.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@
<optional>true</optional>
</dependency>
</dependencies>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t06/maven-test/poms/t06-d-1.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
<artifactId>t06-d</artifactId>
<packaging>jar</packaging>
<version>1.0</version>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t06/maven-test/poms/t06-d-1.1.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
<artifactId>t06-d</artifactId>
<packaging>jar</packaging>
<version>1.1</version>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t06/maven-test/poms/t06-d-1.2.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
<artifactId>t06-d</artifactId>
<packaging>jar</packaging>
<version>1.2</version>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t06/p0/p1/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@
</plugin>
</plugins>
</build>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t06/p0/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@
</dependency>
</dependencies>
</dependencyManagement>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t07/maven-test/poms/t07-a-1.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@
<scope>compile</scope>
</dependency>
</dependencies>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t07/maven-test/poms/t07-b-1.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@
<optional>true</optional>
</dependency>
</dependencies>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t07/maven-test/poms/t07-b-1.1.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@
<optional>true</optional>
</dependency>
</dependencies>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t07/maven-test/poms/t07-c-1.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@
<optional>true</optional>
</dependency>
</dependencies>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t07/maven-test/poms/t07-d-1.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
<artifactId>t07-d</artifactId>
<packaging>jar</packaging>
<version>1.0</version>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t07/maven-test/poms/t07-d-1.1.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
<artifactId>t07-d</artifactId>
<packaging>jar</packaging>
<version>1.1</version>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t07/maven-test/poms/t07-d-1.2.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
<artifactId>t07-d</artifactId>
<packaging>jar</packaging>
<version>1.2</version>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t07/p0/p1/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@
</plugin>
</plugins>
</build>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t07/p0/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@
</dependency>
</dependencies>
</dependencyManagement>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t08/maven-test/poms/t08-a-1.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@
<scope>compile</scope>
</dependency>
</dependencies>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t08/maven-test/poms/t08-b-1.0.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@
<optional>false</optional>
</dependency>
</dependencies>
</project>
</project>
2 changes: 1 addition & 1 deletion compat/maven-compat/src/test/resources/inheritance-repo/t08/maven-test/poms/t08-b-1.1.pom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@
<optional>false</optional>
</dependency>
</dependencies>
</project>
</project>
Loading