Add .editorconfig to help with formatting

* Reformated imports for all Java files * Updated contributing.adoc
asciidoctor · Jan 27, 2024 · 89da447 · 89da447
1 parent 35ec5c0
commit 89da447
Show file tree

Hide file tree

Showing 74 changed files with 590 additions and 529 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,14 @@
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+tab_width = 4
+
+[*.java]
+ij_java_class_count_to_use_import_on_demand = 99
+ij_java_imports_layout = javax.**, java.**, |, *, |, $*
+
+[{*.yml,*.yaml}]
+indent_size = 2
diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
@@ -35,6 +35,7 @@ Improvements::
   * Upgrade Asciidoctorj to v2.5.10 and jRuby to v9.4.2.0 (#647)
   * Upgrade Asciidoctorj to v2.5.11 (#688)
   * Improve warning message when destination file is going to be replaced (#728)
+  * Added `.editorconfig` file to facilitate code formatting (#760)
 
 Build / Infrastructure::
 
@@ -66,7 +67,6 @@ Build / Infrastructure::
   * Automate release using GH Actions (#141)
   * Ensure Mojos use correct default values in unit tests (#609)
 
-
 Maintenance::
   * Replace use of reflection by direct JavaExtensionRegistry calls to register extensions (#596)
 

diff --git a/README.adoc b/README.adoc
@@ -1,8 +1,8 @@
 = Asciidoctor Maven Tools (Plugin & Site Integration)
 // Metadata
-:release-version: 2.2.2
+:release-version: 2.2.5
 :docs-version: 2.2
-:maven-site-plugin-version: 3.9.0
+:maven-site-plugin-version: 3.12.1
 // Settings
 :idprefix:
 :idseparator: -

diff --git a/...-module/src/test/java/org/asciidoctor/maven/site/AsciidoctorConverterDoxiaParserTest.java b/...-module/src/test/java/org/asciidoctor/maven/site/AsciidoctorConverterDoxiaParserTest.java
@@ -1,5 +1,11 @@
 package org.asciidoctor.maven.site;
 
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.FileReader;
+import java.io.Reader;
+import java.io.StringReader;
+
 import lombok.SneakyThrows;
 import org.apache.maven.doxia.parser.ParseException;
 import org.apache.maven.doxia.sink.Sink;
@@ -9,8 +15,6 @@
 import org.junit.jupiter.api.Test;
 import org.mockito.Mockito;
 
-import java.io.*;
-
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.catchThrowable;
 import static org.codehaus.plexus.util.ReflectionUtils.setVariableValueInObject;

diff --git a/asciidoctor-maven-commons/src/main/java/org/asciidoctor/maven/log/LogRecordFormatter.java b/asciidoctor-maven-commons/src/main/java/org/asciidoctor/maven/log/LogRecordFormatter.java
@@ -1,13 +1,13 @@
 package org.asciidoctor.maven.log;
 
-import org.asciidoctor.ast.Cursor;
-import org.asciidoctor.log.LogRecord;
-
 import java.io.File;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.stream.Collectors;
 
+import org.asciidoctor.ast.Cursor;
+import org.asciidoctor.log.LogRecord;
+
 public class LogRecordFormatter {
 
     private static final String MESSAGE_HEADER = "asciidoctor";

diff --git a/asciidoctor-maven-commons/src/main/java/org/asciidoctor/maven/log/LogRecordsProcessors.java b/asciidoctor-maven-commons/src/main/java/org/asciidoctor/maven/log/LogRecordsProcessors.java
@@ -1,12 +1,12 @@
 package org.asciidoctor.maven.log;
 
-import org.asciidoctor.log.LogRecord;
-import org.asciidoctor.log.Severity;
-
 import java.io.File;
 import java.util.List;
 import java.util.function.Consumer;
 
+import org.asciidoctor.log.LogRecord;
+import org.asciidoctor.log.Severity;
+
 public class LogRecordsProcessors {
 
     private final LogHandler logHandler;

diff --git a/asciidoctor-maven-commons/src/main/java/org/asciidoctor/maven/log/MemoryLogHandler.java b/asciidoctor-maven-commons/src/main/java/org/asciidoctor/maven/log/MemoryLogHandler.java
@@ -1,14 +1,14 @@
 package org.asciidoctor.maven.log;
 
-import org.asciidoctor.log.LogHandler;
-import org.asciidoctor.log.LogRecord;
-import org.asciidoctor.log.Severity;
-
 import java.util.ArrayList;
 import java.util.List;
 import java.util.function.Consumer;
 import java.util.stream.Collectors;
 
+import org.asciidoctor.log.LogHandler;
+import org.asciidoctor.log.LogRecord;
+import org.asciidoctor.log.Severity;
+
 
 /**
  * AsciidoctorJ LogHandler that stores records in memory.

diff --git a/...r-maven-commons/src/main/java/org/asciidoctor/maven/site/SiteConversionConfiguration.java b/...r-maven-commons/src/main/java/org/asciidoctor/maven/site/SiteConversionConfiguration.java
@@ -1,9 +1,9 @@
 package org.asciidoctor.maven.site;
 
-import org.asciidoctor.Options;
-
 import java.util.List;
 
+import org.asciidoctor.Options;
+
 public class SiteConversionConfiguration {
 
     private final Options options;

diff --git a/...n-commons/src/main/java/org/asciidoctor/maven/site/SiteConversionConfigurationParser.java b/...n-commons/src/main/java/org/asciidoctor/maven/site/SiteConversionConfigurationParser.java
@@ -1,5 +1,14 @@
 package org.asciidoctor.maven.site;
 
+import java.io.File;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+import java.util.Optional;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
 import org.apache.maven.project.MavenProject;
 import org.asciidoctor.AttributesBuilder;
 import org.asciidoctor.Options;
@@ -8,11 +17,6 @@
 import org.asciidoctor.maven.commons.StringUtils;
 import org.codehaus.plexus.util.xml.Xpp3Dom;
 
-import java.io.File;
-import java.util.*;
-import java.util.stream.Collectors;
-import java.util.stream.Stream;
-
 import static org.asciidoctor.maven.commons.StringUtils.isNotBlank;
 
 public class SiteConversionConfigurationParser {

diff --git a/...or-maven-commons/src/main/java/org/asciidoctor/maven/site/SiteLogHandlerDeserializer.java b/...or-maven-commons/src/main/java/org/asciidoctor/maven/site/SiteLogHandlerDeserializer.java
@@ -1,12 +1,12 @@
 package org.asciidoctor.maven.site;
 
+import java.util.Optional;
+
 import org.asciidoctor.log.Severity;
 import org.asciidoctor.maven.log.FailIf;
 import org.asciidoctor.maven.log.LogHandler;
 import org.codehaus.plexus.util.xml.Xpp3Dom;
 
-import java.util.Optional;
-
 public class SiteLogHandlerDeserializer {
 
     public static final String NODE_NAME = "logHandler";

diff --git a/...ctor-maven-commons/src/test/java/org/asciidoctor/maven/commons/AsciidoctorHelperTest.java b/...ctor-maven-commons/src/test/java/org/asciidoctor/maven/commons/AsciidoctorHelperTest.java
@@ -1,16 +1,16 @@
 package org.asciidoctor.maven.commons;
 
+import java.util.HashMap;
+import java.util.Map;
+import java.util.stream.Stream;
+
 import org.asciidoctor.Attributes;
 import org.asciidoctor.AttributesBuilder;
 import org.assertj.core.data.MapEntry;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.Arguments;
 import org.junit.jupiter.params.provider.MethodSource;
 
-import java.util.HashMap;
-import java.util.Map;
-import java.util.stream.Stream;
-
 import static org.asciidoctor.maven.commons.AsciidoctorHelper.addAttributes;
 import static org.assertj.core.api.Assertions.assertThat;
 

diff --git a/...idoctor-maven-commons/src/test/java/org/asciidoctor/maven/log/LogRecordFormatterTest.java b/...idoctor-maven-commons/src/test/java/org/asciidoctor/maven/log/LogRecordFormatterTest.java
@@ -1,14 +1,14 @@
 package org.asciidoctor.maven.log;
 
+import java.io.File;
+import java.io.IOException;
+
 import org.asciidoctor.ast.Cursor;
 import org.asciidoctor.log.LogRecord;
 import org.asciidoctor.log.Severity;
 import org.junit.jupiter.api.Test;
 import org.mockito.Mockito;
 
-import java.io.File;
-import java.io.IOException;
-
 import static java.lang.String.format;
 import static org.assertj.core.api.Assertions.assertThat;
 

diff --git a/...mmons/src/test/java/org/asciidoctor/maven/site/SiteConversionConfigurationParserTest.java b/...mmons/src/test/java/org/asciidoctor/maven/site/SiteConversionConfigurationParserTest.java
@@ -1,5 +1,11 @@
 package org.asciidoctor.maven.site;
 
+import java.io.File;
+import java.util.AbstractMap;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.Map;
+
 import org.apache.maven.model.Model;
 import org.apache.maven.project.MavenProject;
 import org.asciidoctor.Attributes;
@@ -9,13 +15,9 @@
 import org.codehaus.plexus.util.xml.Xpp3Dom;
 import org.junit.jupiter.api.Test;
 
-import java.io.File;
-import java.util.AbstractMap;
-import java.util.Arrays;
-import java.util.HashMap;
-import java.util.Map;
-
-import static org.asciidoctor.Options.*;
+import static org.asciidoctor.Options.ATTRIBUTES;
+import static org.asciidoctor.Options.BASEDIR;
+import static org.asciidoctor.Options.TEMPLATE_DIRS;
 import static org.assertj.core.api.Assertions.assertThat;
 
 class SiteConversionConfigurationParserTest {

diff --git a/asciidoctor-maven-plugin/src/main/java/org/asciidoctor/maven/AsciidoctorMojo.java b/asciidoctor-maven-plugin/src/main/java/org/asciidoctor/maven/AsciidoctorMojo.java
@@ -1,5 +1,19 @@
 package org.asciidoctor.maven;
 
+import javax.inject.Inject;
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.Set;
+import java.util.logging.Logger;
+
 import org.apache.commons.io.FilenameUtils;
 import org.apache.maven.plugin.AbstractMojo;
 import org.apache.maven.plugin.MojoExecutionException;
@@ -30,20 +44,6 @@
 import org.asciidoctor.maven.process.SourceDocumentFinder;
 import org.jruby.Ruby;
 
-import javax.inject.Inject;
-import java.io.File;
-import java.io.IOException;
-import java.nio.file.Path;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Map;
-import java.util.Optional;
-import java.util.Set;
-import java.util.logging.Logger;
-
 import static org.asciidoctor.maven.commons.StringUtils.isBlank;
 import static org.asciidoctor.maven.commons.StringUtils.isNotBlank;
 import static org.asciidoctor.maven.process.SourceDirectoryFinder.DEFAULT_SOURCE_DIR;

diff --git a/asciidoctor-maven-plugin/src/main/java/org/asciidoctor/maven/AsciidoctorRefreshMojo.java b/asciidoctor-maven-plugin/src/main/java/org/asciidoctor/maven/AsciidoctorRefreshMojo.java
@@ -1,5 +1,13 @@
 package org.asciidoctor.maven;
 
+import java.io.File;
+import java.io.FileFilter;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Optional;
+import java.util.Scanner;
+import java.util.StringJoiner;
+
 import org.apache.commons.io.filefilter.FileFilterUtils;
 import org.apache.commons.io.filefilter.IOFileFilter;
 import org.apache.commons.io.filefilter.NameFileFilter;
@@ -17,14 +25,6 @@
 import org.asciidoctor.maven.refresh.ResourcesPatternBuilder;
 import org.asciidoctor.maven.refresh.TimeCounter;
 
-import java.io.File;
-import java.io.FileFilter;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.Optional;
-import java.util.Scanner;
-import java.util.StringJoiner;
-
 import static org.asciidoctor.maven.commons.StringUtils.isNotBlank;
 import static org.asciidoctor.maven.process.SourceDocumentFinder.CUSTOM_FILE_EXTENSIONS_PATTERN_PREFIX;
 import static org.asciidoctor.maven.process.SourceDocumentFinder.CUSTOM_FILE_EXTENSIONS_PATTERN_SUFFIX;

diff --git a/asciidoctor-maven-plugin/src/main/java/org/asciidoctor/maven/AsciidoctorZipMojo.java b/asciidoctor-maven-plugin/src/main/java/org/asciidoctor/maven/AsciidoctorZipMojo.java
@@ -1,5 +1,8 @@
 package org.asciidoctor.maven;
 
+import java.io.File;
+import java.io.IOException;
+
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.MojoFailureException;
 import org.apache.maven.plugins.annotations.Component;
@@ -8,9 +11,6 @@
 import org.apache.maven.project.MavenProjectHelper;
 import org.asciidoctor.maven.io.Zips;
 
-import java.io.File;
-import java.io.IOException;
-
 @Mojo(name = "zip")
 public class AsciidoctorZipMojo extends AsciidoctorMojo {
     public static final String PREFIX = AsciidoctorMaven.PREFIX + "zip.";

diff --git a/asciidoctor-maven-plugin/src/main/java/org/asciidoctor/maven/http/AsciidoctorHandler.java b/asciidoctor-maven-plugin/src/main/java/org/asciidoctor/maven/http/AsciidoctorHandler.java
@@ -1,5 +1,10 @@
 package org.asciidoctor.maven.http;
 
+import java.io.ByteArrayOutputStream;
+import java.io.File;
+import java.io.FileInputStream;
+import java.nio.charset.StandardCharsets;
+
 import io.netty.buffer.ByteBuf;
 import io.netty.buffer.Unpooled;
 import io.netty.channel.ChannelFutureListener;
@@ -16,11 +21,6 @@
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.io.IOUtils;
 
-import java.io.ByteArrayOutputStream;
-import java.io.File;
-import java.io.FileInputStream;
-import java.nio.charset.StandardCharsets;
-
 public class AsciidoctorHandler extends SimpleChannelInboundHandler<FullHttpRequest> {
 
     private static final String HTML_MEDIA_TYPE = "text/html";

diff --git a/asciidoctor-maven-plugin/src/main/java/org/asciidoctor/maven/http/AsciidoctorHttpServer.java b/asciidoctor-maven-plugin/src/main/java/org/asciidoctor/maven/http/AsciidoctorHttpServer.java
@@ -1,5 +1,9 @@
 package org.asciidoctor.maven.http;
 
+import java.io.File;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.atomic.AtomicInteger;
+
 import io.netty.bootstrap.ServerBootstrap;
 import io.netty.channel.ChannelFutureListener;
 import io.netty.channel.ChannelInitializer;
@@ -14,10 +18,6 @@
 import io.netty.util.concurrent.Future;
 import org.apache.maven.plugin.logging.Log;
 
-import java.io.File;
-import java.util.concurrent.ExecutionException;
-import java.util.concurrent.atomic.AtomicInteger;
-
 /**
  * HTTP server to expose AsciiDoc converted sources.
  */

diff --git a/asciidoctor-maven-plugin/src/main/java/org/asciidoctor/maven/io/Zips.java b/asciidoctor-maven-plugin/src/main/java/org/asciidoctor/maven/io/Zips.java
@@ -1,14 +1,14 @@
 package org.asciidoctor.maven.io;
 
-import org.apache.commons.io.IOUtils;
-
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.FileOutputStream;
 import java.io.IOException;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipOutputStream;
 
+import org.apache.commons.io.IOUtils;
+
 public final class Zips {
 
     public static void zip(final File dir, final File zipName) throws IOException, IllegalArgumentException {