Compare commits
28 commits
Author | SHA1 | Date | |
---|---|---|---|
11a00fdc53 | |||
320f6a99e7 | |||
f2d61671ed | |||
eb630fb6cb | |||
b1cfaf643c | |||
e763ce32ed | |||
5f02107c7c | |||
22e259a78b | |||
52a6e1c049 | |||
45aae137f0 | |||
3dc7060ad5 | |||
5460413a5d | |||
4976d37b55 | |||
7f23fccca2 | |||
1055f0586f | |||
7adae0e1ff | |||
82da957696 | |||
77e3be82b6 | |||
600b46a9fb | |||
09aef884cb | |||
0a6be415e9 | |||
d4eec41040 | |||
7b7a17393c | |||
b8a02dce9e | |||
aa8d50d4cb | |||
ca811b1469 | |||
d797c515bb | |||
0983f323a2 |
25 changed files with 159 additions and 112 deletions
11
.github/workflows/bld.yml
vendored
11
.github/workflows/bld.yml
vendored
|
@ -1,15 +1,16 @@
|
||||||
name: bld-ci
|
name: bld-ci
|
||||||
|
|
||||||
on: [ push, pull_request, workflow_dispatch ]
|
on: [push, pull_request, workflow_dispatch]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build-bld-project:
|
build-bld-project:
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
java-version: [ 17, 21, 22 ]
|
java-version: [17, 21, 24]
|
||||||
kotlin-version: [ 1.19.24, 2.0.0 ]
|
kotlin-version: [1.9.25, 2.1.20]
|
||||||
|
os: [ ubuntu-latest, windows-latest, macos-latest ]
|
||||||
|
|
||||||
|
runs-on: ${{ matrix.os }}
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout source repository
|
- name: Checkout source repository
|
||||||
|
|
4
.github/workflows/pages.yml
vendored
4
.github/workflows/pages.yml
vendored
|
@ -47,11 +47,11 @@ jobs:
|
||||||
uses: actions/configure-pages@v3
|
uses: actions/configure-pages@v3
|
||||||
|
|
||||||
- name: Upload artifact
|
- name: Upload artifact
|
||||||
uses: actions/upload-pages-artifact@v1
|
uses: actions/upload-pages-artifact@v3
|
||||||
with:
|
with:
|
||||||
# Upload generated Javadocs repository
|
# Upload generated Javadocs repository
|
||||||
path: "build/javadoc/"
|
path: "build/javadoc/"
|
||||||
|
|
||||||
- name: Deploy to GitHub Pages
|
- name: Deploy to GitHub Pages
|
||||||
id: deployment
|
id: deployment
|
||||||
uses: actions/deploy-pages@v1
|
uses: actions/deploy-pages@v4
|
||||||
|
|
13
.idea/icon.svg
generated
Normal file
13
.idea/icon.svg
generated
Normal file
|
@ -0,0 +1,13 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||||
|
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
|
||||||
|
<svg width="100%" height="100%" viewBox="0 0 179 108" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
|
||||||
|
<g transform="matrix(1,0,0,1,-210.511,-96.3382)">
|
||||||
|
<g transform="matrix(1,0,0,1,-23.3386,-649.816)">
|
||||||
|
<g transform="matrix(0.221288,0,0,0.24,73.9536,390.254)">
|
||||||
|
<path d="M722.568,1482.92L722.568,1921.1L808.968,1921.1L808.968,1888.7C822.168,1907.9 846.168,1930.1 893.568,1930.1C933.168,1930.1 961.968,1917.5 985.368,1893.5C1012.97,1865.9 1027.37,1827.5 1027.37,1786.1C1027.37,1741.7 1011.17,1705.1 985.368,1680.5C961.968,1658.3 928.968,1644.5 892.368,1644.5C862.968,1644.5 830.568,1654.1 808.968,1683.5L808.968,1482.92L722.568,1482.92ZM871.368,1718.9C888.768,1718.9 903.768,1723.7 917.568,1736.9C930.168,1748.9 938.568,1766.3 938.568,1787.9C938.568,1807.7 930.168,1825.1 917.568,1837.1C904.368,1849.7 887.568,1855.7 872.568,1855.7C856.368,1855.7 837.168,1849.1 823.368,1835.9C813.168,1826.3 803.568,1810.1 803.568,1787.9C803.568,1765.1 812.568,1749.5 822.768,1738.7C836.568,1724.3 852.768,1718.9 871.368,1718.9Z" style="fill:rgb(35,146,255);fill-rule:nonzero;"/>
|
||||||
|
<rect x="1083.77" y="1482.92" width="86.4" height="438.182" style="fill:rgb(250,144,82);fill-rule:nonzero;"/>
|
||||||
|
<path d="M1531.37,1482.92L1444.97,1482.92L1444.97,1683.5C1423.37,1654.1 1390.97,1644.5 1361.57,1644.5C1324.97,1644.5 1291.97,1658.3 1268.57,1680.5C1242.77,1705.1 1226.57,1741.7 1226.57,1786.1C1226.57,1827.5 1240.97,1865.9 1268.57,1893.5C1291.97,1917.5 1320.77,1930.1 1360.37,1930.1C1407.77,1930.1 1431.77,1907.9 1444.97,1888.7L1444.97,1921.1L1531.37,1921.1L1531.37,1482.92ZM1382.57,1718.9C1401.17,1718.9 1417.37,1724.3 1431.17,1738.7C1441.37,1749.5 1450.37,1765.1 1450.37,1787.9C1450.37,1810.1 1440.77,1826.3 1430.57,1835.9C1416.77,1849.1 1397.57,1855.7 1381.37,1855.7C1366.37,1855.7 1349.57,1849.7 1336.37,1837.1C1323.77,1825.1 1315.37,1807.7 1315.37,1787.9C1315.37,1766.3 1323.77,1748.9 1336.37,1736.9C1350.17,1723.7 1365.17,1718.9 1382.57,1718.9Z" style="fill:rgb(35,146,255);fill-rule:nonzero;"/>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
</svg>
|
After Width: | Height: | Size: 2.4 KiB |
4
.idea/libraries/bld.xml
generated
4
.idea/libraries/bld.xml
generated
|
@ -2,12 +2,12 @@
|
||||||
<library name="bld">
|
<library name="bld">
|
||||||
<CLASSES>
|
<CLASSES>
|
||||||
<root url="file://$PROJECT_DIR$/lib/bld" />
|
<root url="file://$PROJECT_DIR$/lib/bld" />
|
||||||
<root url="jar://$USER_HOME$/.bld/dist/bld-2.1.0.jar!/" />
|
<root url="jar://$USER_HOME$/.bld/dist/bld-2.2.1.jar!/" />
|
||||||
<root url="file://$PROJECT_DIR$/lib/bld" />
|
<root url="file://$PROJECT_DIR$/lib/bld" />
|
||||||
</CLASSES>
|
</CLASSES>
|
||||||
<JAVADOC />
|
<JAVADOC />
|
||||||
<SOURCES>
|
<SOURCES>
|
||||||
<root url="jar://$USER_HOME$/.bld/dist/bld-2.1.0-sources.jar!/" />
|
<root url="jar://$USER_HOME$/.bld/dist/bld-2.2.1-sources.jar!/" />
|
||||||
<root url="file://$PROJECT_DIR$/lib/bld" />
|
<root url="file://$PROJECT_DIR$/lib/bld" />
|
||||||
</SOURCES>
|
</SOURCES>
|
||||||
<excluded>
|
<excluded>
|
||||||
|
|
2
.vscode/settings.json
vendored
2
.vscode/settings.json
vendored
|
@ -9,7 +9,7 @@
|
||||||
],
|
],
|
||||||
"java.configuration.updateBuildConfiguration": "automatic",
|
"java.configuration.updateBuildConfiguration": "automatic",
|
||||||
"java.project.referencedLibraries": [
|
"java.project.referencedLibraries": [
|
||||||
"${HOME}/.bld/dist/bld-2.1.0.jar",
|
"${HOME}/.bld/dist/bld-2.2.1.jar",
|
||||||
"lib/**/*.jar"
|
"lib/**/*.jar"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
12
README.md
12
README.md
|
@ -2,13 +2,19 @@
|
||||||
|
|
||||||
[](https://opensource.org/licenses/Apache-2.0)
|
[](https://opensource.org/licenses/Apache-2.0)
|
||||||
[](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)
|
[](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html)
|
||||||
[](https://rife2.com/bld)
|
[](https://rife2.com/bld)
|
||||||
[](https://repo.rife2.com/#/releases/com/uwyn/rife2/bld-dokka)
|
[](https://repo.rife2.com/#/releases/com/uwyn/rife2/bld-dokka)
|
||||||
[](https://repo.rife2.com/#/snapshots/com/uwyn/rife2/bld-dokka)
|
[](https://repo.rife2.com/#/snapshots/com/uwyn/rife2/bld-dokka)
|
||||||
[](https://github.com/rife2/bld-dokka/actions/workflows/bld.yml)
|
[](https://github.com/rife2/bld-dokka/actions/workflows/bld.yml)
|
||||||
|
|
||||||
To install, please refer to the [extensions](https://github.com/rife2/bld/wiki/Extensions) and [support](https://github.com/rife2/bld/wiki/Kotlin-Support)
|
To install the latest version, add the following to the `lib/bld/bld-wrapper.properties` file:
|
||||||
documentation.
|
|
||||||
|
```properties
|
||||||
|
bld.extension-dokka=com.uwyn.rife2:bld-dokka
|
||||||
|
```
|
||||||
|
|
||||||
|
For more information, please refer to the [extensions](https://github.com/rife2/bld/wiki/Extensions) documentation.
|
||||||
|
|
||||||
|
|
||||||
## Generate API Documentation
|
## Generate API Documentation
|
||||||
|
|
||||||
|
|
|
@ -7,9 +7,9 @@
|
||||||
<!-- BEST PRACTICES -->
|
<!-- BEST PRACTICES -->
|
||||||
<rule ref="category/java/bestpractices.xml">
|
<rule ref="category/java/bestpractices.xml">
|
||||||
<exclude name="AvoidPrintStackTrace"/>
|
<exclude name="AvoidPrintStackTrace"/>
|
||||||
<exclude name="JUnit4TestShouldUseTestAnnotation"/>
|
|
||||||
<exclude name="JUnitTestContainsTooManyAsserts"/>
|
|
||||||
<exclude name="GuardLogStatement"/>
|
<exclude name="GuardLogStatement"/>
|
||||||
|
<exclude name="UnitTestContainsTooManyAsserts"/>
|
||||||
|
<exclude name="UnitTestShouldUseTestAnnotation"/>
|
||||||
</rule>
|
</rule>
|
||||||
|
|
||||||
<rule ref="category/java/bestpractices.xml/MissingOverride">
|
<rule ref="category/java/bestpractices.xml/MissingOverride">
|
||||||
|
|
6
examples/.idea/bld.xml
generated
Normal file
6
examples/.idea/bld.xml
generated
Normal file
|
@ -0,0 +1,6 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="BldConfiguration">
|
||||||
|
<events />
|
||||||
|
</component>
|
||||||
|
</project>
|
4
examples/.idea/libraries/bld.xml
generated
4
examples/.idea/libraries/bld.xml
generated
|
@ -2,12 +2,12 @@
|
||||||
<library name="bld">
|
<library name="bld">
|
||||||
<CLASSES>
|
<CLASSES>
|
||||||
<root url="file://$PROJECT_DIR$/lib/bld" />
|
<root url="file://$PROJECT_DIR$/lib/bld" />
|
||||||
<root url="jar://$USER_HOME$/.bld/dist/bld-2.1.0.jar!/" />
|
<root url="jar://$USER_HOME$/.bld/dist/bld-2.2.1.jar!/" />
|
||||||
</CLASSES>
|
</CLASSES>
|
||||||
<JAVADOC />
|
<JAVADOC />
|
||||||
<SOURCES>
|
<SOURCES>
|
||||||
<root url="file://$PROJECT_DIR$/lib/bld" />
|
<root url="file://$PROJECT_DIR$/lib/bld" />
|
||||||
<root url="jar://$USER_HOME$/.bld/dist/bld-2.1.0-sources.jar!/" />
|
<root url="jar://$USER_HOME$/.bld/dist/bld-2.2.1-sources.jar!/" />
|
||||||
</SOURCES>
|
</SOURCES>
|
||||||
<excluded>
|
<excluded>
|
||||||
<root url="jar://$PROJECT_DIR$/lib/bld/bld-wrapper.jar!/" />
|
<root url="jar://$PROJECT_DIR$/lib/bld/bld-wrapper.jar!/" />
|
||||||
|
|
2
examples/.vscode/settings.json
vendored
2
examples/.vscode/settings.json
vendored
|
@ -9,7 +9,7 @@
|
||||||
],
|
],
|
||||||
"java.configuration.updateBuildConfiguration": "automatic",
|
"java.configuration.updateBuildConfiguration": "automatic",
|
||||||
"java.project.referencedLibraries": [
|
"java.project.referencedLibraries": [
|
||||||
"${HOME}/.bld/dist/bld-2.1.0.jar",
|
"${HOME}/.bld/dist/bld-2.2.1.jar",
|
||||||
"lib/**/*.jar"
|
"lib/**/*.jar"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
Binary file not shown.
|
@ -1,8 +1,8 @@
|
||||||
bld.downloadExtensionJavadoc=false
|
bld.downloadExtensionJavadoc=false
|
||||||
bld.downloadExtensionSources=true
|
bld.downloadExtensionSources=true
|
||||||
bld.downloadLocation=
|
bld.downloadLocation=
|
||||||
bld.extension-dokka=com.uwyn.rife2:bld-dokka:1.0.1
|
bld.extension-dokka=com.uwyn.rife2:bld-dokka:1.0.3
|
||||||
bld.extension-kotlin=com.uwyn.rife2:bld-kotlin:1.0.1
|
bld.extension-kotlin=com.uwyn.rife2:bld-kotlin:1.1.0-SNAPSHOT
|
||||||
bld.repositories=MAVEN_LOCAL,MAVEN_CENTRAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES
|
bld.repositories=MAVEN_LOCAL,MAVEN_CENTRAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES
|
||||||
bld.sourceDirectories=
|
bld.sourceDirectories=
|
||||||
bld.version=2.1.0
|
bld.version=2.2.1
|
||||||
|
|
|
@ -34,13 +34,14 @@ public class ExampleBuild extends Project {
|
||||||
|
|
||||||
repositories = List.of(MAVEN_LOCAL, MAVEN_CENTRAL, RIFE2_RELEASES);
|
repositories = List.of(MAVEN_LOCAL, MAVEN_CENTRAL, RIFE2_RELEASES);
|
||||||
|
|
||||||
final var kotlin = version(2, 0, 20);
|
final var kotlin = version(2, 1, 20);
|
||||||
scope(compile)
|
scope(compile)
|
||||||
.include(dependency("org.jetbrains.kotlin", "kotlin-stdlib", kotlin));
|
.include(dependency("org.jetbrains.kotlin", "kotlin-stdlib", kotlin));
|
||||||
scope(test)
|
scope(test)
|
||||||
.include(dependency("org.jetbrains.kotlin", "kotlin-test-junit5", kotlin))
|
.include(dependency("org.jetbrains.kotlin", "kotlin-test-junit5", kotlin))
|
||||||
.include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 11, 0)))
|
.include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 12, 1)))
|
||||||
.include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 11, 0)));
|
.include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 12, 1)))
|
||||||
|
.include(dependency("org.junit.platform", "junit-platform-launcher", version(1, 12, 1)));
|
||||||
|
|
||||||
// Include the Kotlin source directory when creating or publishing sources Java Archives
|
// Include the Kotlin source directory when creating or publishing sources Java Archives
|
||||||
jarSourcesOperation().sourceDirectories(new File(srcMainDirectory(), "kotlin"));
|
jarSourcesOperation().sourceDirectories(new File(srcMainDirectory(), "kotlin"));
|
||||||
|
|
Binary file not shown.
|
@ -1,8 +1,8 @@
|
||||||
bld.downloadExtensionJavadoc=false
|
bld.downloadExtensionJavadoc=false
|
||||||
bld.downloadExtensionSources=true
|
bld.downloadExtensionSources=true
|
||||||
bld.downloadLocation=
|
bld.downloadLocation=
|
||||||
bld.extension-exec=com.uwyn.rife2:bld-exec:1.0.3
|
bld.extension-exec=com.uwyn.rife2:bld-exec:1.0.4
|
||||||
bld.extension-pmd=com.uwyn.rife2:bld-pmd:1.1.5
|
bld.extension-pmd=com.uwyn.rife2:bld-pmd:1.2.1
|
||||||
bld.repositories=MAVEN_CENTRAL,MAVEN_LOCAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES
|
bld.repositories=MAVEN_CENTRAL,MAVEN_LOCAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES
|
||||||
bld.sourceDirectories=
|
bld.sourceDirectories=
|
||||||
bld.version=2.1.0
|
bld.version=2.2.1
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2023-2024 the original author or authors.
|
* Copyright 2023-2025 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -23,6 +23,7 @@ import rife.bld.publish.PublishLicense;
|
||||||
import rife.bld.publish.PublishScm;
|
import rife.bld.publish.PublishScm;
|
||||||
|
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
|
import java.util.Locale;
|
||||||
|
|
||||||
import static rife.bld.dependencies.Repository.*;
|
import static rife.bld.dependencies.Repository.*;
|
||||||
import static rife.bld.dependencies.Scope.compile;
|
import static rife.bld.dependencies.Scope.compile;
|
||||||
|
@ -33,15 +34,16 @@ public class DokkaOperationBuild extends Project {
|
||||||
public DokkaOperationBuild() {
|
public DokkaOperationBuild() {
|
||||||
pkg = "rife.bld.extension";
|
pkg = "rife.bld.extension";
|
||||||
name = "bld-dokka";
|
name = "bld-dokka";
|
||||||
version = version(1, 0, 1);
|
version = version(1, 0, 4, "SNAPSHOT");
|
||||||
|
|
||||||
javaRelease = 17;
|
javaRelease = 17;
|
||||||
|
|
||||||
downloadSources = true;
|
downloadSources = true;
|
||||||
autoDownloadPurge = true;
|
autoDownloadPurge = true;
|
||||||
|
|
||||||
repositories = List.of(MAVEN_LOCAL, MAVEN_CENTRAL, RIFE2_RELEASES, RIFE2_SNAPSHOTS);
|
repositories = List.of(MAVEN_LOCAL, MAVEN_CENTRAL, RIFE2_RELEASES, RIFE2_SNAPSHOTS);
|
||||||
|
|
||||||
var dokka = version(1, 9, 20);
|
var dokka = version(2, 0, 0);
|
||||||
scope(compile)
|
scope(compile)
|
||||||
.include(dependency("org.jetbrains.dokka", "dokka-cli", dokka))
|
.include(dependency("org.jetbrains.dokka", "dokka-cli", dokka))
|
||||||
.include(dependency("org.jetbrains.dokka", "dokka-base", dokka))
|
.include(dependency("org.jetbrains.dokka", "dokka-base", dokka))
|
||||||
|
@ -49,11 +51,11 @@ public class DokkaOperationBuild extends Project {
|
||||||
.include(dependency("org.jetbrains.dokka", "javadoc-plugin", dokka))
|
.include(dependency("org.jetbrains.dokka", "javadoc-plugin", dokka))
|
||||||
.include(dependency("org.jetbrains.dokka", "gfm-plugin", dokka))
|
.include(dependency("org.jetbrains.dokka", "gfm-plugin", dokka))
|
||||||
.include(dependency("org.jetbrains.dokka", "jekyll-plugin", dokka))
|
.include(dependency("org.jetbrains.dokka", "jekyll-plugin", dokka))
|
||||||
.include(dependency("com.uwyn.rife2", "bld", version(2, 1, 0)));
|
.include(dependency("com.uwyn.rife2", "bld", version(2, 2, 1)));
|
||||||
scope(test)
|
scope(test)
|
||||||
.include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 11, 0)))
|
.include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 12, 1)))
|
||||||
.include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 11, 0)))
|
.include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 12, 1)))
|
||||||
.include(dependency("org.assertj", "assertj-core", version(3, 26, 3)));
|
.include(dependency("org.assertj", "assertj-core", version(3, 27, 3)));
|
||||||
|
|
||||||
javadocOperation()
|
javadocOperation()
|
||||||
.javadocOptions()
|
.javadocOptions()
|
||||||
|
@ -63,28 +65,26 @@ public class DokkaOperationBuild extends Project {
|
||||||
|
|
||||||
publishOperation()
|
publishOperation()
|
||||||
.repository(version.isSnapshot() ? repository("rife2-snapshot") : repository("rife2"))
|
.repository(version.isSnapshot() ? repository("rife2-snapshot") : repository("rife2"))
|
||||||
|
.repository(repository("github"))
|
||||||
.info()
|
.info()
|
||||||
.groupId("com.uwyn.rife2")
|
.groupId("com.uwyn.rife2")
|
||||||
.artifactId(name)
|
.artifactId(name)
|
||||||
.description("bld Dokka Extension")
|
.description("bld Dokka Extension")
|
||||||
.url("https://github.com/rife2/bld-dokka")
|
.url("https://github.com/rife2/bld-dokka")
|
||||||
.developer(
|
.developer(new PublishDeveloper()
|
||||||
new PublishDeveloper()
|
.id("ethauvin")
|
||||||
.id("ethauvin")
|
.name("Erik C. Thauvin")
|
||||||
.name("Erik C. Thauvin")
|
.email("erik@thauvin.net")
|
||||||
.email("erik@thauvin.net")
|
.url("https://erik.thauvin.net/")
|
||||||
.url("https://erik.thauvin.net/")
|
|
||||||
)
|
)
|
||||||
.license(
|
.license(new PublishLicense()
|
||||||
new PublishLicense()
|
.name("The Apache License, Version 2.0")
|
||||||
.name("The Apache License, Version 2.0")
|
.url("https://www.apache.org/licenses/LICENSE-2.0.txt")
|
||||||
.url("https://www.apache.org/licenses/LICENSE-2.0.txt")
|
|
||||||
)
|
)
|
||||||
.scm(
|
.scm(new PublishScm()
|
||||||
new PublishScm()
|
.connection("scm:git:https://github.com/rife2/bld-dokka.git")
|
||||||
.connection("scm:git:https://github.com/rife2/bld-dokka.git")
|
.developerConnection("scm:git:git@github.com:rife2/bld-dokka.git")
|
||||||
.developerConnection("scm:git:git@github.com:rife2/bld-dokka.git")
|
.url("https://github.com/rife2/bld-dokka")
|
||||||
.url("https://github.com/rife2/bld-dokka")
|
|
||||||
)
|
)
|
||||||
.signKey(property("sign.key"))
|
.signKey(property("sign.key"))
|
||||||
.signPassphrase(property("sign.passphrase"));
|
.signPassphrase(property("sign.passphrase"));
|
||||||
|
@ -105,10 +105,13 @@ public class DokkaOperationBuild extends Project {
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public void test() throws Exception {
|
public void test() throws Exception {
|
||||||
new ExecOperation()
|
var os = System.getProperty("os.name");
|
||||||
.fromProject(this)
|
if (os != null && os.toLowerCase(Locale.US).contains("linux")) {
|
||||||
.command("scripts/cliargs.sh")
|
new ExecOperation()
|
||||||
.execute();
|
.fromProject(this)
|
||||||
|
.command("scripts/cliargs.sh")
|
||||||
|
.execute();
|
||||||
|
}
|
||||||
super.test();
|
super.test();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2023-2024 the original author or authors.
|
* Copyright 2023-2025 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -45,13 +45,13 @@ import java.util.stream.Collectors;
|
||||||
@SuppressWarnings("PMD.AvoidThrowingRawExceptionTypes")
|
@SuppressWarnings("PMD.AvoidThrowingRawExceptionTypes")
|
||||||
public class DokkaOperation extends AbstractProcessOperation<DokkaOperation> {
|
public class DokkaOperation extends AbstractProcessOperation<DokkaOperation> {
|
||||||
public static final String SEMICOLON = ";";
|
public static final String SEMICOLON = ";";
|
||||||
private final static String GFM_PLUGIN_REGEXP =
|
private static final String GFM_PLUGIN_REGEXP =
|
||||||
"^.*(dokka-base|analysis-kotlin-descriptors|gfm-plugin|freemarker).*\\.jar$";
|
"^.*(dokka-base|analysis-kotlin-descriptors|gfm-plugin|freemarker).*\\.jar$";
|
||||||
private final static String HTML_PLUGIN_REGEXP =
|
private static final String HTML_PLUGIN_REGEXP =
|
||||||
"^.*(dokka-base|analysis-kotlin-descriptors|kotlinx-html-jvm|freemarker).*\\.jar$";
|
"^.*(dokka-base|analysis-kotlin-descriptors|kotlinx-html-jvm|freemarker).*\\.jar$";
|
||||||
private final static String JAVADOC_PLUGIN_REGEXP =
|
private static final String JAVADOC_PLUGIN_REGEXP =
|
||||||
"^.*(dokka-base|analysis-kotlin-descriptors|javadoc-plugin|kotlin-as-java-plugin|korte-jvm).*\\.jar$";
|
"^.*(dokka-base|analysis-kotlin-descriptors|javadoc-plugin|kotlin-as-java-plugin|korte-jvm).*\\.jar$";
|
||||||
private final static String JEKYLL_PLUGIN_REGEXP =
|
private static final String JEKYLL_PLUGIN_REGEXP =
|
||||||
"^.*(dokka-base|analysis-kotlin-descriptors|jekyll-plugin|gfm-plugin|freemarker).*\\.jar$";
|
"^.*(dokka-base|analysis-kotlin-descriptors|jekyll-plugin|gfm-plugin|freemarker).*\\.jar$";
|
||||||
private final Logger LOGGER = Logger.getLogger(DokkaOperation.class.getName());
|
private final Logger LOGGER = Logger.getLogger(DokkaOperation.class.getName());
|
||||||
private final Map<String, String> globalLinks_ = new ConcurrentHashMap<>();
|
private final Map<String, String> globalLinks_ = new ConcurrentHashMap<>();
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2023-2024 the original author or authors.
|
* Copyright 2023-2025 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2023-2024 the original author or authors.
|
* Copyright 2023-2025 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2023-2024 the original author or authors.
|
* Copyright 2023-2025 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2023-2024 the original author or authors.
|
* Copyright 2023-2025 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2023-2024 the original author or authors.
|
* Copyright 2023-2025 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -24,7 +24,7 @@ import java.util.ArrayList;
|
||||||
import java.util.Collection;
|
import java.util.Collection;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Map;
|
import java.util.Map;
|
||||||
import java.util.concurrent.ConcurrentHashMap;
|
import java.util.concurrent.ConcurrentSkipListMap;
|
||||||
import java.util.stream.Collectors;
|
import java.util.stream.Collectors;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -33,15 +33,16 @@ import java.util.stream.Collectors;
|
||||||
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
|
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
|
||||||
* @since 1.0
|
* @since 1.0
|
||||||
*/
|
*/
|
||||||
|
@SuppressWarnings("PMD.UseConcurrentHashMap")
|
||||||
public class SourceSet {
|
public class SourceSet {
|
||||||
private final Collection<File> classpath_ = new ArrayList<>();
|
private final Collection<File> classpath_ = new ArrayList<>();
|
||||||
private final Map<String, String> dependentSourceSets_ = new ConcurrentHashMap<>();
|
private final Map<String, String> dependentSourceSets_ = new ConcurrentSkipListMap<>();
|
||||||
private final Collection<DocumentedVisibility> documentedVisibilities_ = new ArrayList<>();
|
private final Collection<DocumentedVisibility> documentedVisibilities_ = new ArrayList<>();
|
||||||
private final Map<String, String> externalDocumentationLinks_ = new ConcurrentHashMap<>();
|
private final Map<String, String> externalDocumentationLinks_ = new ConcurrentSkipListMap<>();
|
||||||
private final Collection<File> includes_ = new ArrayList<>();
|
private final Collection<File> includes_ = new ArrayList<>();
|
||||||
private final Collection<String> perPackageOptions_ = new ArrayList<>();
|
private final Collection<String> perPackageOptions_ = new ArrayList<>();
|
||||||
private final Collection<File> samples_ = new ArrayList<>();
|
private final Collection<File> samples_ = new ArrayList<>();
|
||||||
private final Map<String, String> srcLinks_ = new ConcurrentHashMap<>();
|
private final Map<String, String> srcLinks_ = new ConcurrentSkipListMap<>();
|
||||||
private final Collection<File> src_ = new ArrayList<>();
|
private final Collection<File> src_ = new ArrayList<>();
|
||||||
private final Collection<File> suppressedFiles_ = new ArrayList<>();
|
private final Collection<File> suppressedFiles_ = new ArrayList<>();
|
||||||
private AnalysisPlatform analysisPlatform_;
|
private AnalysisPlatform analysisPlatform_;
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2023-2024 the original author or authors.
|
* Copyright 2023-2025 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -16,8 +16,11 @@
|
||||||
|
|
||||||
package rife.bld.extension;
|
package rife.bld.extension;
|
||||||
|
|
||||||
|
import org.assertj.core.api.AutoCloseableSoftAssertions;
|
||||||
import org.junit.jupiter.api.BeforeAll;
|
import org.junit.jupiter.api.BeforeAll;
|
||||||
import org.junit.jupiter.api.Test;
|
import org.junit.jupiter.api.Test;
|
||||||
|
import org.junit.jupiter.api.condition.EnabledOnOs;
|
||||||
|
import org.junit.jupiter.api.condition.OS;
|
||||||
import rife.bld.blueprints.BaseProjectBlueprint;
|
import rife.bld.blueprints.BaseProjectBlueprint;
|
||||||
import rife.bld.extension.dokka.LoggingLevel;
|
import rife.bld.extension.dokka.LoggingLevel;
|
||||||
import rife.bld.extension.dokka.OutputFormat;
|
import rife.bld.extension.dokka.OutputFormat;
|
||||||
|
@ -68,6 +71,7 @@ class DokkaOperationTest {
|
||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
|
@EnabledOnOs(OS.LINUX)
|
||||||
void executeConstructProcessCommandListTest() throws IOException {
|
void executeConstructProcessCommandListTest() throws IOException {
|
||||||
var args = Files.readAllLines(Paths.get("src", "test", "resources", "dokka-args.txt"));
|
var args = Files.readAllLines(Paths.get("src", "test", "resources", "dokka-args.txt"));
|
||||||
|
|
||||||
|
@ -77,7 +81,7 @@ class DokkaOperationTest {
|
||||||
var op = new DokkaOperation()
|
var op = new DokkaOperation()
|
||||||
.delayTemplateSubstitution(true)
|
.delayTemplateSubstitution(true)
|
||||||
.failOnWarning(true)
|
.failOnWarning(true)
|
||||||
.fromProject(new BaseProjectBlueprint(EXAMPLES, "com.example", "Example"))
|
.fromProject(new BaseProjectBlueprint(EXAMPLES, "com.example", "example", "Example"))
|
||||||
.globalLinks("s", "gLink1")
|
.globalLinks("s", "gLink1")
|
||||||
.globalLinks(Map.of("s2", "gLink2"))
|
.globalLinks(Map.of("s2", "gLink2"))
|
||||||
.globalPackageOptions(OPTION_1, OPTION_2)
|
.globalPackageOptions(OPTION_1, OPTION_2)
|
||||||
|
@ -107,27 +111,31 @@ class DokkaOperationTest {
|
||||||
)))
|
)))
|
||||||
.suppressInheritedMembers(true);
|
.suppressInheritedMembers(true);
|
||||||
|
|
||||||
assertThat(op.globalLinks()).as("globalLinks").hasSize(2);
|
try (var softly = new AutoCloseableSoftAssertions()) {
|
||||||
assertThat(op.globalPackageOptions()).as("globalPackageOptions").hasSize(4);
|
softly.assertThat(op.globalLinks()).as("globalLinks").hasSize(2);
|
||||||
assertThat(op.globalSrcLink()).as("globalSrcLink").hasSize(4);
|
softly.assertThat(op.globalPackageOptions()).as("globalPackageOptions").hasSize(4);
|
||||||
assertThat(op.includes()).as("includes").hasSize(4);
|
softly.assertThat(op.globalSrcLink()).as("globalSrcLink").hasSize(4);
|
||||||
assertThat(op.pluginConfigurations()).as("pluginConfigurations").hasSize(3);
|
softly.assertThat(op.includes()).as("includes").hasSize(4);
|
||||||
assertThat(op.pluginsClasspath()).as("pluginsClasspath").hasSize(9);
|
softly.assertThat(op.pluginConfigurations()).as("pluginConfigurations").hasSize(3);
|
||||||
|
softly.assertThat(op.pluginsClasspath()).as("pluginsClasspath").hasSize(9);
|
||||||
|
}
|
||||||
|
|
||||||
var params = op.executeConstructProcessCommandList();
|
var params = op.executeConstructProcessCommandList();
|
||||||
for (var p : args) {
|
try (var softly = new AutoCloseableSoftAssertions()) {
|
||||||
var found = false;
|
for (var p : args) {
|
||||||
for (var a : params) {
|
var found = false;
|
||||||
if (a.startsWith(p)) {
|
for (var a : params) {
|
||||||
found = true;
|
if (a.startsWith(p)) {
|
||||||
break;
|
found = true;
|
||||||
|
break;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
softly.assertThat(found).as(p + " not found.").isTrue();
|
||||||
}
|
}
|
||||||
assertThat(found).as(p + " not found.").isTrue();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
var path = EXAMPLES.getAbsolutePath();
|
var path = EXAMPLES.getAbsolutePath();
|
||||||
var dokkaJar = "1.9.20.jar";
|
var dokkaJar = "2.0.0.jar";
|
||||||
var matches = List.of("java",
|
var matches = List.of("java",
|
||||||
"-cp", path + "/lib/bld/dokka-cli-" + dokkaJar,
|
"-cp", path + "/lib/bld/dokka-cli-" + dokkaJar,
|
||||||
"org.jetbrains.dokka.MainKt",
|
"org.jetbrains.dokka.MainKt",
|
||||||
|
@ -157,14 +165,17 @@ class DokkaOperationTest {
|
||||||
|
|
||||||
assertThat(params).hasSize(matches.size());
|
assertThat(params).hasSize(matches.size());
|
||||||
|
|
||||||
IntStream.range(0, params.size()).forEach(i -> {
|
try (var softly = new AutoCloseableSoftAssertions()) {
|
||||||
if (params.get(i).contains(".jar;")) {
|
IntStream.range(0, params.size()).forEach(i -> {
|
||||||
var jars = params.get(i).split(";");
|
if (params.get(i).contains(".jar;")) {
|
||||||
Arrays.stream(jars).forEach(jar -> assertThat(matches.get(i)).as(matches.get(i)).contains(jar));
|
var jars = params.get(i).split(";");
|
||||||
} else {
|
Arrays.stream(jars).forEach(jar ->
|
||||||
assertThat(params.get(i)).as(params.get(i)).isEqualTo(matches.get(i));
|
softly.assertThat(matches.get(i)).as(matches.get(i)).contains(jar));
|
||||||
}
|
} else {
|
||||||
});
|
softly.assertThat(params.get(i)).as(params.get(i)).isEqualTo(matches.get(i));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
|
@ -177,7 +188,7 @@ class DokkaOperationTest {
|
||||||
void executeTest() {
|
void executeTest() {
|
||||||
var op = new DokkaOperation()
|
var op = new DokkaOperation()
|
||||||
.fromProject(
|
.fromProject(
|
||||||
new BaseProjectBlueprint(EXAMPLES, "com.example", "examples"))
|
new BaseProjectBlueprint(EXAMPLES, "com.example", "examples", "Examples"))
|
||||||
.outputDir("build/javadoc")
|
.outputDir("build/javadoc")
|
||||||
.outputFormat(OutputFormat.JAVADOC);
|
.outputFormat(OutputFormat.JAVADOC);
|
||||||
assertThatCode(op::execute).doesNotThrowAnyException();
|
assertThatCode(op::execute).doesNotThrowAnyException();
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2023-2024 the original author or authors.
|
* Copyright 2023-2025 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
* Copyright 2023-2024 the original author or authors.
|
* Copyright 2023-2025 the original author or authors.
|
||||||
*
|
*
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
* you may not use this file except in compliance with the License.
|
* you may not use this file except in compliance with the License.
|
||||||
|
@ -16,6 +16,7 @@
|
||||||
|
|
||||||
package rife.bld.extension.dokka;
|
package rife.bld.extension.dokka;
|
||||||
|
|
||||||
|
import org.assertj.core.api.AutoCloseableSoftAssertions;
|
||||||
import org.junit.jupiter.api.Test;
|
import org.junit.jupiter.api.Test;
|
||||||
|
|
||||||
import java.io.File;
|
import java.io.File;
|
||||||
|
@ -170,7 +171,7 @@ class SourceSetTest {
|
||||||
var matches = List.of(
|
var matches = List.of(
|
||||||
"-classpath", localPath(PATH_1, PATH_2),
|
"-classpath", localPath(PATH_1, PATH_2),
|
||||||
"-dependentSourceSets", "set1/set2;set3/set4",
|
"-dependentSourceSets", "set1/set2;set3/set4",
|
||||||
"-externalDocumentationLinks", "link3^link4^^link1^link2",
|
"-externalDocumentationLinks", "link1^link2^^link3^link4",
|
||||||
"-perPackageOptions", OPTION_1 + ';' + OPTION_2,
|
"-perPackageOptions", OPTION_1 + ';' + OPTION_2,
|
||||||
"-samples", localPath(SAMPLES_1, SAMPLES_2, SAMPLES_3),
|
"-samples", localPath(SAMPLES_1, SAMPLES_2, SAMPLES_3),
|
||||||
"-suppressedFiles", localPath(SUP_1, SUP_2, SUP_3)
|
"-suppressedFiles", localPath(SUP_1, SUP_2, SUP_3)
|
||||||
|
@ -225,28 +226,32 @@ class SourceSetTest {
|
||||||
.srcLink(Path.of(PATH_3), "remote3", "#suffix3")
|
.srcLink(Path.of(PATH_3), "remote3", "#suffix3")
|
||||||
.suppressedFiles(SUP_1, SUP_2);
|
.suppressedFiles(SUP_1, SUP_2);
|
||||||
|
|
||||||
assertThat(sourceSet.classpath()).as("classpath").hasSize(2);
|
try (var softly = new AutoCloseableSoftAssertions()) {
|
||||||
assertThat(sourceSet.dependentSourceSets()).as("dependentSourceSets").hasSize(2);
|
softly.assertThat(sourceSet.classpath()).as("classpath").hasSize(2);
|
||||||
assertThat(sourceSet.documentedVisibilities()).as("documentedVisibilities").hasSize(2);
|
softly.assertThat(sourceSet.dependentSourceSets()).as("dependentSourceSets").hasSize(2);
|
||||||
assertThat(sourceSet.externalDocumentationLinks()).as("externalDocumentationLinks").hasSize(2);
|
softly.assertThat(sourceSet.documentedVisibilities()).as("documentedVisibilities").hasSize(2);
|
||||||
assertThat(sourceSet.includes()).as("includes").hasSize(4);
|
softly.assertThat(sourceSet.externalDocumentationLinks()).as("externalDocumentationLinks").hasSize(2);
|
||||||
assertThat(sourceSet.perPackageOptions()).as("perPackageOptions").hasSize(2);
|
softly.assertThat(sourceSet.includes()).as("includes").hasSize(4);
|
||||||
assertThat(sourceSet.samples()).as("samples").hasSize(2);
|
softly.assertThat(sourceSet.perPackageOptions()).as("perPackageOptions").hasSize(2);
|
||||||
assertThat(sourceSet.src()).as("src").hasSize(4);
|
softly.assertThat(sourceSet.samples()).as("samples").hasSize(2);
|
||||||
assertThat(sourceSet.srcLinks()).as("srcLinks").hasSize(3);
|
softly.assertThat(sourceSet.src()).as("src").hasSize(4);
|
||||||
assertThat(sourceSet.suppressedFiles()).as("suppressedFiles").hasSize(2);
|
softly.assertThat(sourceSet.srcLinks()).as("srcLinks").hasSize(3);
|
||||||
|
softly.assertThat(sourceSet.suppressedFiles()).as("suppressedFiles").hasSize(2);
|
||||||
|
}
|
||||||
|
|
||||||
var params = sourceSet.args();
|
var params = sourceSet.args();
|
||||||
|
|
||||||
for (var p : args) {
|
try (var softly = new AutoCloseableSoftAssertions()) {
|
||||||
var found = false;
|
for (var p : args) {
|
||||||
for (var a : params) {
|
var found = false;
|
||||||
if (a.startsWith(p)) {
|
for (var a : params) {
|
||||||
found = true;
|
if (a.startsWith(p)) {
|
||||||
break;
|
found = true;
|
||||||
|
break;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
softly.assertThat(found).as(p + " not found.").isTrue();
|
||||||
}
|
}
|
||||||
assertThat(found).as(p + " not found.").isTrue();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
var matches = List.of(
|
var matches = List.of(
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue