策略引擎>> rules_gwt>> 返回
项目作者： bazelbuild

项目描述 ：
Bazel rules for GWT
高级语言： Starlark
项目地址: git://github.com/bazelbuild/rules_gwt.git
创建时间： 2016-07-29T10:14:01Z
项目社区：https://github.com/bazelbuild/rules_gwt
开源协议：Apache License 2.0
下载


Build status

📣 [Unmaintained] GWT Rules for Bazel

[!WARNING]
Due to an absence of any maintainers, this repository is archived and currently unmaintained.

We discourage any new dependencies on the contents of this repository.

If you, or your organization, are interested in revitalizing this project by taking over its maintenance, we welcome your initiative.
To discuss the process of un-archiving and assuming ownership of this repository, please reach out to us via email at bazel-contrib@googlegroups.com or join the conversation on our Slack workspace in the #rules channel.
You can sign up for Slack access at https://slack.bazel.build.


Rules



Overview

These build rules are used for building GWT
applications with Bazel. Applications are compiled as .war files containing
compiled JavaScript and other resources. GWT applications can also be run in
Development Mode
via bazel run.

Setup

To be able to use the GWT rules, you must provide bindings for the GWT jars and
everything it depends on. The easiest way to do so is to add the following to
your WORKSPACE file, which will give you default versions for GWT and each
dependency:

  1. load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
  2. http_archive(
  3.   name = "io_bazel_rules_gwt",
  4.   url = "https://github.com/bazelbuild/rules_gwt/archive/0.1.3.tar.gz",
  5.   sha256 = "3f017bd2f7734e259535da0bcc75398b883dda6da6b657dfa84bd02fab0a6916",
  6.   strip_prefix = "rules_gwt-0.1.3",
  7. )
  8. load("@io_bazel_rules_gwt//gwt:gwt.bzl", "gwt_repositories")
  9. gwt_repositories()

If you want to use a different version of GWT or any of its dependencies, you
must provide your own bindings. Remove the gwt_repositories() line above and
add a bind rule for each of the following in your WORKSPACE:

Basic Example

Suppose you have the following directory structure for a simple GWT application:

  1. [workspace]/
  2.     WORKSPACE
  3.     src/main/java/
  4.         app/
  5.             BUILD
  6.             MyApp.java
  7.             MyApp.gwt.xml
  8.         lib/
  9.             BUILD
  10.             MyLib.java
  11.         public/
  12.             index.html

Here, MyApp.java defines the entry point to a GWT application specified by
MyApp.gwt.xml which depends on another Java library MyLib.java. index.html
defines the HTML page that links in the GWT application. To build this app, your
src/main/java/app/BUILD can look like this:

  1. load("@io_bazel_rules_gwt//gwt:gwt.bzl", "gwt_application")
  3. gwt_application(
  4.   name = "MyApp",
  5.   srcs = glob(["*.java"]),
  6.   resources = glob(["*.gwt.xml"]),
  7.   modules = ["app.MyApp"],
  8.   pubs = glob(["public/*"]),
  9.   deps = [
  10.     "//src/main/java/lib",
  11.   ],
  12. )

Now, you can build the GWT application by running
bazel build src/main/java/app:MyApp. This will run the GWT compiler and place
all of its output as well as index.html into
bazel-bin/src/main/java/app/MyApp.war. You can also run
bazel run src/main/java/app:MyApp-dev to run GWT development mode for the
application. Once development mode has started, you can see the app by opening
http://127.0.0.1:8888/index.html in a browser. Note that development mode assumes
that all of your .java files are located under java/ or src/main/java/ - see
details on the java_roots flag below if this is not the case.

For a complete example, see the
example/
directory in this repository.

gwt_application

  1. gwt_application(name, srcs, resources, modules, pubs, deps, output_root, java_roots, compiler_flags, compiler_jvm_flags, dev_flags, dev_jvm_flags):

Implicit output targets

  • <name>.war: archive containing GWT compiler output and any files passed
    in via pubs.
  • <name>-dev: script that can be run via bazel run to launch the app in
    development mode.




























































Attributes
name
Name, required

A unique name for this rule.
srcs
List of labels, optional


List of .java source files that will be compiled and passed on the
classpath to the GWT compiler.
resources
List of labels, optional


List of resource files that will be passed on the classpath to the GWT
compiler, e.g. .gwt.xml, .ui.xml, and
.css files.
modules
List of strings, required


List of fully-qualified names of modules that will be passed to the GWT
compiler. Usually contains a single module name corresponding to the
application’s .gwt.xml file.
pubs
List of labels, optional


Files that will be copied directly to the output war, such as static
HTML or image resources. Not interpreted by the GWT compiler.
deps
List of labels, optional


List of other java_libraries on which the application depends. Both the
class jars and the source jars corresponding to each library as well as
their transitive dependencies will be passed to the GWT compiler’s
classpath. These libraries may contain other .gwt.xml,
.ui.xml, etc. files as resources.
output_root
String, optional


Directory in the output war in which all outputs will be placed. By
default outputs are placed at the root of the war file.
java_roots
List of strings, optional


Directories relative to the workspace root that form roots of the
Java package hierarchy (e.g. they contain com directories).
By default this includes java, javatests,
src/main/java and src/test/java. If your Java
files aren’t under these directories, you must set this property in order
for development mode to work correctly. Otherwise GWT won’t be able to
see your source files, so you will not see any changes reflected when
refreshing dev mode.
compiler_flags
List of strings, optional


Additional flags that will be passed to the GWT compiler. See
here
for a list of available flags.
compiler_jvm_flags
List of strings, optional


Additional JVM flags that will be passed to the GWT compiler, such as
-Xmx4G to increase the amount of available memory.
dev_flags
List of strings, optional


Additional flags that will be passed to development mode. See
here
for a list of available flags.
dev_jvm_flags
List of strings, optional


Additional JVM flags that will be passed to development mode, such as
-Xmx4G to increase the amount of available memory.