Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

internal/language/proto: package mode #250

Merged
merged 1 commit into from
Jul 3, 2018
Merged

internal/language/proto: package mode #250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
169 changes: 95 additions & 74 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,77 +230,82 @@ Subdirectories will be processed recursively.

The following flags are accepted:

+------------------------------------------+-----------------------------------+
| **Name** | **Default value** |
+==========================================+===================================+
| :flag:`-build_file_name file1,file2,...` | :value:`BUILD.bazel,BUILD` |
+------------------------------------------+-----------------------------------+
| Comma-separated list of file names. Gazelle recognizes these files as Bazel |
| build files. New files will use the first name in this list. Use this if |
| your project contains non-Bazel files named ``BUILD`` (or ``build`` on |
| case-insensitive file systems). |
+------------------------------------------+-----------------------------------+
| :flag:`-build_tags tag1,tag2` | |
+------------------------------------------+-----------------------------------+
| List of Go build tags Gazelle will consider to be true. Gazelle applies |
| constraints when generating Go rules. It assumes certain tags are true on |
| certain platforms (for example, ``amd64,linux``). It assumes all Go release |
| tags are true (for example, ``go1.8``). It considers other tags to be false |
| (for example, ``ignore``). This flag overrides that behavior. |
| |
| Bazel may still filter sources with these tags. Use |
| ``bazel build --features gotags=foo,bar`` to set tags at build time. |
+------------------------------------------+-----------------------------------+
| :flag:`-external external|vendored` | :value:`external` |
+------------------------------------------+-----------------------------------+
| Determines how Gazelle resolves import paths. May be :value:`external` or |
| :value:`vendored`. Gazelle translates Go import paths to Bazel labels when |
| resolving library dependencies. Import paths that start with the |
| ``go_prefix`` are resolved to local labels, but other imports |
| are resolved based on this mode. In :value:`external` mode, paths are |
| resolved using an external dependency in the WORKSPACE file (Gazelle does |
| not create or maintain these dependencies yet). In :value:`vendored` mode, |
| paths are resolved to a library in the vendor directory. |
+------------------------------------------+-----------------------------------+
| :flag:`-go_prefix example.com/repo` | |
+------------------------------------------+-----------------------------------+
| A prefix of import paths for libraries in the repository that corresponds to |
| the repository root. Gazelle infers this from the ``go_prefix`` rule in the |
| root BUILD.bazel file, if it exists. If not, this option is mandatory. |
| |
| This prefix is used to determine whether an import path refers to a library |
| in the current repository or an external dependency. |
+------------------------------------------+-----------------------------------+
| :flag:`-known_import example.com` | |
+------------------------------------------+-----------------------------------+
| Skips import path resolution for a known domain. May be repeated. |
| |
| When Gazelle resolves an import path to an external dependency, it attempts |
| to discover the remote repository root over HTTP. Gazelle skips this |
| discovery step for a few well-known domains with predictable structure, like |
| golang.org and github.com. This flag specifies additional domains to skip, |
| which is useful in situations where the lookup would fail for some reason. |
+------------------------------------------+-----------------------------------+
| :flag:`-mode fix|print|diff` | :value:`fix` |
+------------------------------------------+-----------------------------------+
| Method for emitting merged build files. |
| |
| In ``fix`` mode, Gazelle writes generated and merged files to disk. In |
| ``print`` mode, it prints them to stdout. In ``diff`` mode, it prints a |
| unified diff. |
+------------------------------------------+-----------------------------------+
| :flag:`-proto default|legacy|disable` | :value:`default` |
+------------------------------------------+-----------------------------------+
| Determines how Gazelle should generate rules for .proto files. See details |
| in `Directives`_ below. |
+------------------------------------------+-----------------------------------+
| :flag:`-repo_root dir` | |
+------------------------------------------+-----------------------------------+
| The root directory of the repository. Gazelle normally infers this to be the |
| directory containing the WORKSPACE file. |
| |
| Gazelle will not process packages outside this directory. |
+------------------------------------------+-----------------------------------+
+-----------------------------------------------+-----------------------------------+
| **Name** | **Default value** |
+===============================================+===================================+
| :flag:`-build_file_name file1,file2,...` | :value:`BUILD.bazel,BUILD` |
+-----------------------------------------------+-----------------------------------+
| Comma-separated list of file names. Gazelle recognizes these files as Bazel |
| build files. New files will use the first name in this list. Use this if |
| your project contains non-Bazel files named ``BUILD`` (or ``build`` on |
| case-insensitive file systems). |
+-----------------------------------------------+-----------------------------------+
| :flag:`-build_tags tag1,tag2` | |
+-----------------------------------------------+-----------------------------------+
| List of Go build tags Gazelle will consider to be true. Gazelle applies |
| constraints when generating Go rules. It assumes certain tags are true on |
| certain platforms (for example, ``amd64,linux``). It assumes all Go release |
| tags are true (for example, ``go1.8``). It considers other tags to be false |
| (for example, ``ignore``). This flag overrides that behavior. |
| |
| Bazel may still filter sources with these tags. Use |
| ``bazel build --features gotags=foo,bar`` to set tags at build time. |
+-----------------------------------------------+-----------------------------------+
| :flag:`-external external|vendored` | :value:`external` |
+-----------------------------------------------+-----------------------------------+
| Determines how Gazelle resolves import paths. May be :value:`external` or |
| :value:`vendored`. Gazelle translates Go import paths to Bazel labels when |
| resolving library dependencies. Import paths that start with the |
| ``go_prefix`` are resolved to local labels, but other imports |
| are resolved based on this mode. In :value:`external` mode, paths are |
| resolved using an external dependency in the WORKSPACE file (Gazelle does |
| not create or maintain these dependencies yet). In :value:`vendored` mode, |
| paths are resolved to a library in the vendor directory. |
+-----------------------------------------------+-----------------------------------+
| :flag:`-go_prefix example.com/repo` | |
+-----------------------------------------------+-----------------------------------+
| A prefix of import paths for libraries in the repository that corresponds to |
| the repository root. Gazelle infers this from the ``go_prefix`` rule in the |
| root BUILD.bazel file, if it exists. If not, this option is mandatory. |
| |
| This prefix is used to determine whether an import path refers to a library |
| in the current repository or an external dependency. |
+-----------------------------------------------+-----------------------------------+
| :flag:`-known_import example.com` | |
+-----------------------------------------------+-----------------------------------+
| Skips import path resolution for a known domain. May be repeated. |
| |
| When Gazelle resolves an import path to an external dependency, it attempts |
| to discover the remote repository root over HTTP. Gazelle skips this |
| discovery step for a few well-known domains with predictable structure, like |
| golang.org and github.com. This flag specifies additional domains to skip, |
| which is useful in situations where the lookup would fail for some reason. |
+-----------------------------------------------+-----------------------------------+
| :flag:`-mode fix|print|diff` | :value:`fix` |
+-----------------------------------------------+-----------------------------------+
| Method for emitting merged build files. |
| |
| In ``fix`` mode, Gazelle writes generated and merged files to disk. In |
| ``print`` mode, it prints them to stdout. In ``diff`` mode, it prints a |
| unified diff. |
+-----------------------------------------------+-----------------------------------+
| :flag:`-proto default|package|legacy|disable` | :value:`default` |
+-----------------------------------------------+-----------------------------------+
| Determines how Gazelle should generate rules for .proto files. See details |
| in `Directives`_ below. |
+-----------------------------------------------+-----------------------------------+
| :flag:`-proto_group group` | :value:`""` |
+-----------------------------------------------+-----------------------------------+
| Determines the proto option Gazelle uses to group .proto files into rules |
| when in ``package`` mode. See details in `Directives`_ below. |
+-----------------------------------------------+-----------------------------------+
| :flag:`-repo_root dir` | |
+-----------------------------------------------+-----------------------------------+
| The root directory of the repository. Gazelle normally infers this to be the |
| directory containing the WORKSPACE file. |
| |
| Gazelle will not process packages outside this directory. |
+-----------------------------------------------+-----------------------------------+

