build: add targets for api doc generation (angular#52034)

jelbourn · atscott · commit fcc000e80361 · 2023-10-10T16:18:50.000-07:00
This adds `generate_api_docs` targets to all of the packages for which we publish api reference docs. One known issue here is that any type information that comes from another package (e.g. router depending on core) currently resolve to `any` because the other sources are not available in the program. This can be tackled in a follow-up commit. This commit also updates the install patch for `@angular/build-tools` to use the local version of compiler-cli. PR Close angular#52034
diff --git a/WORKSPACE b/WORKSPACE
@@ -80,7 +80,7 @@ yarn_install(
         "//:.yarnrc",
         "//:tools/npm-patches/@bazel+jasmine+5.8.1.patch",
         "//tools:postinstall-patches.js",
-        "//tools/esm-interop:patches/npm/@angular+build-tooling+0.0.0-0109d498b0f6aae418ed4924a5e5c65695f0ac61.patch",
+        "//tools/esm-interop:patches/npm/@angular+build-tooling+0.0.0-680aab4562e5bb684518ca496cb449a6c447601d.patch",
         "//tools/esm-interop:patches/npm/@bazel+concatjs+5.8.1.patch",
         "//tools/esm-interop:patches/npm/@bazel+esbuild+5.7.1.patch",
         "//tools/esm-interop:patches/npm/@bazel+protractor+5.7.1.patch",
diff --git a/packages/animations/BUILD.bazel b/packages/animations/BUILD.bazel
@@ -1,4 +1,5 @@
 load("//tools:defaults.bzl", "api_golden_test", "api_golden_test_npm_package", "ng_module", "ng_package")
+load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -69,3 +70,10 @@ filegroup(
         "src/**/*.ts",
     ]) + ["PACKAGE.md"],
 )
+
+generate_api_docs(
+    name = "animations_docs",
+    srcs = [":files_for_docgen"],
+    entry_point = ":index.ts",
+    module_name = "@angular/animations",
+)
diff --git a/packages/animations/browser/BUILD.bazel b/packages/animations/browser/BUILD.bazel
@@ -1,4 +1,5 @@
 load("//tools:defaults.bzl", "ng_module")
+load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -25,3 +26,10 @@ filegroup(
         "src/**/*.ts",
     ]) + ["PACKAGE.md"],
 )
+
+generate_api_docs(
+    name = "animations_browser_docs",
+    srcs = [":files_for_docgen"],
+    entry_point = ":index.ts",
+    module_name = "@angular/animations/browser",
+)
diff --git a/packages/animations/browser/testing/BUILD.bazel b/packages/animations/browser/testing/BUILD.bazel
@@ -1,4 +1,5 @@
 load("//tools:defaults.bzl", "ng_module")
+load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -20,3 +21,10 @@ filegroup(
         "src/**/*.ts",
     ]) + ["PACKAGE.md"],
 )
+
+generate_api_docs(
+    name = "animations_browser_testing_docs",
+    srcs = [":files_for_docgen"],
+    entry_point = ":index.ts",
+    module_name = "@angular/animations/browser/testing",
+)
diff --git a/packages/common/BUILD.bazel b/packages/common/BUILD.bazel
@@ -1,6 +1,7 @@
 load("@build_bazel_rules_nodejs//:index.bzl", "generated_file_test")
 load("//packages/common/locales:index.bzl", "generate_base_currencies_file")
 load("//tools:defaults.bzl", "api_golden_test", "api_golden_test_npm_package", "ng_module", "ng_package")
+load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -94,3 +95,10 @@ filegroup(
         "src/**/*.ts",
     ]) + ["PACKAGE.md"],
 )
+
+generate_api_docs(
+    name = "common_docs",
+    srcs = [":files_for_docgen"],
+    entry_point = ":index.ts",
+    module_name = "@angular/common",
+)
diff --git a/packages/common/http/BUILD.bazel b/packages/common/http/BUILD.bazel
@@ -1,4 +1,5 @@
 load("//tools:defaults.bzl", "api_golden_test", "ng_module")
