From c11ef4fade8ea7787ad2778d7330238aff083dc8 Mon Sep 17 00:00:00 2001 From: Alan Agius Date: Thu, 31 Oct 2024 09:32:57 +0000 Subject: [PATCH] build(docs-infra): include API references for `@angular/ssr` entry points (#58445) This commit utilizes the `@angular/ssr` NPM package to generate an API reference for its entry points using the `generate_api_docs` Bazel rule, which will be included in http://angular.dev/api. PR Close #58445 --- adev/src/assets/BUILD.bazel | 3 +++ packages/BUILD.bazel | 36 +++++++++++++++++++++++++++++++++++- packages/ssr/BUILD.bazel | 34 ++++++++++++++++++++++++++++++++++ 3 files changed, 72 insertions(+), 1 deletion(-) create mode 100644 packages/ssr/BUILD.bazel diff --git a/adev/src/assets/BUILD.bazel b/adev/src/assets/BUILD.bazel index 5af491b2733..7cda4a66498 100644 --- a/adev/src/assets/BUILD.bazel +++ b/adev/src/assets/BUILD.bazel @@ -40,6 +40,9 @@ copy_to_directory( "//adev/src/content/tutorials/deferrable-views:deferrable-views-guides", "//adev/src/content/tutorials/first-app:first-app-guides", "//adev/src/content/tutorials/learn-angular:learn-angular-guides", + "//packages:angular_ssr_docs", + "//packages:angular_ssr_node_docs", + "//packages:angular_ssr_tokens_docs", "//packages/animations:animations_docs", "//packages/animations/browser:animations_browser_docs", "//packages/animations/browser/testing:animations_browser_testing_docs", diff --git a/packages/BUILD.bazel b/packages/BUILD.bazel index e9abe2f97b6..91be457c6fb 100644 --- a/packages/BUILD.bazel +++ b/packages/BUILD.bazel @@ -1,4 +1,4 @@ -load("//tools:defaults.bzl", "ts_config", "ts_library") +load("//tools:defaults.bzl", "generate_api_docs", "ts_config", "ts_library") load("//:packages.bzl", "DOCS_ENTRYPOINTS") load("//adev/shared-docs/pipeline/api-gen/manifest:generate_api_manifest.bzl", "generate_api_manifest") @@ -70,6 +70,9 @@ filegroup( generate_api_manifest( name = "docs_api_manifest", srcs = [ + ":angular_ssr_docs_extraction", + ":angular_ssr_node_docs_extraction", + ":angular_ssr_tokens_docs_extraction", "//packages/animations:animations_docs_extraction", "//packages/animations/browser:animations_browser_docs_extraction", "//packages/animations/browser/testing:animations_browser_testing_docs_extraction", @@ -106,3 +109,34 @@ generate_api_manifest( "//tools/manual_api_docs/elements", ], ) + +### @angular/ssr package located in the Angular/CLI repository +generate_api_docs( + name = "angular_ssr_docs", + srcs = [ + ":common_files_and_deps_for_docs", + "@npm//@angular/ssr", + ], + entry_point = "@npm//:node_modules/@angular/ssr/index.d.ts", + module_name = "@angular/ssr", +) + +generate_api_docs( + name = "angular_ssr_node_docs", + srcs = [ + ":common_files_and_deps_for_docs", + "@npm//@angular/ssr", + ], + entry_point = "@npm//:node_modules/@angular/ssr/node/index.d.ts", + module_name = "@angular/ssr/node", +) + +generate_api_docs( + name = "angular_ssr_tokens_docs", + srcs = [ + ":common_files_and_deps_for_docs", + "@npm//@angular/ssr", + ], + entry_point = "@npm//:node_modules/@angular/ssr/tokens/index.d.ts", + module_name = "@angular/ssr/tokens", +) diff --git a/packages/ssr/BUILD.bazel b/packages/ssr/BUILD.bazel new file mode 100644 index 00000000000..d5d788a1b9d --- /dev/null +++ b/packages/ssr/BUILD.bazel @@ -0,0 +1,34 @@ +load("//tools:defaults.bzl", "generate_api_docs") + +package(default_visibility = ["//visibility:public"]) + +### @angular/ssr package located in the Angular/CLI repository +generate_api_docs( + name = "ssr_docs", + srcs = [ + "//packages:common_files_and_deps_for_docs", + "@npm//@angular/ssr", + ], + entry_point = "@npm//:node_modules/@angular/ssr/index.d.ts", + module_name = "@angular/ssr", +) + +generate_api_docs( + name = "ssr_node_docs", + srcs = [ + "//packages:common_files_and_deps_for_docs", + "@npm//@angular/ssr", + ], + entry_point = "@npm//:node_modules/@angular/ssr/node/index.d.ts", + module_name = "@angular/ssr/node", +) + +generate_api_docs( + name = "ssr_tokens_docs", + srcs = [ + "//packages:common_files_and_deps_for_docs", + "@npm//@angular/ssr", + ], + entry_point = "@npm//:node_modules/@angular/ssr/tokens/index.d.ts", + module_name = "@angular/ssr/tokens", +)