Skip to content

Commit 5543644

Browse files
devversiondevversion
committed
build: ensure all entry-points are included in release package
(1) Overhauls the whole release packaging structure in Bazel. Since it is very verbose to put everything into a single `.bzl` file in the project root, information for each release package will be stored in the actual package folder in a file called `config.bzl`. (2) We no longer use the term `PACKAGE` for entry-points of packages. It's not correct and easy to confuse with the actual package. (3) We group entry-points in nested arrays. This has no effect for now, but it gives us a nicer way of configurating (nested) entry-points. It might become useful in the future as well as we have information about nested entry-points of an entry-point. (4) Revisits the list of all entry-points so that we now include all `*/testing` entry-points in the release output. Also a few MDC prototypes were not included in the Bazel material-experimental release output. Same as clipboard in cdk-experimental. (5) Simplifies the logic to generate the rollup globals (through functions). Also we move the rollup globals into a separate `.bzl` file. Also rollup globals are now automatically passed into the `ng_package` rule.. so we don't need to re-declare them for each package.
1 parent baec85e commit 5543644

File tree

19 files changed

+269
-263
lines changed

19 files changed

+269
-263
lines changed

‎packages.bzl‎

Lines changed: 0 additions & 214 deletions
Original file line numberDiff line numberDiff line change
@@ -1,127 +1,3 @@
1-
# List of all components / subpackages.
2-
3-
CDK_PACKAGES = [
4-
"a11y",
5-
"accordion",
6-
"bidi",
7-
"coercion",
8-
"collections",
9-
"drag-drop",
10-
"keycodes",
11-
"layout",
12-
"observers",
13-
"overlay",
14-
"platform",
15-
"portal",
16-
"scrolling",
17-
"stepper",
18-
"table",
19-
"text-field",
20-
"tree",
21-
22-
# NOTE: "testing" should not be listed here as it will be treated as its own
23-
# package. This is because we don't want to include "testing the testing utilities
24-
# in the release output.
25-
]
26-
27-
# Within the CDK, only a few targets have sass libraries which need to be
28-
# part of the release package. This list declares all CDK targets with sass
29-
# libraries that need to be included and re-exported at the package root.
30-
CDK_TARGETS_WITH_STYLES = [
31-
"a11y",
32-
"overlay",
33-
"text-field",
34-
]
35-
36-
CDK_SCSS_LIBS = [
37-
"//src/cdk/%s:%s_scss_lib" % (p, p.replace("-", "_"))
38-
for p in CDK_TARGETS_WITH_STYLES
39-
]
40-
41-
CDK_TARGETS = ["//src/cdk"] + ["//src/cdk/%s" % p for p in CDK_PACKAGES]
42-
43-
CDK_EXPERIMENTAL_PACKAGES = [
44-
"dialog",
45-
"popover-edit",
46-
"scrolling",
47-
]
48-
49-
CDK_EXPERIMENTAL_TARGETS = ["//src/cdk-experimental"] + [
50-
"//src/cdk-experimental/%s" % p
51-
for p in CDK_EXPERIMENTAL_PACKAGES
52-
]
53-
54-
MATERIAL_PACKAGES = [
55-
"autocomplete",
56-
"badge",
57-
"bottom-sheet",
58-
"button",
59-
"button-toggle",
60-
"card",
61-
"checkbox",
62-
"chips",
63-
"core",
64-
"datepicker",
65-
"dialog",
66-
"divider",
67-
"expansion",
68-
"form-field",
69-
"grid-list",
70-
"icon",
71-
"input",
72-
"list",
73-
"menu",
74-
"paginator",
75-
"progress-bar",
76-
"progress-spinner",
77-
"radio",
78-
"select",
79-
"sidenav",
80-
"slide-toggle",
81-
"slider",
82-
"snack-bar",
83-
"sort",
84-
"stepper",
85-
"table",
86-
"tabs",
87-
"toolbar",
88-
"tooltip",
89-
"tree",
90-
]
91-
92-
MATERIAL_TARGETS = ["//src/material"] + ["//src/material/%s" % p for p in MATERIAL_PACKAGES]
93-
94-
# List that references the sass libraries for each Material package. This can be used to create
95-
# the theming scss-bundle or to specify dependencies for the all-theme.scss file.
96-
MATERIAL_SCSS_LIBS = [
97-
"//src/material/%s:%s_scss_lib" % (p, p.replace("-", "_"))
98-
for p in MATERIAL_PACKAGES
99-
]
100-
101-
MATERIAL_EXPERIMENTAL_PACKAGES = [
102-
"mdc-button",
103-
"mdc-card",
104-
"mdc-checkbox",
105-
"mdc-chips",
106-
"mdc-tabs",
107-
"mdc-helpers",
108-
"mdc-menu",
109-
"mdc-radio",
110-
"mdc-slide-toggle",
111-
"mdc-slider",
112-
"popover-edit",
113-
]
114-
115-
MATERIAL_EXPERIMENTAL_TARGETS = ["//src/material-experimental"] + [
116-
"//src/material-experimental/%s" % p
117-
for p in MATERIAL_EXPERIMENTAL_PACKAGES
118-
]
119-
120-
MATERIAL_EXPERIMENTAL_SCSS_LIBS = [
121-
"//src/material-experimental/%s:%s_scss_lib" % (p, p.replace("-", "_"))
122-
for p in MATERIAL_EXPERIMENTAL_PACKAGES
123-
]
124-
1251
# Each individual package uses a placeholder for the version of Angular to ensure they're
1262
# all in-sync. This map is passed to each ng_package rule to stamp out the appropriate
1273
# version for the placeholders.
@@ -132,96 +8,6 @@ VERSION_PLACEHOLDER_REPLACEMENTS = {
1328
"0.0.0-NG": ANGULAR_PACKAGE_VERSION,
1339
}
13410