+load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -36,3 +37,10 @@ api_golden_test(
     entry_point = "angular/packages/common/http/src/errors.d.ts",
     golden = "angular/goldens/public-api/common/http/errors.md",
 )
+
+generate_api_docs(
+    name = "http_docs",
+    srcs = [":files_for_docgen"],
+    entry_point = ":index.ts",
+    module_name = "@angular/common/http",
+)
diff --git a/packages/common/testing/BUILD.bazel b/packages/common/testing/BUILD.bazel
@@ -1,4 +1,5 @@
 load("//tools:defaults.bzl", "ng_module")
+load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -21,3 +22,10 @@ filegroup(
         "src/**/*.ts",
     ]) + ["PACKAGE.md"],
 )
+
+generate_api_docs(
+    name = "common_testing_docs",
+    srcs = [":files_for_docgen"],
+    entry_point = ":index.ts",
+    module_name = "@angular/common/testing",
+)
diff --git a/packages/common/upgrade/BUILD.bazel b/packages/common/upgrade/BUILD.bazel
@@ -1,4 +1,5 @@
 load("//tools:defaults.bzl", "ng_module")
+load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -27,3 +28,10 @@ filegroup(
         "src/**/*.ts",
     ]) + ["PACKAGE.md"],
 )
+
+generate_api_docs(
+    name = "common_upgrade_docs",
+    srcs = [":files_for_docgen"],
+    entry_point = ":index.ts",
+    module_name = "@angular/common/upgrade",
+)
diff --git a/packages/core/BUILD.bazel b/packages/core/BUILD.bazel
@@ -1,6 +1,7 @@
 load("@build_bazel_rules_nodejs//:index.bzl", "generated_file_test")
 load("//tools:defaults.bzl", "api_golden_test", "api_golden_test_npm_package", "ng_module", "ng_package", "tsec_test")
 load("//packages/common/locales:index.bzl", "generate_base_locale_file")
+load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -130,3 +131,10 @@ filegroup(
         "global/index.ts",
     ],
 )
+
+generate_api_docs(
+    name = "core_docs",
+    srcs = [":files_for_docgen"],
+    entry_point = ":index.ts",
+    module_name = "@angular/core",
+)
diff --git a/packages/core/rxjs-interop/BUILD.bazel b/packages/core/rxjs-interop/BUILD.bazel
@@ -1,4 +1,5 @@
 load("//tools:defaults.bzl", "ng_module")
+load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -26,3 +27,10 @@ filegroup(
         "src/**/*.ts",
     ]) + ["PACKAGE.md"],
 )
+
+generate_api_docs(
+    name = "core_rxjs-interop_docs",
+    srcs = [":files_for_docgen"],
+    entry_point = ":index.ts",
+    module_name = "@angular/core/rxjs-interop",
+)
diff --git a/packages/core/testing/BUILD.bazel b/packages/core/testing/BUILD.bazel
@@ -1,4 +1,5 @@
 load("//tools:defaults.bzl", "ng_module")
+load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -26,3 +27,10 @@ filegroup(
         "src/**/*.ts",
     ]) + ["PACKAGE.md"],
 )
+
+generate_api_docs(
+    name = "core_testing_docs",
+    srcs = [":files_for_docgen"],
+    entry_point = ":index.ts",
+    module_name = "@angular/core/testing",
+)
diff --git a/packages/elements/BUILD.bazel b/packages/elements/BUILD.bazel
@@ -1,4 +1,5 @@
 load("//tools:defaults.bzl", "api_golden_test_npm_package", "ng_module", "ng_package")
+load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -54,3 +55,10 @@ filegroup(
         "src/**/*.ts",
     ]) + ["PACKAGE.md"],
 )
