org.docstr.gwt.options.CompilerOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwt-gradle-plugin Show documentation
Gradle plugin to support GWT (http://www.gwtproject.org/) related tasks.
There is a newer version: 2.1.6
/**
 * Copyright (C) 2024 Document Node Pty Ltd
 *
 * 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
 *
 * http://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 org.docstr.gwt.options;

import org.docstr.gwt.AbstractBaseOptions;
import org.gradle.api.file.DirectoryProperty;
import org.gradle.api.provider.Property;

/**
 * Compiler options
 * https://www.gwtproject.org/doc/latest/DevGuideCompilingAndDebugging.html#DevGuideCompilerOptions
 * https://github.com/gwtproject/gwt/blob/main/dev/core/src/com/google/gwt/dev/PrecompileTaskOptionsImpl.java
 */
public abstract class CompilerOptions extends AbstractBaseOptions {

  /**
   * -X[no]closureFormattedOutput
   * EXPERIMENTAL: Enables Javascript output suitable for
   * post-compilation by Closure Compiler (defaults to OFF)
   *
   * @return The closure formatted output
   */
  public abstract Property getClosureFormattedOutput();

  /**
   * -[no]compileReport
   * Compile a report that tells the "Story of Your Compile".
   * (defaults to OFF)
   *
   * @return The compile report
   */
  public abstract Property getCompileReport();

  /**
   * -strict
   * Enables strict mode for GWT compiler. (defaults to OFF)
   *
   * @return The strict mode
   */
  public abstract Property getStrict();

  /**
   * -X[no]classMetadata
   * EXPERIMENTAL: Include metadata for some java.lang.Class methods
   * (e.g. getName()). (defaults to ON)
   *
   * @return The class metadata
   */
  public abstract Property getClassMetadata();

  /**
   * -[no]draftCompile
   * Compile quickly with minimal optimizations. (defaults to OFF)
   *
   * @return The draft compile
   */
  public abstract Property getDraftCompile();

  /**
   * -[no]checkAssertions
   * Include assert statements in compiled output. (defaults to OFF)
   *
   * @return The check assertions
   */
  public abstract Property getCheckAssertions();

  /**
   * -XfragmentCount
   * EXPERIMENTAL: Limits of number of fragments using a code splitter
   * that merges split points.
   *
   * @return The fragment count
   */
  public abstract Property getFragmentCount();

  /**
   * -Xnamespace
   * Puts most JavaScript globals into namespaces. Default: PACKAGE
   * for -draftCompile, otherwise NONE
   *
   * @return The namespace
   */
  public abstract Property getNamespace();

  /**
   * -optimize
   * Sets the optimization level used by the compiler.  0=none 9=maximum.
   *
   * @return The optimization level
   */
  public abstract Property getOptimize();

  /**
   * -[no]saveSource
   * Enables saving source code needed by debuggers. Also see -debugDir.
   * (defaults to OFF)
   *
   * @return The save source
   */
  public abstract Property getSaveSource();

  /**
   * -[no]validateOnly
   * Validate all source code, but do not compile. (defaults to OFF)
   *
   * @return The validate only
   */
  public abstract Property getValidateOnly();

  /**
   * -localWorkers
   * The number of local workers to use when compiling permutations
   *
   * @return The local workers
   */
  public abstract Property getLocalWorkers();

  /**
   * -saveSourceOutput
   * Overrides where source files useful to debuggers will be written.
   * Default: saved with extras.
   *
   * @return The save source output
   */
  public abstract DirectoryProperty getSaveSourceOutput();
}