Skip to content

scala_doc: Export ScaladocAspectInfo to allow users to build custom scaladoc aspects #1404

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

Merged
merged 1 commit into from
Jun 8, 2022
Merged

scala_doc: Export ScaladocAspectInfo to allow users to build custom scaladoc aspects #1404

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
14 changes: 7 additions & 7 deletions scala/private/rules/scala_doc.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

load("@io_bazel_rules_scala//scala/private:common.bzl", "collect_plugin_paths")

_ScaladocAspectInfo = provider(fields = [
ScaladocAspectInfo = provider(fields = [
"src_files",
"compile_jars",
"plugins",
Expand All @@ -23,7 +23,7 @@ def _scaladoc_aspect_impl(target, ctx, transitive = True):
# Sometimes we only want to generate scaladocs for a single target and not all of its
# dependencies
if transitive:
transitive_deps = [dep[_ScaladocAspectInfo].src_files for dep in ctx.rule.attr.deps if _ScaladocAspectInfo in dep]
transitive_deps = [dep[ScaladocAspectInfo].src_files for dep in ctx.rule.attr.deps if ScaladocAspectInfo in dep]
else:
transitive_deps = []

Expand All @@ -34,15 +34,15 @@ def _scaladoc_aspect_impl(target, ctx, transitive = True):
direct = [file for file in ctx.rule.files.deps],
transitive = (
[dep[JavaInfo].compile_jars for dep in ctx.rule.attr.deps if JavaInfo in dep] +
[dep[_ScaladocAspectInfo].compile_jars for dep in ctx.rule.attr.deps if _ScaladocAspectInfo in dep]
[dep[ScaladocAspectInfo].compile_jars for dep in ctx.rule.attr.deps if ScaladocAspectInfo in dep]
),
)

plugins = depset()
if hasattr(ctx.rule.attr, "plugins"):
plugins = depset(direct = ctx.rule.attr.plugins)

return [_ScaladocAspectInfo(
return [ScaladocAspectInfo(
src_files = src_files,
compile_jars = compile_jars,
plugins = plugins,
Expand Down Expand Up @@ -71,11 +71,11 @@ def _scala_doc_impl(ctx):
output_path = ctx.actions.declare_directory("{}.html".format(ctx.attr.name))

# Collect all source files and compile_jars to pass to scaladoc by way of an aspect.
src_files = depset(transitive = [dep[_ScaladocAspectInfo].src_files for dep in ctx.attr.deps])
compile_jars = depset(transitive = [dep[_ScaladocAspectInfo].compile_jars for dep in ctx.attr.deps])
src_files = depset(transitive = [dep[ScaladocAspectInfo].src_files for dep in ctx.attr.deps])
compile_jars = depset(transitive = [dep[ScaladocAspectInfo].compile_jars for dep in ctx.attr.deps])

# Get the 'real' paths to the plugin jars.
plugins = collect_plugin_paths(depset(transitive = [dep[_ScaladocAspectInfo].plugins for dep in ctx.attr.deps]).to_list())
plugins = collect_plugin_paths(depset(transitive = [dep[ScaladocAspectInfo].plugins for dep in ctx.attr.deps]).to_list())

# Construct the full classpath depset since we need to add compiler plugins too.
classpath = depset(transitive = [plugins, compile_jars])
Expand Down
2 changes: 2 additions & 0 deletions scala/scala.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ load(
)
load(
"@io_bazel_rules_scala//scala/private:rules/scala_doc.bzl",
_ScaladocAspectInfo = "ScaladocAspectInfo",
_make_scala_doc_rule = "make_scala_doc_rule",
_scaladoc_intransitive_aspect = "scaladoc_intransitive_aspect",
)
Expand Down Expand Up @@ -56,6 +57,7 @@ scala_binary = _scala_binary
make_scala_doc_rule = _make_scala_doc_rule
scaladoc_intransitive_aspect = _scaladoc_intransitive_aspect
scala_doc = _make_scala_doc_rule()
ScaladocAspectInfo = _ScaladocAspectInfo
scala_junit_test = _scala_junit_test
scala_library = _scala_library
scala_library_for_plugin_bootstrapping = _scala_library_for_plugin_bootstrapping
Expand Down