Swift rules

Rules for generating Swift protobuf and gRPC .swift files and libraries using Swift Protobuf and Swift gRPC

Rule	Description
swift_proto_compile	Generates Swift protobuf `.swift` files
swift_grpc_compile	Generates Swift protobuf and gRPC `.swift` files
swift_proto_library	Generates a Swift protobuf library using `swift_library` from `rules_swift`
swift_grpc_library	Generates a Swift protobuf and gRPC library using `swift_library` from `rules_swift`

`swift_proto_compile`

Generates Swift protobuf .swift files

`WORKSPACE`

load("@rules_proto_grpc//swift:repositories.bzl", rules_proto_grpc_swift_repos = "swift_repos")

rules_proto_grpc_swift_repos()

load(
    "@build_bazel_rules_swift//swift:repositories.bzl",
    "swift_rules_dependencies",
)

swift_rules_dependencies()

`BUILD.bazel`

load("@rules_proto_grpc//swift:defs.bzl", "swift_proto_compile")

swift_proto_compile(
    name = "person_swift_proto",
    protos = ["@rules_proto_grpc//example/proto:person_proto"],
)

swift_proto_compile(
    name = "place_swift_proto",
    protos = ["@rules_proto_grpc//example/proto:place_proto"],
)

swift_proto_compile(
    name = "thing_swift_proto",
    protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)

Attributes

Name	Type	Mandatory	Default	Description
`protos`	`list<ProtoInfo>`	true	`[]`	List of labels that provide a `ProtoInfo` (such as `rules_proto` `proto_library`)
`options`	`dict<string, list(string)>`	false	`[]`	Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins
`verbose`	`int`	false	`0`	The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc
`prefix_path`	`string`	false	`""`	Path to prefix to the generated files in the output directory
`extra_protoc_args`	`list<string>`	false	`[]`	A list of extra args to pass directly to protoc, not as plugin options

Plugins

@rules_proto_grpc//swift:swift_plugin

`swift_grpc_compile`

Generates Swift protobuf and gRPC .swift files

`WORKSPACE`

load("@rules_proto_grpc//swift:repositories.bzl", rules_proto_grpc_swift_repos = "swift_repos")

rules_proto_grpc_swift_repos()

load(
    "@build_bazel_rules_swift//swift:repositories.bzl",
    "swift_rules_dependencies",
)

swift_rules_dependencies()

`BUILD.bazel`

load("@rules_proto_grpc//swift:defs.bzl", "swift_grpc_compile")

swift_grpc_compile(
    name = "thing_swift_grpc",
    protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)

swift_grpc_compile(
    name = "greeter_swift_grpc",
    protos = ["@rules_proto_grpc//example/proto:greeter_grpc"],
)

Attributes

Name	Type	Mandatory	Default	Description
`protos`	`list<ProtoInfo>`	true	`[]`	List of labels that provide a `ProtoInfo` (such as `rules_proto` `proto_library`)
`options`	`dict<string, list(string)>`	false	`[]`	Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins
`verbose`	`int`	false	`0`	The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc
`prefix_path`	`string`	false	`""`	Path to prefix to the generated files in the output directory
`extra_protoc_args`	`list<string>`	false	`[]`	A list of extra args to pass directly to protoc, not as plugin options

Plugins

@rules_proto_grpc//swift:swift_plugin
@rules_proto_grpc//swift:grpc_swift_plugin

`swift_proto_library`

Generates a Swift protobuf library using swift_library from rules_swift

`WORKSPACE`

load("@rules_proto_grpc//swift:repositories.bzl", rules_proto_grpc_swift_repos = "swift_repos")

rules_proto_grpc_swift_repos()

load(
    "@build_bazel_rules_swift//swift:repositories.bzl",
    "swift_rules_dependencies",
)

swift_rules_dependencies()

`BUILD.bazel`

load("@rules_proto_grpc//swift:defs.bzl", "swift_proto_library")

swift_proto_library(
    name = "proto_swift_proto",
    protos = [
        "@rules_proto_grpc//example/proto:person_proto",
        "@rules_proto_grpc//example/proto:place_proto",
        "@rules_proto_grpc//example/proto:thing_proto",
    ],
)

Attributes

Name	Type	Mandatory	Default	Description
`protos`	`list<ProtoInfo>`	true	`[]`	List of labels that provide a `ProtoInfo` (such as `rules_proto` `proto_library`)
`options`	`dict<string, list(string)>`	false	`[]`	Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins
`verbose`	`int`	false	`0`	The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc
`prefix_path`	`string`	false	`""`	Path to prefix to the generated files in the output directory
`extra_protoc_args`	`list<string>`	false	`[]`	A list of extra args to pass directly to protoc, not as plugin options
`deps`	`list<Label/string>`	false	`[]`	List of labels to pass as deps attr to underlying lang_library rule
`module_name`	`string`	false	``	The name of the Swift module being built.

`swift_grpc_library`

Generates a Swift protobuf and gRPC library using swift_library from rules_swift

`WORKSPACE`

load("@rules_proto_grpc//swift:repositories.bzl", rules_proto_grpc_swift_repos = "swift_repos")

rules_proto_grpc_swift_repos()

load(
    "@build_bazel_rules_swift//swift:repositories.bzl",
    "swift_rules_dependencies",
)

swift_rules_dependencies()

`BUILD.bazel`

load("@rules_proto_grpc//swift:defs.bzl", "swift_grpc_library")

swift_grpc_library(
    name = "greeter_swift_grpc",
    protos = [
        "@rules_proto_grpc//example/proto:greeter_grpc",
        "@rules_proto_grpc//example/proto:thing_proto",
    ],
)

Attributes

Name	Type	Mandatory	Default	Description
`protos`	`list<ProtoInfo>`	true	`[]`	List of labels that provide a `ProtoInfo` (such as `rules_proto` `proto_library`)
`options`	`dict<string, list(string)>`	false	`[]`	Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins
`verbose`	`int`	false	`0`	The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc
`prefix_path`	`string`	false	`""`	Path to prefix to the generated files in the output directory
`extra_protoc_args`	`list<string>`	false	`[]`	A list of extra args to pass directly to protoc, not as plugin options
`deps`	`list<Label/string>`	false	`[]`	List of labels to pass as deps attr to underlying lang_library rule
`module_name`	`string`	false	``	The name of the Swift module being built.