Search in sources :

Example 1 with CheckstyleExtension

use of org.gradle.api.plugins.quality.CheckstyleExtension in project spring-boot by spring-projects.

the class JavaConventions method configureSpringJavaFormat.

private void configureSpringJavaFormat(Project project) {
    project.getPlugins().apply(SpringJavaFormatPlugin.class);
    project.getTasks().withType(Format.class, (Format) -> Format.setEncoding("UTF-8"));
    project.getPlugins().apply(CheckstylePlugin.class);
    CheckstyleExtension checkstyle = project.getExtensions().getByType(CheckstyleExtension.class);
    checkstyle.setToolVersion("8.45.1");
    checkstyle.getConfigDirectory().set(project.getRootProject().file("src/checkstyle"));
    String version = SpringJavaFormatPlugin.class.getPackage().getImplementationVersion();
    DependencySet checkstyleDependencies = project.getConfigurations().getByName("checkstyle").getDependencies();
    checkstyleDependencies.add(project.getDependencies().create("io.spring.javaformat:spring-javaformat-checkstyle:" + version));
}
Also used : DependencySet(org.gradle.api.artifacts.DependencySet) CheckstyleExtension(org.gradle.api.plugins.quality.CheckstyleExtension) SpringJavaFormatPlugin(io.spring.javaformat.gradle.SpringJavaFormatPlugin)

Example 2 with CheckstyleExtension

use of org.gradle.api.plugins.quality.CheckstyleExtension in project gradle by gradle.

the class GradleJavadocsPlugin method generateJavadocs.

