Skip to content

Commit 91f250d

Browse files
jelbournatscott
jelbourn
authored and
atscott
committed
build: configure cross-pkg resolution for api extraction (#52499)
This commit adds path mapping and source dependencies necessary to fully resolve types during api doc extraction. PR Close #52499
1 parent 5e84d9c commit 91f250d

File tree

37 files changed

+197
-80
lines changed

37 files changed

+197
-80
lines changed

‎WORKSPACE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ yarn_install(
8080
"//:.yarnrc",
8181
"//:tools/npm-patches/@bazel+jasmine+5.8.1.patch",
8282
"//tools:postinstall-patches.js",
83-
"//tools/esm-interop:patches/npm/@angular+build-tooling+0.0.0-b2cec2dcba358f9dc7111800a3d65738f57abe8f.patch",
83+
"//tools/esm-interop:patches/npm/@angular+build-tooling+0.0.0-e0ec7b60641d7f6369be45d8d02663fd50f320be.patch",
8484
"//tools/esm-interop:patches/npm/@bazel+concatjs+5.8.1.patch",
8585
"//tools/esm-interop:patches/npm/@bazel+esbuild+5.7.1.patch",
8686
"//tools/esm-interop:patches/npm/@bazel+protractor+5.7.1.patch",

‎packages/BUILD.bazel‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,28 @@ filegroup(
4545
srcs = ["//packages/%s:files_for_docgen" % entrypoint for entrypoint in DOCS_ENTRYPOINTS],
4646
)
4747

48+
# This target captures common dependencies needed for all `generate_api_docs` targets
49+
# throughout Angular's public API surface.
50+
filegroup(
51+
name = "common_files_and_deps_for_docs",
52+
srcs = [
53+
"//packages:types",
54+
"//packages/common:files_for_docgen",
55+
"//packages/common/http:files_for_docgen",
56+
"//packages/core:files_for_docgen",
57+
"//packages/core/primitives/signals:files_for_docgen",
58+
"//packages/core/src/compiler:files_for_docgen",
59+
"//packages/core/src/di/interface:files_for_docgen",
60+
"//packages/core/src/interface:files_for_docgen",
61+
"//packages/core/src/reflection:files_for_docgen",
62+
"//packages/core/src/util:files_for_docgen",
63+
"//packages/platform-browser:files_for_docgen",
64+
"//packages/platform-browser-dynamic:files_for_docgen",
65+
"//packages/zone.js/lib:zone_d_ts",
66+
"@npm//rxjs",
67+
],
68+
)
69+
4870
generate_api_manifest(
4971
name = "docs_api_manifest",
5072
srcs = [

‎packages/animations/BUILD.bazel‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
load("//tools:defaults.bzl", "api_golden_test", "api_golden_test_npm_package", "ng_module", "ng_package")
2-
load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
1+
load("//tools:defaults.bzl", "api_golden_test", "api_golden_test_npm_package", "generate_api_docs", "ng_module", "ng_package")
32

43
package(default_visibility = ["//visibility:public"])
54

@@ -75,7 +74,11 @@ filegroup(
7574

7675
generate_api_docs(
7776
name = "animations_docs",
78-
srcs = [":files_for_docgen"],
77+
srcs = [
78+
":files_for_docgen",
79+
"//packages:common_files_and_deps_for_docs",
80+
"//packages/common:files_for_docgen",
81+
],
7982
entry_point = ":index.ts",
8083
module_name = "@angular/animations",
8184
)

‎packages/animations/browser/BUILD.bazel‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
load("//tools:defaults.bzl", "ng_module")
2-
load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
1+
load("//tools:defaults.bzl", "generate_api_docs", "ng_module")
32

43
package(default_visibility = ["//visibility:public"])
54

@@ -29,7 +28,11 @@ filegroup(
2928

3029
generate_api_docs(
3130
name = "animations_browser_docs",
32-
srcs = [":files_for_docgen"],
31+
srcs = [
32+
":files_for_docgen",
33+
"//packages:common_files_and_deps_for_docs",
34+
"//packages/animations:files_for_docgen",
35+
],
3336
entry_point = ":index.ts",
3437
module_name = "@angular/animations/browser",
3538
)

‎packages/animations/browser/testing/BUILD.bazel‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
load("//tools:defaults.bzl", "ng_module")
2-
load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
1+
load("//tools:defaults.bzl", "generate_api_docs", "ng_module")
32

43
package(default_visibility = ["//visibility:public"])
54

@@ -24,7 +23,10 @@ filegroup(
2423

2524
generate_api_docs(
2625
name = "animations_browser_testing_docs",
27-
srcs = [":files_for_docgen"],
26+
srcs = [
27+
":files_for_docgen",
28+
"//packages:common_files_and_deps_for_docs",
29+
],
2830
entry_point = ":index.ts",
2931
module_name = "@angular/animations/browser/testing",
3032
)

‎packages/common/BUILD.bazel‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
load("@build_bazel_rules_nodejs//:index.bzl", "generated_file_test")
22
load("//packages/common/locales:index.bzl", "generate_base_currencies_file")
3-
load("//tools:defaults.bzl", "api_golden_test", "api_golden_test_npm_package", "ng_module", "ng_package")
4-
load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
3+
load("//tools:defaults.bzl", "api_golden_test", "api_golden_test_npm_package", "generate_api_docs", "ng_module", "ng_package")
54

65
package(default_visibility = ["//visibility:public"])
76

@@ -100,7 +99,12 @@ filegroup(
10099

101100
generate_api_docs(
102101
name = "common_docs",
103-
srcs = [":files_for_docgen"],
102+
srcs = [
103+
":files_for_docgen",
104+
"//packages:common_files_and_deps_for_docs",
105+
"//packages/platform-browser:files_for_docgen",
106+
"//packages/platform-browser-dynamic:files_for_docgen",
107+
],
104108
entry_point = ":index.ts",
105109
module_name = "@angular/common",
106110
)

‎packages/common/http/BUILD.bazel‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
load("//tools:defaults.bzl", "api_golden_test", "ng_module")
2-
load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
1+
load("//tools:defaults.bzl", "api_golden_test", "generate_api_docs", "ng_module")
32

43
package(default_visibility = ["//visibility:public"])
54

@@ -40,7 +39,11 @@ api_golden_test(
4039

4140
generate_api_docs(
4241
name = "http_docs",
43-
srcs = [":files_for_docgen"],
42+
srcs = [
43+
":files_for_docgen",
44+
"//packages:common_files_and_deps_for_docs",
45+
"//packages/common:files_for_docgen",
46+
],
4447
entry_point = ":index.ts",
4548
module_name = "@angular/common/http",
4649
)

‎packages/common/testing/BUILD.bazel‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
load("//tools:defaults.bzl", "ng_module")
2-
load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
1+
load("//tools:defaults.bzl", "generate_api_docs", "ng_module")
32

43
package(default_visibility = ["//visibility:public"])
54

@@ -25,7 +24,10 @@ filegroup(
2524

2625
generate_api_docs(
2726
name = "common_testing_docs",
28-
srcs = [":files_for_docgen"],
27+
srcs = [
28+
":files_for_docgen",
29+
"//packages:common_files_and_deps_for_docs",
30+
],
2931
entry_point = ":index.ts",
3032
module_name = "@angular/common/testing",
3133
)

‎packages/common/upgrade/BUILD.bazel‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
load("//tools:defaults.bzl", "ng_module")
2-
load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
1+
load("//tools:defaults.bzl", "generate_api_docs", "ng_module")
32

43
package(default_visibility = ["//visibility:public"])
54

@@ -31,7 +30,10 @@ filegroup(
3130

3231
generate_api_docs(
3332
name = "common_upgrade_docs",
34-
srcs = [":files_for_docgen"],
33+
srcs = [
34+
":files_for_docgen",
35+
"//packages:common_files_and_deps_for_docs",
36+
],
3537
entry_point = ":index.ts",
3638
module_name = "@angular/common/upgrade",
3739
)

‎packages/core/BUILD.bazel‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,9 @@ filegroup(
136136

137137
generate_api_docs(
138138
name = "core_docs",
139-
srcs = [":files_for_docgen"],
139+
srcs = [
140+
"//packages:common_files_and_deps_for_docs",
141+
],
140142
entry_point = ":index.ts",
141143
module_name = "@angular/core",
142144
)

0 commit comments

Comments
 (0)