+
+generate_api_docs(
+    name = "elements_docs",
+    srcs = [":files_for_docgen"],
+    entry_point = ":index.ts",
+    module_name = "@angular/elements",
+)
diff --git a/packages/forms/BUILD.bazel b/packages/forms/BUILD.bazel
@@ -1,4 +1,5 @@
 load("//tools:defaults.bzl", "api_golden_test", "api_golden_test_npm_package", "ng_module", "ng_package")
+load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -67,3 +68,10 @@ filegroup(
         "src/**/*.ts",
     ]) + ["PACKAGE.md"],
 )
+
+generate_api_docs(
+    name = "forms_docs",
+    srcs = [":files_for_docgen"],
+    entry_point = ":index.ts",
+    module_name = "@angular/forms",
+)
diff --git a/packages/localize/BUILD.bazel b/packages/localize/BUILD.bazel
@@ -1,5 +1,6 @@
 load("//tools:defaults.bzl", "api_golden_test_npm_package", "ng_package", "ts_library")
 load("//packages/bazel:index.bzl", "types_bundle")
+load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -78,3 +79,10 @@ filegroup(
         "src/**/*.ts",
     ]) + ["PACKAGE.md"],
 )
+
+generate_api_docs(
+    name = "localize_docs",
+    srcs = [":files_for_docgen"],
+    entry_point = ":index.ts",
+    module_name = "@angular/localize",
+)
diff --git a/packages/platform-browser-dynamic/BUILD.bazel b/packages/platform-browser-dynamic/BUILD.bazel
@@ -1,4 +1,5 @@
 load("//tools:defaults.bzl", "api_golden_test_npm_package", "ng_module", "ng_package")
+load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -60,3 +61,10 @@ filegroup(
         "src/**/*.ts",
     ]) + ["PACKAGE.md"],
 )
+
+generate_api_docs(
+    name = "platform-browser_dynamic_docs",
+    srcs = [":files_for_docgen"],
+    entry_point = ":index.ts",
+    module_name = "@angular/platform-browser-dynamic",
+)
diff --git a/packages/platform-browser-dynamic/testing/BUILD.bazel b/packages/platform-browser-dynamic/testing/BUILD.bazel
@@ -1,4 +1,5 @@
 load("//tools:defaults.bzl", "ng_module")
+load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -25,3 +26,10 @@ filegroup(
         "src/**/*.ts",
     ]) + ["PACKAGE.md"],
 )
+
+generate_api_docs(
+    name = "platform-browser_dynamic_testing_docs",
+    srcs = [":files_for_docgen"],
+    entry_point = ":index.ts",
+    module_name = "@angular/platform-browser-dynamic/testing",
+)
diff --git a/packages/platform-browser/BUILD.bazel b/packages/platform-browser/BUILD.bazel
@@ -1,4 +1,5 @@
 load("//tools:defaults.bzl", "api_golden_test", "api_golden_test_npm_package", "ng_module", "ng_package", "tsec_test")
+load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -80,3 +81,10 @@ filegroup(
         "src/**/*.ts",
     ]) + ["PACKAGE.md"],
 )
+
+generate_api_docs(
+    name = "platform-browser_docs",
+    srcs = [":files_for_docgen"],
+    entry_point = ":index.ts",
+    module_name = "@angular/platform-browser",
+)
diff --git a/packages/platform-browser/animations/BUILD.bazel b/packages/platform-browser/animations/BUILD.bazel
@@ -1,4 +1,5 @@
 load("//tools:defaults.bzl", "ng_module", "tsec_test")
+load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -34,3 +35,10 @@ filegroup(
         "src/**/*.ts",
     ]) + ["PACKAGE.md"],
 )
+
+generate_api_docs(
+    name = "platform-browser_animations_docs",
+    srcs = [":files_for_docgen"],
+    entry_point = ":index.ts",
+    module_name = "@angular/platform-browser/animations",
+)
diff --git a/packages/platform-browser/testing/BUILD.bazel b/packages/platform-browser/testing/BUILD.bazel
@@ -1,4 +1,5 @@
 load("//tools:defaults.bzl", "ng_module")