``update-repos``
~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -475,9 +480,12 @@ The following directives are recognized:
+------------------------------------------+-----------------------------------+
| Tells Gazelle how to generate rules for .proto files. Valid values are: |
| |
| * ``default``: ``proto_library``, ``go_proto_library``, ``go_grpc_library``, |
| and ``go_library`` rules are generated using |
| ``@io_bazel_rules_go//proto:def.bzl``. This is the default mode. |
| * ``default``: ``proto_library``, ``go_proto_library``, and ``go_library`` |
| rules are generated using ``@io_bazel_rules_go//proto:def.bzl``. Only one |
| of each rule may be generated per directory. This is the default mode. |
| * ``package``: multiple ``proto_library`` and ``go_proto_library`` rules |
| may be generated in the same directory. .proto files are grouped into |
| rules based on their package name or another option (see ``proto_group``). |
| * ``legacy``: ``filegroup`` rules are generated for use by |
| ``@io_bazel_rules_go//proto:go_proto_library.bzl``. ``go_proto_library`` |
| rules must be written by hand. Gazelle will run in this mode automatically |
Expand All @@ -494,6 +502,19 @@ The following directives are recognized:
| ``@io_bazel_rules_go//proto:go_proto_library.bzl`` is loaded, Gazelle |
| will run in ``legacy`` mode. |
+------------------------------------------+-----------------------------------+
| :direc:`proto_group` | :value:`""` |
+------------------------------------------+-----------------------------------+
| Specifies an option that Gazelle can use to group .proto files into rules |
| when in ``package`` mode. For example, when set to ``go_package``, .proto |
| files with the same ``option go_package`` will be grouped together. |
| |
| When this directive is set to the empty string, Gazelle will group packages |
| by their proto package statement. |
| |
| Rule names are generated based on the last run of identifier characters |
| in the package name. For example, if the package is ``"foo/bar/baz"``, the |
| ``proto_library`` rule will be named ``baz_proto``. |
+------------------------------------------+-----------------------------------+

