com.github.fge.jsonschema.main.cli.CustomHelpFormatter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of json-schema-validator Show documentation
A Java implementation of the JSON Schema specification
There is a newer version: 2.2.10
Show newest version
/*
 * Copyright (c) 2014, Francis Galiegue ([email protected])
 *
 * This software is dual-licensed under:
 *
 * - the Lesser General Public License (LGPL) version 3.0 or, at your option, any
 *   later version;
 * - the Apache Software License (ASL) version 2.0.
 *
 * The text of this file and of both licenses is available at the root of this
 * project or, if you have the jar distribution, in directory META-INF/, under
 * the names LGPL-3.0.txt and ASL-2.0.txt respectively.
 *
 * Direct link to the sources:
 *
 * - LGPL 3.0: https://www.gnu.org/licenses/lgpl-3.0.txt
 * - ASL 2.0: http://www.apache.org/licenses/LICENSE-2.0.txt
 */

package com.github.fge.jsonschema.main.cli;

import com.google.common.base.Joiner;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Lists;
import joptsimple.HelpFormatter;
import joptsimple.OptionDescriptor;

import java.util.Collection;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

final class CustomHelpFormatter
    implements HelpFormatter
{
    private static final List HELP_PREAMBLE = ImmutableList.of(
        "Syntax:",
        "    java -jar jsonschema.jar [options] schema file [file...]",
        "    java -jar jsonschema.jar --syntax [options] schema [schema...]",
        "",
        "Options: "
    );

    private static final List HELP_POST
        = ImmutableList.builder()
        .add("")
        .add("Exit codes:")
        .add("    0: validation successful;")
        .add("    1: exception occurred (appears on stderr)")
        .add("    2: command line syntax error (missing argument, etc)")
        .add("  100: one or more file(s) failed validation")
        .add("  101: one or more schema(s) is/are invalid")
        .add("")
        .add("Note: by default, the URI of schemas you use in validation mode")
        .add("(that is, when you don't use --syntax) is considered to be the")
        .add("current working directory plus the filename. If your schemas")
        .add("all have a common URI prefix in a top level \"id\", you can fake")
        .add("that the current directory is that prefix using --fakeroot.")
        .build();

    private static final String LINE_SEPARATOR
        = System.getProperty("line.separator", "\n");

    private static final Joiner JOINER = Joiner.on(LINE_SEPARATOR);
    static final Joiner OPTIONS_JOINER = Joiner.on(", ");

    private final List lines = Lists.newArrayList();

    @Override
    public String format(final Map options)
    {
        final Set opts = new LinkedHashSet(
            options.values());

        lines.addAll(HELP_PREAMBLE);

        final int helpIndex = lines.size();
        StringBuilder sb;

        for (final OptionDescriptor descriptor : opts) {
            if (descriptor.representsNonOptions())
                continue;
            final Collection names = descriptor.options();
            sb = new StringBuilder().append("    ")
                .append(optionsToString(names));
            if (descriptor.requiresArgument())
                sb.append(" uri");
            sb.append(": ").append(descriptor.description());
            if (names.contains("help"))
                lines.add(helpIndex, sb.toString());
            else
                lines.add(sb.toString());
        }

        lines.addAll(HELP_POST);

        return JOINER.join(lines) + LINE_SEPARATOR;
    }

    private static String optionsToString(final Collection names)
    {
        final List list = Lists.newArrayList();
        for (final String name : names)
            list.add((name.length() == 1 ? "-" : "--") + name);
        return OPTIONS_JOINER.join(list);
    }
}