Skip to content

Commit

Permalink
Replace EOL jsdoc3 plugin with actual node jsdoc
Browse files Browse the repository at this point in the history 
Signed-off-by: Arjan Tijms <arjan.tijms@omnifish.ee>
  • Loading branch information
@arjantijms
arjantijms committed May 21, 2024
1 parent e0693d2 commit fcbbb47
Showing 1 changed file with 58 additions and 15 deletions.
73 changes: 58 additions & 15 deletions api/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -507,38 +507,80 @@ Use is subject to <a href="{@docRoot}/doc-files/speclicense.html" target="_top">
</plugins>
</build>



<profiles>
<profile>
<id>docs</id>
<build>
<plugins>
<!-- Create JS docs -->
<!-- result will be saved in /target/site/jsdoc -->
<!-- result will be saved in /src/main/resources/META-INF/resources/META-INF/resources/jakarta.faces/out -->
<plugin>
<groupId>com.phasebash.jsdoc</groupId>
<artifactId>jsdoc3-maven-plugin</artifactId>
<version>1.2.0</version>
<groupId>com.github.eirslett</groupId>
<artifactId>frontend-maven-plugin</artifactId>
<version>1.15.0</version>

<configuration>
<nodeVersion>v21.0.0</nodeVersion>
<npmVersion>10.8.0</npmVersion>
<installDirectory>./target/node</installDirectory>
<workingDirectory>src/main/resources/META-INF/resources/jakarta.faces</workingDirectory>
</configuration>
<executions>
<execution>
<id>generate-jsdoc</id>
<phase>prepare-package</phase>
<id>install node and npm</id>
<goals>
<goal>install-node-and-npm</goal>
</goals>
<phase>generate-resources</phase>
</execution>

<execution>
<id>npm install jsdoc</id>
<goals>
<goal>jsdoc3</goal>
<goal>npm</goal>
</goals>
<phase>generate-resources</phase>
<configuration>
<includePrivate>false</includePrivate>
<lenient>true</lenient>
<configFile>${project.build.directory}/../src/main/jsdoc/conf.json</configFile>
<sourceFiles>
<sourceFile>src/main/resources/META-INF/resources/jakarta.faces/faces-uncompressed.js</sourceFile>
</sourceFiles>
<arguments>install --save-dev jsdoc</arguments>
</configuration>
</execution>

<execution>
<id>npm run init</id>
<goals>
<goal>npm</goal>
</goals>
<phase>generate-resources</phase>
<configuration>
<arguments>init --force --yes</arguments>
</configuration>
</execution>

<execution>
<id>npm run build</id>
<goals>
<goal>npm</goal>
</goals>
<phase>generate-resources</phase>
<configuration>
<arguments>pkg set scripts.doc="jsdoc"</arguments>
</configuration>
</execution>

<execution>
<id>npm run build1</id>
<goals>
<goal>npm</goal>
</goals>
<phase>generate-resources</phase>
<configuration>
<arguments>run doc faces-uncompressed.js</arguments>
</configuration>
</execution>
</executions>
</plugin>


<!-- Create Renderkit docs -->
<!-- Result will be saved in /target/renderkitdoc -->
<plugin>
Expand Down Expand Up @@ -601,6 +643,7 @@ Use is subject to <a href="{@docRoot}/doc-files/speclicense.html" target="_top">
</plugin>



<!-- Create VDL docs -->
<!-- Result will be saved in /target/vdldoc -->

Expand Down

0 comments on commit fcbbb47

Please sign in to comment.