+load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -24,3 +25,10 @@ filegroup(
         "src/**/*.ts",
     ]) + ["PACKAGE.md"],
 )
+
+generate_api_docs(
+    name = "platform-browser_testing_docs",
+    srcs = [":files_for_docgen"],
+    entry_point = ":index.ts",
+    module_name = "@angular/platform-browser/testing",
+)
diff --git a/packages/platform-server/BUILD.bazel b/packages/platform-server/BUILD.bazel
@@ -1,5 +1,6 @@
 load("@build_bazel_rules_nodejs//:index.bzl", "js_library")
 load("//tools:defaults.bzl", "api_golden_test_npm_package", "esbuild", "ng_module", "ng_package", "tsec_test")
+load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -96,3 +97,10 @@ filegroup(
         "src/**/*.ts",
     ]) + ["PACKAGE.md"],
 )
+
+generate_api_docs(
+    name = "platform-server_docs",
+    srcs = [":files_for_docgen"],
+    entry_point = ":index.ts",
+    module_name = "@angular/platform-server",
+)
diff --git a/packages/platform-server/testing/BUILD.bazel b/packages/platform-server/testing/BUILD.bazel
@@ -1,4 +1,5 @@
 load("//tools:defaults.bzl", "ng_module")
+load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -22,3 +23,10 @@ filegroup(
         "src/**/*.ts",
     ]) + ["PACKAGE.md"],
 )
+
+generate_api_docs(
+    name = "platform-server_testing_docs",
+    srcs = [":files_for_docgen"],
+    entry_point = ":index.ts",
+    module_name = "@angular/platform-server/testing",
+)
diff --git a/packages/router/BUILD.bazel b/packages/router/BUILD.bazel
@@ -1,4 +1,5 @@
 load("//tools:defaults.bzl", "api_golden_test", "api_golden_test_npm_package", "ng_module", "ng_package")
+load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -73,3 +74,10 @@ filegroup(
         "src/**/*.ts",
     ]) + ["PACKAGE.md"],
 )
+
+generate_api_docs(
+    name = "router_docs",
+    srcs = [":files_for_docgen"],
+    entry_point = ":index.ts",
+    module_name = "@angular/router",
+)
diff --git a/packages/router/testing/BUILD.bazel b/packages/router/testing/BUILD.bazel
@@ -1,4 +1,5 @@
 load("//tools:defaults.bzl", "ng_module")
+load("@npm//@angular/build-tooling/bazel/api-gen:generate_api_docs.bzl", "generate_api_docs")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -24,3 +25,10 @@ filegroup(
         "src/**/*.ts",
     ]) + ["PACKAGE.md"],
 )
+
+generate_api_docs(
+    name = "router_testing_docs",
+    srcs = [":files_for_docgen"],
+    entry_point = ":index.ts",
+    module_name = "@angular/router/testing",
+)
diff --git a/packages/router/upgrade/BUILD.bazel b/packages/router/upgrade/BUILD.bazel
diff --git a/packages/service-worker/BUILD.bazel b/packages/service-worker/BUILD.bazel
diff --git a/packages/upgrade/BUILD.bazel b/packages/upgrade/BUILD.bazel
diff --git a/packages/upgrade/static/BUILD.bazel b/packages/upgrade/static/BUILD.bazel
diff --git a/packages/upgrade/static/testing/BUILD.bazel b/packages/upgrade/static/testing/BUILD.bazel
diff --git a/tools/esm-interop/patches/npm/@angular+build-tooling+0.0.0-680aab4562e5bb684518ca496cb449a6c447601d.patch b/tools/esm-interop/patches/npm/@angular+build-tooling+0.0.0-680aab4562e5bb684518ca496cb449a6c447601d.patch
diff --git a/yarn.lock b/yarn.lock
