Skip to content

Commit

Permalink
Move code generation to log4j-codegen artifact
Browse files Browse the repository at this point in the history 
The code generation code is moved from `log4j-core` to a new
`log4j-codegen` module. Additionally:

* The embedded PicoCLI copy is replaced with an external PicoCLI dependency.
* `log4j-codegen` publishes a shaded artifact with the classifier
  `shaded`.
* We add a documentation page with basic usage.
  • Loading branch information
@ppkarwasz
ppkarwasz committed Oct 18, 2024
1 parent 030f5d6 commit 1354dfa
Show file tree
Hide file tree
Showing 14 changed files with 458 additions and 5,911 deletions.
10 changes: 6 additions & 4 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,19 @@
# See the License for the specific language governing permissions and
# limitations under the License.

target/
# IntelliJ IDEA
.idea
*.iml
*.iws
/out
.flattened-pom.xml
/.mvn/wrapper/maven-wrapper.jar
# Eclipse
.project
.classpath
.settings/
# Generated by Maven
.flattened-pom.xml
dependency-reduced-pom.xml
/.mvn/wrapper/maven-wrapper.jar
target/
# Node
node
node_modules
Expand Down
157 changes: 157 additions & 0 deletions log4j-codegen/pom.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ 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.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-transform-parent</artifactId>
<version>${revision}</version>
<relativePath>../log4j-transform-parent</relativePath>
</parent>

<artifactId>log4j-codegen</artifactId>
<name>Apache Log4j Code generator</name>
<description>Generates wrappers for Log4j code loggers.</description>

<properties>
<!-- Disabling `bnd-baseline-maven-plugin`, since we don't have a release yet to compare against. -->
<bnd.baseline.fail.on.missing>false</bnd.baseline.fail.on.missing>

<Main-Class>org.apache.logging.log4j.codegen.Generate</Main-Class>

<!-- Plugin versions -->
<maven-shade-plugin.version>3.4.1</maven-shade-plugin.version>

<!-- Dependencies -->
<picocli.version>4.7.5</picocli.version>
</properties>

<dependencies>

<dependency>
<groupId>org.osgi</groupId>
<artifactId>org.osgi.annotation.bundle</artifactId>
<scope>provided</scope>
</dependency>

<dependency>
<groupId>org.osgi</groupId>
<artifactId>org.osgi.annotation.versioning</artifactId>
<scope>provided</scope>
</dependency>

<dependency>
<groupId>com.github.spotbugs</groupId>
<artifactId>spotbugs-annotations</artifactId>
<scope>provided</scope>
</dependency>

<!-- Compile dependencies: the artifact is shaded, so limit these to the maximum -->
<dependency>
<groupId>info.picocli</groupId>
<artifactId>picocli</artifactId>
<version>${picocli.version}</version>
</dependency>

<!-- Test dependencies -->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api-test</artifactId>
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-api</artifactId>
<scope>test</scope>
</dependency>

</dependencies>

<build>

<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<annotationProcessorPaths combine.children="append">
<path>
<groupId>info.picocli</groupId>
<artifactId>picocli-codegen</artifactId>
<version>${picocli.version}</version>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>${maven-shade-plugin.version}</version>
<dependencies>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-transform-maven-shade-plugin-extensions</artifactId>
<version>${project.version}</version>
</dependency>
</dependencies>
<executions>
<execution>
<id>shade-jar-with-dependencies</id>
<goals>
<goal>shade</goal>
</goals>
<configuration>
<filters>
<filter>
<artifact>*:*</artifact>
<excludes>
<exclude>module-info.class</exclude>
<exclude>META-INF/versions/*/module-info.class</exclude>
<exclude>META-INF/MANIFEST.MF</exclude>
</excludes>
</filter>
</filters>
<shadedArtifactAttached>true</shadedArtifactAttached>
<shadedClassifierName>shaded</shadedClassifierName>
<transformers>
<transformer implementation="org.apache.maven.plugins.shade.resource.ApacheLicenseResourceTransformer" />
<transformer implementation="org.apache.maven.plugins.shade.resource.ApacheNoticeResourceTransformer" />
<transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer" />
<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
<manifestEntries>
<Multi-Release>true</Multi-Release>
</manifestEntries>
</transformer>
</transformers>
</configuration>
</execution>
</executions>
</plugin>
</plugins>

</build>

</project>
Loading

0 comments on commit 1354dfa

Please sign in to comment.