private void generateJavadocs(Project project, ProjectLayout layout, TaskContainer tasks, GradleDocumentationExtension extension) {
    // TODO: Staging directory should be a part of the Javadocs extension
    // TODO: Pull out more of this configuration into the extension if it makes sense
    // TODO: in a typical project, this may need to be the regular javadoc task vs javadocAll
    ObjectFactory objects = project.getObjects();
    // TODO: This breaks if version is changed later
    Object version = project.getVersion();
    TaskProvider<Javadoc> javadocAll = tasks.register("javadocAll", Javadoc.class, task -> {
        task.setGroup("documentation");
        task.setDescription("Generate Javadocs for all API classes");
        task.setTitle("Gradle API " + version);
        Javadocs javadocs = extension.getJavadocs();
        // TODO: This should be part of Javadoc task
        task.getInputs().file(javadocs.getJavadocCss()).withPropertyName("stylesheetFile").withPathSensitivity(PathSensitivity.NAME_ONLY);
        StandardJavadocDocletOptions options = (StandardJavadocDocletOptions) task.getOptions();
        options.setEncoding("utf-8");
        options.setDocEncoding("utf-8");
        options.setCharSet("utf-8");
        // TODO: This would be better to model as separate options
        options.addStringOption("Xdoclint:syntax,html,reference", "-quiet");
        // TODO: This breaks the provider
        options.addStringOption("stylesheetfile", javadocs.getJavadocCss().get().getAsFile().getAbsolutePath());
        options.addStringOption("source", "8");
        // TODO: This breaks the provider
        options.links(javadocs.getJavaApi().get().toString(), javadocs.getGroovyApi().get().toString());
        task.source(extension.getDocumentedSource());
        task.setClasspath(extension.getClasspath());
        // TODO: This should be in Javadoc task
        DirectoryProperty generatedJavadocDirectory = objects.directoryProperty();
        generatedJavadocDirectory.set(layout.getBuildDirectory().dir("javadoc"));
        task.getOutputs().dir(generatedJavadocDirectory);
        task.getExtensions().getExtraProperties().set("destinationDirectory", generatedJavadocDirectory);
        // TODO: This breaks the provider
        task.setDestinationDir(generatedJavadocDirectory.get().getAsFile());
        if (BuildEnvironment.INSTANCE.getJavaVersion().isJava11Compatible()) {
            options.addBooleanOption("html4", true);
            options.addBooleanOption("-no-module-directories", true);
            FileSystemOperations fs = getFs();
            // noinspection Convert2Lambda
            task.doLast(new Action<Task>() {

                @Override
                public void execute(Task task) {
                    fs.copy(copySpec -> {
                        // Commit http://hg.openjdk.java.net/jdk/jdk/rev/89dc31d7572b broke use of JSZip (https://bugs.openjdk.java.net/browse/JDK-8214856)
                        // fixed in Java 12 by http://hg.openjdk.java.net/jdk/jdk/rev/b4982a22926b
                        // TODO: Remove this script.js workaround when we distribute Gradle using JDK 12 or higher
                        copySpec.from(extension.getSourceRoot().dir("js/javadoc"));
                        // This is a work-around for https://bugs.openjdk.java.net/browse/JDK-8211194. Can be removed once that issue is fixed on JDK"s side
                        // Since JDK 11, package-list is missing from javadoc output files and superseded by element-list file, but a lot of external tools still need it
                        // Here we generate this file manually
                        copySpec.from(generatedJavadocDirectory.file("element-list"), sub -> {
                            sub.rename(t -> "package-list");
                        });
                        copySpec.into(generatedJavadocDirectory);
                    });
                }
            });
        }
    });
    extension.javadocs(javadocs -> {
        javadocs.getJavadocCss().convention(extension.getSourceRoot().file("css/javadoc.css"));
        // TODO: destinationDirectory should be part of Javadoc
        javadocs.getRenderedDocumentation().from(javadocAll.flatMap(task -> (DirectoryProperty) task.getExtensions().getExtraProperties().get("destinationDirectory")));
    });
    CheckstyleExtension checkstyle = project.getExtensions().getByType(CheckstyleExtension.class);
    tasks.register("checkstyleApi", Checkstyle.class, task -> {
        task.source(extension.getDocumentedSource());
        // TODO: This is ugly
        task.setConfig(project.getResources().getText().fromFile(checkstyle.getConfigDirectory().file("checkstyle-api.xml")));
        task.setClasspath(layout.files());
        task.getReports().getXml().setDestination(new File(checkstyle.getReportsDir(), "checkstyle-api.xml"));
    });
}
Also used : FileSystemOperations(org.gradle.api.file.FileSystemOperations) Checkstyle(org.gradle.api.plugins.quality.Checkstyle) Action(org.gradle.api.Action) Project(org.gradle.api.Project) StandardJavadocDocletOptions(org.gradle.external.javadoc.StandardJavadocDocletOptions) File(java.io.File) Inject(javax.inject.Inject) Task(org.gradle.api.Task) ProjectLayout(org.gradle.api.file.ProjectLayout) Javadoc(org.gradle.api.tasks.javadoc.Javadoc) ObjectFactory(org.gradle.api.model.ObjectFactory) TaskContainer(org.gradle.api.tasks.TaskContainer) TaskProvider(org.gradle.api.tasks.TaskProvider) DirectoryProperty(org.gradle.api.file.DirectoryProperty) PathSensitivity(org.gradle.api.tasks.PathSensitivity) CheckstyleExtension(org.gradle.api.plugins.quality.CheckstyleExtension) BuildEnvironment(gradlebuild.basics.BuildEnvironment) Plugin(org.gradle.api.Plugin) Task(org.gradle.api.Task) Javadoc(org.gradle.api.tasks.javadoc.Javadoc) FileSystemOperations(org.gradle.api.file.FileSystemOperations) CheckstyleExtension(org.gradle.api.plugins.quality.CheckstyleExtension) StandardJavadocDocletOptions(org.gradle.external.javadoc.StandardJavadocDocletOptions) DirectoryProperty(org.gradle.api.file.DirectoryProperty) ObjectFactory(org.gradle.api.model.ObjectFactory) File(java.io.File)

Aggregations

CheckstyleExtension (org.gradle.api.plugins.quality.CheckstyleExtension)2 BuildEnvironment (gradlebuild.basics.BuildEnvironment)1 SpringJavaFormatPlugin (io.spring.javaformat.gradle.SpringJavaFormatPlugin)1 File (java.io.File)1 Inject (javax.inject.Inject)1 Action (org.gradle.api.Action)1 Plugin (org.gradle.api.Plugin)1 Project (org.gradle.api.Project)1 Task (org.gradle.api.Task)1 DependencySet (org.gradle.api.artifacts.DependencySet)1 DirectoryProperty (org.gradle.api.file.DirectoryProperty)1 FileSystemOperations (org.gradle.api.file.FileSystemOperations)1 ProjectLayout (org.gradle.api.file.ProjectLayout)1 ObjectFactory (org.gradle.api.model.ObjectFactory)1 Checkstyle (org.gradle.api.plugins.quality.Checkstyle)1 PathSensitivity (org.gradle.api.tasks.PathSensitivity)1 TaskContainer (org.gradle.api.tasks.TaskContainer)1 TaskProvider (org.gradle.api.tasks.TaskProvider)1 Javadoc (org.gradle.api.tasks.javadoc.Javadoc)1 StandardJavadocDocletOptions (org.gradle.external.javadoc.StandardJavadocDocletOptions)1