io.micronaut.starter.cli.util.MicronautVersionProvider Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017-2022 original authors
 *
 * Licensed 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
 *
 * https://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.
 */
package io.micronaut.starter.cli.util;

import io.micronaut.starter.util.VersionInfo;
import picocli.CommandLine.IVersionProvider;

import jakarta.inject.Singleton;

/**
 * Generates version information. Example usage:
 *  * @Command(name = 'command', versionProvider = MicronautCliVersionProvider)
 * class App {
 *     @Option(names = ["-V", "--version"], versionHelp = true, description = 'Display version information and quit.')
 *     boolean isVersionRequested
 * }
 * 
 * Or use picocli's built-in standard usage help option (--help and -h) and version help option (-V and --version).
 *  * @Command(name = 'command', mixinStandardHelpOptions = true, versionProvider = MicronautCliVersionProvider)
 * class App {
 *     // ...
 * }
 * 
 *
 * @author Remko Popma
 * @version 1.0
 */
@Singleton
public class MicronautVersionProvider implements IVersionProvider {

    public String[] getVersion() {
        return new String[] {
                "Micronaut Version: " + VersionInfo.getMicronautVersion()
        };
    }
}