Keep comments
~~~~~~~~~~~~~
Expand Down
1 change: 1 addition & 0 deletions internal/go_repository.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,7 @@ go_repository = repository_rule(
values = [
"",
"default",
"package",
"disable",
"legacy",
],
Expand Down
5 changes: 5 additions & 0 deletions internal/language/go/constants.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,9 @@ const (
// legacyProtoFilegroupName is the anme of a filegroup created in legacy
// mode for libraries that contained .pb.go files and .proto files.
legacyProtoFilegroupName = "go_default_library_protos"
// wellKnownTypesGoPrefix is the import path for the Go repository containing
// pre-generated code for the Well Known Types.
wellKnownTypesGoPrefix = "github.com/golang/protobuf"
// wellKnownTypesPkg is the package name for the predefined WKTs in rules_go.
wellKnownTypesPkg = "proto/wkt"
)
15 changes: 9 additions & 6 deletions internal/language/go/fileinfo_go_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,13 +365,16 @@ import "C"
c.RepoRoot = repo
gc := getGoConfig(c)
gc.prefix = "example.com/repo"
got := buildPackage(c, sub, "sub", []string{"sub.go"}, nil, nil, false, "", nil)
pkgs, _ := buildPackages(c, sub, "sub", []string{"sub.go"}, false)
got, ok := pkgs["sub"]
if !ok {
t.Fatal("did not build package 'sub'")
}
want := &goPackage{
name: "sub",
dir: sub,
rel: "sub",
importPath: "example.com/repo/sub",
library: goTarget{cgo: true},
name: "sub",
dir: sub,
rel: "sub",
library: goTarget{cgo: true},
}
want.library.sources.addGenericString("sub.go")
want.library.copts.addGenericString("-Isub/..")
Expand Down
Loading