135-
# Base rollup globals for everything in the repo.
136-
ROLLUP_GLOBALS = {
137-
"@angular/cdk": "ng.cdk",
138-
"@angular/cdk-experimental": "ng.cdkExperimental",
139-
"@angular/google-maps": "ng.googleMaps",
140-
"@angular/material": "ng.material",
141-
"@angular/material-experimental": "ng.materialExperimental",
142-
"@angular/youtube-player": "ng.youtubePlayer",
143-
144-
# MDC Web
145-
"@material/animation": "mdc.animation",
146-
"@material/auto-init": "mdc.autoInit",
147-
"@material/base": "mdc.base",
148-
"@material/checkbox": "mdc.checkbox",
149-
"@material/chips": "mdc.chips",
150-
"@material/dialog": "mdc.dialog",
151-
"@material/dom": "mdc.dom",
152-
"@material/drawer": "mdc.drawer",
153-
"@material/floating-label": "mdc.floatingLabel",
154-
"@material/form-field": "mdc.formField",
155-
"@material/grid-list": "mdc.gridList",
156-
"@material/icon-button": "mdc.iconButton",
157-
"@material/line-ripple": "mdc.lineRipple",
158-
"@material/linear-progress": "mdc.linearProgress",
159-
"@material/list": "mdc.list",
160-
"@material/menu": "mdc.menu",
161-
"@material/menu-surface": "mdc.menuSurface",
162-
"@material/notched-outline": "mdc.notchedOutline",
163-
"@material/radio": "mdc.radio",
164-
"@material/ripple": "mdc.ripple",
165-
"@material/select": "mdc.select",
166-
"@material/slider": "mdc.slider",
167-
"@material/snackbar": "mdc.snackbar",
168-
"@material/switch": "mdc.switch",
169-
"@material/tab": "mdc.tab",
170-
"@material/tab-bar": "mdc.tabBar",
171-
"@material/tab-indicator": "mdc.tabIndicator",
172-
"@material/tab-scroller": "mdc.tabScroller",
173-
"@material/text-field": "mdc.textField",
174-
"@material/top-app-bar": "mdc.topAppBar",
175-
"moment": "moment",
176-
"tslib": "tslib",
177-
}
178-
179-
# Rollup globals for cdk subpackages in the form of, e.g., {"@angular/cdk/table": "ng.cdk.table"}
180-
ROLLUP_GLOBALS.update({
181-
"@angular/cdk/%s" % p: "ng.cdk.%s" % p
182-
for p in CDK_PACKAGES
183-
})
184-
185-
# Rollup globals for cdk subpackages in the form of, e.g.,
186-
# {"@angular/cdk-experimental/scrolling": "ng.cdkExperimental.scrolling"}
187-
ROLLUP_GLOBALS.update({
188-
"@angular/cdk-experimental/%s" % p: "ng.cdkExperimental.%s" % p
189-
for p in CDK_EXPERIMENTAL_PACKAGES
190-
})
191-
192-
# Rollup globals for material subpackages, e.g., {"@angular/material/list": "ng.material.list"}
193-
ROLLUP_GLOBALS.update({
194-
"@angular/material/%s" % p: "ng.material.%s" % p
195-
for p in MATERIAL_PACKAGES
196-
})
197-
198-
# Rollup globals for material experimental subpackages, e.g.,
199-
# {"@angular/material-experimental/list": "ng.materialExperimental.list"}
200-
ROLLUP_GLOBALS.update({
201-
"@angular/material-experimental/%s" % p: "ng.materialExperimental.%s" % p
202-
for p in MATERIAL_EXPERIMENTAL_PACKAGES
203-
})
204-
205-
# Rollup globals the examples package. Since individual examples are
206-
# grouped by package and component, the primary entry-point imports
207-
# from entry-points which should be treated as external imports.
208-
ROLLUP_GLOBALS.update({
209-
"@angular/material-examples/cdk/%s" % p: "ng.materialExamples.cdk.%s" % p
210-
for p in CDK_PACKAGES
211-
})
212-
ROLLUP_GLOBALS.update({
213-
"@angular/material-examples/cdk-experimental/%s" % p: "ng.materialExamples.cdkExperimental.%s" % p
214-
for p in CDK_EXPERIMENTAL_PACKAGES
215-
})
216-
ROLLUP_GLOBALS.update({
217-
"@angular/material-examples/material/%s" % p: "ng.materialExamples.material.%s" % p
218-
for p in MATERIAL_PACKAGES
219-
})
220-
ROLLUP_GLOBALS.update({
221-
"@angular/material-examples/material-experimental/%s" % p: "ng.materialExamples.materialExperimental.%s" % p
222-
for p in MATERIAL_EXPERIMENTAL_PACKAGES
223-
})
224-
22511
# UMD bundles for Angular packages and subpackages we depend on for development and testing.
22612
ANGULAR_LIBRARY_UMDS = [
22713
"@npm//:node_modules/@angular/animations/bundles/animations-browser.umd.js",

‎rollup-globals.bzl‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
load("//src/cdk:config.bzl", "CDK_ENTRYPOINTS")
2+
load("//src/cdk-experimental:config.bzl", "CDK_EXPERIMENTAL_ENTRYPOINTS")
3+
load("//src/material:config.bzl", "MATERIAL_ENTRYPOINTS")
4+
load("//src/material-experimental:config.bzl", "MATERIAL_EXPERIMENTAL_ENTRYPOINTS")
5+
6+
# Base rollup globals for everything in the repo.
7+
ROLLUP_GLOBALS = {
8+
"@angular/cdk": "ng.cdk",
9+
"@angular/cdk-experimental": "ng.cdkExperimental",
10+
"@angular/google-maps": "ng.googleMaps",
11+
"@angular/material": "ng.material",
12+
"@angular/material-experimental": "ng.materialExperimental",
13+
"@angular/youtube-player": "ng.youtubePlayer",
14+
15+
# MDC Web
16+
"@material/animation": "mdc.animation",
17+
"@material/auto-init": "mdc.autoInit",
18+
"@material/base": "mdc.base",
19+
"@material/checkbox": "mdc.checkbox",
20+
"@material/chips": "mdc.chips",
21+
"@material/dialog": "mdc.dialog",
22+
"@material/dom": "mdc.dom",
23+
"@material/drawer": "mdc.drawer",
24+
"@material/floating-label": "mdc.floatingLabel",
25+
"@material/form-field": "mdc.formField",
26+
"@material/grid-list": "mdc.gridList",
27+
"@material/icon-button": "mdc.iconButton",
28+
"@material/line-ripple": "mdc.lineRipple",
29+
"@material/linear-progress": "mdc.linearProgress",
30+
"@material/list": "mdc.list",
31+
"@material/menu": "mdc.menu",
32+
"@material/menu-surface": "mdc.menuSurface",
33+
"@material/notched-outline": "mdc.notchedOutline",
34+
"@material/radio": "mdc.radio",
35+
"@material/ripple": "mdc.ripple",
36+
"@material/select": "mdc.select",
37+
"@material/slider": "mdc.slider",
38+
"@material/snackbar": "mdc.snackbar",
39+
"@material/switch": "mdc.switch",
40+
"@material/tab": "mdc.tab",
41+
"@material/tab-bar": "mdc.tabBar",
42+
"@material/tab-indicator": "mdc.tabIndicator",
43+
"@material/tab-scroller": "mdc.tabScroller",
44+
"@material/text-field": "mdc.textField",
45+
"@material/top-app-bar": "mdc.topAppBar",
46+
"moment": "moment",
47+
"tslib": "tslib",
48+
}
49+
50+
# Converts a string from dash-case to lower camel case.
51+
def to_camel_case(input):
52+
segments = input.split("-")
53+
return segments[0] + "".join([x.title() for x in segments[1:]])
54+
55+
# Converts an entry-point name to a UMD module name.
56+
# e.g. "snack-bar/testing" will become "snackBar.testing".
57+
def to_umd_name(name):
58+
segments = name.split("/")
59+
return ".".join([to_camel_case(x) for x in segments])
60+
61+
# Creates globals for a given package and its entry-points.
62+
def create_globals(packageName, entryPoints):
63+
ROLLUP_GLOBALS.update({
64+
"@angular/%s/%s" % (packageName, ep): "ng.%s.%s" % (to_umd_name(packageName), to_umd_name(ep))
65+
for ep in entryPoints
66+
})
67+
68+
create_globals("cdk", CDK_ENTRYPOINTS)
69+
create_globals("cdk-experimental", CDK_EXPERIMENTAL_ENTRYPOINTS)
70+
create_globals("material", MATERIAL_ENTRYPOINTS)
71+
create_globals("material-experimental", MATERIAL_EXPERIMENTAL_ENTRYPOINTS)
72+
73+
# Rollup globals the examples package. Since individual examples are
74+
# grouped by package and component, the primary entry-point imports
75+
# from entry-points which should be treated as external imports.
76+
create_globals("material-examples/cdk", CDK_ENTRYPOINTS)
77+
create_globals("material-examples/cdk-experimental", CDK_EXPERIMENTAL_ENTRYPOINTS)
78+
create_globals("material-examples/material", MATERIAL_ENTRYPOINTS)
79+
create_globals("material-examples/material-experimental", MATERIAL_EXPERIMENTAL_ENTRYPOINTS)

‎src/BUILD.bazel‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
package(default_visibility = ["//visibility:public"])
22

33
load("@npm_bazel_typescript//:index.bzl", "ts_config")
4-
load("//:packages.bzl", "CDK_PACKAGES", "MATERIAL_PACKAGES")
4+
load("//src/cdk:config.bzl", "CDK_ENTRYPOINTS")
5+
load("//src/material:config.bzl", "MATERIAL_NO_TEST_ENTRYPOINTS")
56
load("//tools:defaults.bzl", "ts_library")
67
load("//tools/dgeni:index.bzl", "dgeni_api_docs")
78

89
# List that contains all source files that need to be processed by Dgeni.
9-
apiSourceFiles = ["//src/cdk/%s:source-files" % name for name in CDK_PACKAGES] + [
10+
apiSourceFiles = ["//src/cdk/%s:source-files" % name for name in CDK_ENTRYPOINTS] + [
1011
"//src/material/%s:source-files" % name
11-
for name in MATERIAL_PACKAGES
12+
for name in MATERIAL_NO_TEST_ENTRYPOINTS
1213
]
1314

1415
exports_files([
@@ -41,8 +42,8 @@ dgeni_api_docs(
4142
"@npm//@angular/platform-browser",
4243
],
4344
entry_points = {
44-
"cdk": CDK_PACKAGES,
45-
"material": MATERIAL_PACKAGES,
45+
"cdk": CDK_ENTRYPOINTS,
46+
"material": MATERIAL_NO_TEST_ENTRYPOINTS,
4647
},
4748
tags = ["docs-package"],
4849
)

‎src/a11y-demo/BUILD.bazel‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
package(default_visibility = ["//visibility:public"])
22

3-
load("//:packages.bzl", "CDK_TARGETS", "MATERIAL_TARGETS")
3+
load("//src/cdk:config.bzl", "CDK_TARGETS")
4+
load("//src/material:config.bzl", "MATERIAL_NO_TEST_TARGETS")
45
load("//tools:defaults.bzl", "ng_module")
56
load("//tools:sass_generate_binaries.bzl", "sass_generate_binaries")
67

@@ -21,5 +22,5 @@ ng_module(
2122
"@npm//@angular/animations",
2223
"@npm//@angular/forms",
2324
"@npm//@angular/router",
24-
] + CDK_TARGETS + MATERIAL_TARGETS,
25+
] + CDK_TARGETS + MATERIAL_NO_TEST_TARGETS,
2526
)

‎src/cdk-experimental/BUILD.bazel‎

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,22 @@
11
package(default_visibility = ["//visibility:public"])
22

3-
load(
4-
"//:packages.bzl",
5-
"CDK_EXPERIMENTAL_PACKAGES",
6-
"CDK_EXPERIMENTAL_TARGETS",
7-
"ROLLUP_GLOBALS",
8-
)
9-
load("//tools:defaults.bzl", "ng_module", "ng_package")
3+
load("//src/cdk-experimental:config.bzl", "CDK_EXPERIMENTAL_TARGETS")
4+
load("//tools:defaults.bzl", "ng_package", "ts_library")
105

11-
ng_module(
6+
ts_library(
127
name = "cdk-experimental",
138
srcs = glob(
149
["*.ts"],
1510
exclude = ["**/*.spec.ts"],
1611
),
1712
module_name = "@angular/cdk-experimental",
18-
deps = ["//src/cdk-experimental/%s" % p for p in CDK_EXPERIMENTAL_PACKAGES],
13+
deps = ["@npm//@angular/core"],
1914
)
2015

2116
ng_package(
2217
name = "npm_package",
2318
srcs = ["package.json"],
2419
entry_point = ":public-api.ts",
25-
globals = ROLLUP_GLOBALS,
2620
tags = ["release-package"],
2721
deps = CDK_EXPERIMENTAL_TARGETS,
2822
)

‎src/cdk-experimental/config.bzl‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
entryPointGroups = [
2+
["clipboard"],
3+
["dialog"],
4+
["popover-edit"],
5+
["scrolling"],
6+
]
7+
8+
# List of all entry-points of the Angular cdk-experimental package.
9+
CDK_EXPERIMENTAL_ENTRYPOINTS = [ep for group in entryPointGroups for ep in group]
10+
11+
# List of all entry-point targets of the Angular cdk-experimental package.
12+
CDK_EXPERIMENTAL_TARGETS = ["//src/cdk-experimental"] + \
13+
["//src/cdk-experimental/%s" % ep for ep in CDK_EXPERIMENTAL_ENTRYPOINTS]

0 commit comments

Comments
 (0)