Skip to content

Commit

Permalink
[fj-doc-maven-plugin] updated readme information for quarkus-3 flavour
Browse files Browse the repository at this point in the history
  • Loading branch information
fugerit79 committed Oct 16, 2024
1 parent 9643624 commit fdb066a
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 6 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Changed

- [fj-doc-maven-plugin] updated readme information for quarkus-3 flavour
- [fj-doc-guide] added pdf documentation
- [fj-doc-playground-quarkus] fj-doc-ext-kotlin-version set to 0.4.2

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import org.fugerit.java.doc.project.facade.FlavourFacade;
import org.fugerit.java.doc.project.facade.FlavourContext;
import org.fugerit.java.doc.project.facade.ModuleFacade;
import org.fugerit.java.doc.project.facade.VersionCheck;

import java.io.File;

Expand Down Expand Up @@ -60,6 +61,8 @@ public void execute() throws MojoExecutionException, MojoFailureException {
context.setModules( ModuleFacade.toModuleList( this.extensions ) );
context.setAddLombok( this.addLombok );
context.setFlavourVersion( this.flavourVersion );
context.setVersion( VersionCheck.findVersion( this.version ) );
context.setExtensions( this.extensions );
this.getLog().info( String.format( "flavour context : %s", context ) );
FlavourFacade.initProject( context );
} );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,17 @@

import lombok.extern.slf4j.Slf4j;
import org.apache.maven.model.*;
import org.apache.maven.plugin.lifecycle.Execution;
import org.codehaus.plexus.util.xml.Xpp3Dom;
import org.codehaus.plexus.util.xml.Xpp3DomBuilder;
import org.fugerit.java.core.cfg.ConfigRuntimeException;
import org.fugerit.java.core.io.helper.HelperIOException;
import org.fugerit.java.core.lang.helpers.BooleanUtils;
import org.fugerit.java.core.lang.helpers.StringUtils;
import org.fugerit.java.doc.freemarker.tool.FreeMarkerTemplateSyntaxVerifier;
import org.maxxq.maven.dependency.ModelIO;

import java.io.*;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import java.util.Properties;
import java.util.stream.Collectors;

@Slf4j
public class BasicVenusFacade {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,12 @@ public class FlavourContext {
@Getter @Setter
private String flavourVersion;

@Getter @Setter
private String version;

@Getter @Setter
private String extensions;

private String toClassName( String base, String splitString ) {
StringBuilder buf = new StringBuilder();
String[] split = base.split( splitString );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,18 @@ Open the [swagger-ui](http://localhost:8080/q/swagger-ui/)

Test available paths (for instance : [/doc/example.md](http://localhost:8080/doc/example.md))

NOTE:
- Powered by Quarkus ${context.flavourVersion}
- Using Fugerit Venus Doc ${context.version} (extensions : ${context.extensions})

## Overview

This project has been initialized using [fj-doc-maven-plugin init goal](https://venusguides.fugerit.org/src/docs/wizard/fj-doc-maven-plugin_init.html).

The quarkus 3 structure is similar to running the quarkus create goal :

```shell
mvn io.quarkus.platform:quarkus-maven-plugin:3.14.2:create \
mvn io.quarkus.platform:quarkus-maven-plugin:${context.flavourVersion}:create \
-DprojectGroupId=${context.groupId} \
-DprojectArtifactId=${context.artifactId} \
-Dextensions='rest,rest-jackson,config-yaml,smallrye-openapi'
Expand Down

0 comments on commit fdb066a

Please sign in to comment.