[#299][#459] initial version of example projects

remkop · Feb 9, 2020 · 81279e6 · 81279e6
1 parent 8a0fb9d
commit 81279e6
Show file tree

Hide file tree

Showing 4 changed files with 210 additions and 0 deletions.
diff --git a/picocli-examples/generate-man-pages/example-gradle-project/build.gradle b/picocli-examples/generate-man-pages/example-gradle-project/build.gradle
@@ -0,0 +1,58 @@
+buildscript {
+    repositories {
+        jcenter()
+        maven {
+            url "https://plugins.gradle.org/m2/"
+        }
+        mavenCentral()
+    }
+
+    dependencies {
+        classpath "org.asciidoctor:asciidoctor-gradle-plugin:$asciidoctorGradlePluginVersion"
+    }
+}
+
+plugins {
+    id 'java'
+}
+apply plugin: 'org.asciidoctor.convert'
+
+
+group 'org.mycompany.myproject'
+version '1.0-SNAPSHOT'
+
+sourceCompatibility = 1.8
+
+repositories {
+    mavenLocal()
+    jcenter()
+    mavenCentral()
+}
+
+dependencies {
+    testCompile group: 'junit', name: 'junit', version: '4.12'
+}
+dependencies {
+    compile "info.picocli:picocli:4.2.0"
+    annotationProcessor "info.picocli:picocli-codegen:4.2.0"
+}
+
+mainClassName = "my.pkg.MyCommand"
+
+task generateManpageAsciiDoc(type: JavaExec) {
+    dependsOn(classes)
+    group = "Documentation"
+    description = "Generate AsciiDoc manpage"
+    classpath(configurations.compile, configurations.annotationProcessor, sourceSets.main.runtimeClasspath)
+    main 'picocli.codegen.docgen.manpage.ManPageGenerator'
+    args mainClassName, "--outdir=${project.buildDir}/generated/docs", "-v" //, "--template-dir=src/docs/mantemplates"
+}
+
+apply plugin: 'org.asciidoctor.convert'
+asciidoctor {
+    dependsOn(generateManpageAsciiDoc)
+    sourceDir = file("${project.buildDir}/generated/docs")
+    outputDir = file("${project.buildDir}/docs")
+    logDocuments = true
+    backends 'manpage'
+}
diff --git a/...li-examples/generate-man-pages/example-gradle-project/src/main/java/com/company/Main.java b/...li-examples/generate-man-pages/example-gradle-project/src/main/java/com/company/Main.java
@@ -0,0 +1,26 @@
+package com.company;
+
+import picocli.CommandLine;
+import picocli.CommandLine.Command;
+import picocli.CommandLine.Option;
+
+import java.util.concurrent.Callable;
+
+@Command(name = "top", mixinStandardHelpOptions = true,
+        version = {"test 1.0", "picocli " + CommandLine.VERSION})
+public class Main implements Callable<Integer> {
+
+    @Option(names = "-x") int x;
+    @Option(names = "-y") int y;
+    @Option(names = "-z") int z;
+
+    public static void main(String[] args) {
+        System.exit(new CommandLine(new Main()).execute(args));
+    }
+
+    @Override
+    public Integer call() throws Exception {
+        System.out.println("Hi!");
+        return 0;
+    }
+}
diff --git a/picocli-examples/generate-man-pages/example-maven-project/pom.xml b/picocli-examples/generate-man-pages/example-maven-project/pom.xml
@@ -0,0 +1,100 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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>
+
+  <groupId>org.myorg.myproject</groupId>
+  <artifactId>myapp</artifactId>
+  <version>1.0-SNAPSHOT</version>
+  <packaging>jar</packaging>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-compiler-plugin</artifactId>
+        <version>3.7.0</version>
+        <configuration>
+          <source>1.6</source>
+          <target>1.6</target>
+          <compilerArgs>
+            <arg>-Aproject=${project.groupId}/${project.artifactId}</arg>
+          </compilerArgs>
+        </configuration>
+      </plugin>
+
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-jar-plugin</artifactId>
+        <version>2.2</version>
+        <executions>
+          <execution>
+            <goals>
+              <goal>jar</goal>
+            </goals>
+            <id>jar</id>
+          </execution>
+        </executions>
+      </plugin>
+      <plugin>
+        <groupId>org.codehaus.mojo</groupId>
+        <artifactId>exec-maven-plugin</artifactId>
+        <version>1.6.0</version>
+        <executions>
+          <execution>
+            <id>generateManPages</id>
+            <phase>process-classes</phase>
+            <goals>
+              <goal>java</goal>
+            </goals>
+          </execution>
+        </executions>
+        <configuration>
+          <includeProjectDependencies>true</includeProjectDependencies>
+          <includePluginDependencies>true</includePluginDependencies>
+          <mainClass>picocli.codegen.docgen.manpage.ManPageGenerator</mainClass>
+          <arguments>
+            <argument>--outdir=target/generated/docs</argument>
+            <argument>com.your.package.YourCommand1</argument>
+            <argument>com.your.package.YourCommand2</argument>
+          </arguments>
+        </configuration>
+        <dependencies>
+          <dependency>
+            <groupId>info.picocli</groupId>
+            <artifactId>picocli-codegen</artifactId>
+            <version>4.2.0</version>
+            <type>jar</type>
+          </dependency>
+        </dependencies>
+      </plugin>
+    </plugins>
+  </build>
+
+  <properties>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+  </properties>
+
+  <dependencies>
+    <!--
+      <dependency>
+        <groupId>junit</groupId>
+        <artifactId>junit</artifactId>
+        <version>3.8.1</version>
+        <scope>test</scope>
+      </dependency>
+      -->
+    <dependency>
+      <groupId>info.picocli</groupId>
+      <artifactId>picocli</artifactId>
+      <version>4.1.4</version>
+    </dependency>
+    <dependency>
+      <groupId>info.picocli</groupId>
+      <artifactId>picocli-codegen</artifactId>
+      <version>4.1.4</version>
+      <scope>provided</scope>
+    </dependency>
+  </dependencies>
+</project>
diff --git a/...cli-examples/generate-man-pages/example-maven-project/src/main/java/com/company/Main.java b/...cli-examples/generate-man-pages/example-maven-project/src/main/java/com/company/Main.java
@@ -0,0 +1,26 @@
+package com.company;
+
+import picocli.CommandLine;
+import picocli.CommandLine.Command;
+import picocli.CommandLine.Option;
+
+import java.util.concurrent.Callable;
+
+@Command(name = "top", mixinStandardHelpOptions = true,
+        version = {"test 1.0", "picocli " + CommandLine.VERSION})
+public class Main implements Callable<Integer> {
+
+    @Option(names = "-x") int x;
+    @Option(names = "-y") int y;
+    @Option(names = "-z") int z;
+
+    public static void main(String[] args) {
+        System.exit(new CommandLine(new Main()).execute(args));
+    }
+
+    @Override
+    public Integer call() throws Exception {
+        System.out.println("Hi!");
+        return 0;
+    }
+}