Skip to content

Commit 4e689ff

Browse files
josephperrottdevversion
josephperrott
and
devversion
authored
refactor(cdk/schematics): change usages of whitelist in selector interfaces to fileTypeFilter (#20619)
* refactor(cdk/schematics): change usages of whitelist in selector interfaces to fileTypeFilter Migrate usages of whitelist in each of the ng-update selector interfaces to be fileTypeFilter instead. * fixup! refactor(cdk/schematics): change usages of whitelist in selector interfaces to fileTypeFilter * fixup! refactor(cdk/schematics): change usages of whitelist in selector interfaces to fileTypeFilter Co-authored-by: Paul Gschwendtner <[email protected]> Co-authored-by: Paul Gschwendtner <[email protected]>
1 parent a90a072 commit 4e689ff

File tree

14 files changed

+110
-104
lines changed

14 files changed

+110
-104
lines changed

‎src/cdk/schematics/ng-update/data/css-selectors.ts‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,17 @@ export interface CssSelectorUpgradeData {
1414
replace: string;
1515
/** The new CSS selector. */
1616
replaceWith: string;
17-
/** Whitelist where this replacement is made. If omitted it is made in all files. */
18-
whitelist?: {
17+
/**
18+
* Controls which file types in which this replacement is made. If omitted, it is made in all
19+
* files.
20+
*/
21+
replaceIn?: {
1922
/** Replace this name in stylesheet files. */
2023
stylesheet?: boolean,
2124
/** Replace this name in HTML files. */
2225
html?: boolean,
2326
/** Replace this name in TypeScript strings. */
24-
strings?: boolean
27+
tsStringLiterals?: boolean
2528
};
2629
}
2730

‎src/cdk/schematics/ng-update/data/input-names.ts‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ export interface InputNameUpgradeData {
1414
replace: string;
1515
/** The new name for the @Input(). */
1616
replaceWith: string;
17-
/** Whitelist where this replacement is made. If omitted it is made in all HTML & CSS */
18-
whitelist: {
17+
/** Controls which elements and attributes in which this replacement is made. */
18+
limitedTo: {
1919
/** Limit to elements with any of these element tags. */
2020
elements?: string[],
2121
/** Limit to elements with any of these attributes. */
@@ -31,73 +31,73 @@ export const inputNames: VersionChanges<InputNameUpgradeData> = {
3131
{
3232
replace: 'origin',
3333
replaceWith: 'cdkConnectedOverlayOrigin',
34-
whitelist:
34+
limitedTo:
3535
{attributes: ['cdk-connected-overlay', 'connected-overlay', 'cdkConnectedOverlay']}
3636
},
3737
{
3838
replace: 'positions',
3939
replaceWith: 'cdkConnectedOverlayPositions',
40-
whitelist:
40+
limitedTo:
4141
{attributes: ['cdk-connected-overlay', 'connected-overlay', 'cdkConnectedOverlay']}
4242
},
4343
{
4444
replace: 'offsetX',
4545
replaceWith: 'cdkConnectedOverlayOffsetX',
46-
whitelist:
46+
limitedTo:
4747
{attributes: ['cdk-connected-overlay', 'connected-overlay', 'cdkConnectedOverlay']}
4848
},
4949
{
5050
replace: 'offsetY',
5151
replaceWith: 'cdkConnectedOverlayOffsetY',
52-
whitelist:
52+
limitedTo:
5353
{attributes: ['cdk-connected-overlay', 'connected-overlay', 'cdkConnectedOverlay']}
5454
},
5555
{
5656
replace: 'width',
5757
replaceWith: 'cdkConnectedOverlayWidth',
58-
whitelist:
58+
limitedTo:
5959
{attributes: ['cdk-connected-overlay', 'connected-overlay', 'cdkConnectedOverlay']}
6060
},
6161
{
6262
replace: 'height',
6363
replaceWith: 'cdkConnectedOverlayHeight',
64-
whitelist:
64+
limitedTo:
6565
{attributes: ['cdk-connected-overlay', 'connected-overlay', 'cdkConnectedOverlay']}
6666
},
6767
{
6868
replace: 'minWidth',
6969
replaceWith: 'cdkConnectedOverlayMinWidth',
70-
whitelist:
70+
limitedTo:
7171
{attributes: ['cdk-connected-overlay', 'connected-overlay', 'cdkConnectedOverlay']}
7272
},
7373
{
7474
replace: 'minHeight',
7575
replaceWith: 'cdkConnectedOverlayMinHeight',
76-
whitelist:
76+
limitedTo:
7777
{attributes: ['cdk-connected-overlay', 'connected-overlay', 'cdkConnectedOverlay']}
7878
},
7979
{
8080
replace: 'backdropClass',
8181
replaceWith: 'cdkConnectedOverlayBackdropClass',
82-
whitelist:
82+
limitedTo:
8383
{attributes: ['cdk-connected-overlay', 'connected-overlay', 'cdkConnectedOverlay']}
8484
},
8585
{
8686
replace: 'scrollStrategy',
8787
replaceWith: 'cdkConnectedOverlayScrollStrategy',
88-
whitelist:
88+
limitedTo:
8989
{attributes: ['cdk-connected-overlay', 'connected-overlay', 'cdkConnectedOverlay']}
9090
},
9191
{
9292
replace: 'open',
9393
replaceWith: 'cdkConnectedOverlayOpen',
94-
whitelist:
94+
limitedTo:
9595
{attributes: ['cdk-connected-overlay', 'connected-overlay', 'cdkConnectedOverlay']}
9696
},
9797
{
9898
replace: 'hasBackdrop',
9999
replaceWith: 'cdkConnectedOverlayHasBackdrop',
100-
whitelist:
100+
limitedTo:
101101
{attributes: ['cdk-connected-overlay', 'connected-overlay', 'cdkConnectedOverlay']}
102102
}
103103
]

‎src/cdk/schematics/ng-update/data/output-names.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ export interface OutputNameUpgradeData {
1414
replace: string;
1515
/** The new name for the @Output(). */
1616
replaceWith: string;
17-
/** Whitelist where this replacement is made. If omitted it is made in all HTML & CSS */
18-
whitelist: {
17+
/** Controls which elements and attributes in which this replacement is made. */
18+
limitedTo: {
1919
/** Limit to elements with any of these element tags. */
2020
elements?: string[],
2121
/** Limit to elements with any of these attributes. */
@@ -30,7 +30,7 @@ export const outputNames: VersionChanges<OutputNameUpgradeData> = {
3030
changes: [{
3131
replace: 'copied',
3232
replaceWith: 'cdkCopyToClipboardCopied',
33-
whitelist: {
33+
limitedTo: {
3434
attributes: ['cdkCopyToClipboard']
3535
}
3636
}]

‎src/cdk/schematics/ng-update/data/property-names.ts‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ export interface PropertyNameUpgradeData {
1414
replace: string;
1515
/** The new name for the property. */
1616
replaceWith: string;
17-
/** Whitelist where this replacement is made. If omitted it is made for all Classes. */
18-
whitelist: {
17+
/** Controls which classes in which this replacement is made. */
18+
limitedTo: {
1919
/** Replace the property only when its type is one of the given Classes. */
2020
classes: string[];
2121
};
@@ -28,15 +28,15 @@ export const propertyNames: VersionChanges<PropertyNameUpgradeData> = {
2828
changes: [{
2929
replace: 'boundaryElementSelector',
3030
replaceWith: 'boundaryElement',
31-
whitelist: {classes: ['CdkDrag']}
31+
limitedTo: {classes: ['CdkDrag']}
3232
}]
3333
},
3434
{
3535
pr: 'https://github.com/angular/components/pull/17302',
3636
changes: [{
3737
replace: 'onChange',
3838
replaceWith: 'changed',
39-
whitelist: {classes: ['SelectionModel']}
39+
limitedTo: {classes: ['SelectionModel']}
4040
}]
4141
}
4242
],
@@ -45,15 +45,15 @@ export const propertyNames: VersionChanges<PropertyNameUpgradeData> = {
4545
{
4646
pr: 'https://github.com/angular/components/pull/8286',
4747
changes:
48-
[{replace: 'onChange', replaceWith: 'changed', whitelist: {classes: ['SelectionModel']}}]
48+
[{replace: 'onChange', replaceWith: 'changed', limitedTo: {classes: ['SelectionModel']}}]
4949
},
5050

5151
{
5252
pr: 'https://github.com/angular/components/pull/12927',
5353
changes: [{
5454
replace: 'flexibleDiemsions',
5555
replaceWith: 'flexibleDimensions',
56-
whitelist: {classes: ['CdkConnectedOverlay']}
56+
limitedTo: {classes: ['CdkConnectedOverlay']}
5757
}]
5858
}
5959
],
@@ -65,62 +65,62 @@ export const propertyNames: VersionChanges<PropertyNameUpgradeData> = {
6565
{
6666
replace: '_deprecatedOrigin',
6767
replaceWith: 'origin',
68-
whitelist: {classes: ['CdkConnectedOverlay', 'ConnectedOverlayDirective']}
68+
limitedTo: {classes: ['CdkConnectedOverlay', 'ConnectedOverlayDirective']}
6969
},
7070
{
7171
replace: '_deprecatedPositions',
7272
replaceWith: 'positions',
73-
whitelist: {classes: ['CdkConnectedOverlay', 'ConnectedOverlayDirective']}
73+
limitedTo: {classes: ['CdkConnectedOverlay', 'ConnectedOverlayDirective']}
7474
},
7575
{
7676
replace: '_deprecatedOffsetX',
7777
replaceWith: 'offsetX',
78-
whitelist: {classes: ['CdkConnectedOverlay', 'ConnectedOverlayDirective']}
78+
limitedTo: {classes: ['CdkConnectedOverlay', 'ConnectedOverlayDirective']}
7979
},
8080
{
8181
replace: '_deprecatedOffsetY',
8282
replaceWith: 'offsetY',
83-
whitelist: {classes: ['CdkConnectedOverlay', 'ConnectedOverlayDirective']}
83+
limitedTo: {classes: ['CdkConnectedOverlay', 'ConnectedOverlayDirective']}
8484
},
8585
{
8686
replace: '_deprecatedWidth',
8787
replaceWith: 'width',
88-
whitelist: {classes: ['CdkConnectedOverlay', 'ConnectedOverlayDirective']}
88+
limitedTo: {classes: ['CdkConnectedOverlay', 'ConnectedOverlayDirective']}
8989
},
9090
{
9191
replace: '_deprecatedHeight',
9292
replaceWith: 'height',
93-
whitelist: {classes: ['CdkConnectedOverlay', 'ConnectedOverlayDirective']}
93+
limitedTo: {classes: ['CdkConnectedOverlay', 'ConnectedOverlayDirective']}
9494
},
9595
{
9696
replace: '_deprecatedMinWidth',
9797
replaceWith: 'minWidth',
98-
whitelist: {classes: ['CdkConnectedOverlay', 'ConnectedOverlayDirective']}
98+
limitedTo: {classes: ['CdkConnectedOverlay', 'ConnectedOverlayDirective']}
9999
},
100100
{
101101
replace: '_deprecatedMinHeight',
102102
replaceWith: 'minHeight',
103-
whitelist: {classes: ['CdkConnectedOverlay', 'ConnectedOverlayDirective']}
103+
limitedTo: {classes: ['CdkConnectedOverlay', 'ConnectedOverlayDirective']}
104104
},
105105
{
106106
replace: '_deprecatedBackdropClass',
107107
replaceWith: 'backdropClass',
108-
whitelist: {classes: ['CdkConnectedOverlay', 'ConnectedOverlayDirective']}
108+
limitedTo: {classes: ['CdkConnectedOverlay', 'ConnectedOverlayDirective']}
109109
},
110110
{
111111
replace: '_deprecatedScrollStrategy',
112112
replaceWith: 'scrollStrategy',
113-
whitelist: {classes: ['CdkConnectedOverlay', 'ConnectedOverlayDirective']}
113+
limitedTo: {classes: ['CdkConnectedOverlay', 'ConnectedOverlayDirective']}
114114
},
115115
{
116116
replace: '_deprecatedOpen',
117117
replaceWith: 'open',
118-
whitelist: {classes: ['CdkConnectedOverlay', 'ConnectedOverlayDirective']}
118+
limitedTo: {classes: ['CdkConnectedOverlay', 'ConnectedOverlayDirective']}
119119
},
120120
{
121121
replace: '_deprecatedHasBackdrop',
122122
replaceWith: 'hasBackdrop',
123-
whitelist: {classes: ['CdkConnectedOverlay', 'ConnectedOverlayDirective']}
123+
limitedTo: {classes: ['CdkConnectedOverlay', 'ConnectedOverlayDirective']}
124124
}
125125
]
126126
},
@@ -131,12 +131,12 @@ export const propertyNames: VersionChanges<PropertyNameUpgradeData> = {
131131
{
132132
replace: '_deprecatedPortal',
133133
replaceWith: 'portal',
134-
whitelist: {classes: ['CdkPortalOutlet']}
134+
limitedTo: {classes: ['CdkPortalOutlet']}
135135
},
136136
{
137137
replace: '_deprecatedPortalHost',
138138
replaceWith: 'portal',
139-
whitelist: {classes: ['CdkPortalOutlet']}
139+
limitedTo: {classes: ['CdkPortalOutlet']}
140140
}
141141
]
142142
},

‎src/cdk/schematics/ng-update/migrations/class-inheritance.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ export class ClassInheritanceMigration extends Migration<UpgradeData> {
2828

2929
init(): void {
3030
getVersionUpgradeData(this, 'propertyNames')
31-
.filter(data => data.whitelist && data.whitelist.classes)
31+
.filter(data => data.limitedTo && data.limitedTo.classes)
3232
.forEach(
33-
data => data.whitelist.classes.forEach(name => this.propertyNames.set(name, data)));
33+
data => data.limitedTo.classes.forEach(name => this.propertyNames.set(name, data)));
3434
}
3535

3636
visitNode(node: ts.Node): void {

‎src/cdk/schematics/ng-update/migrations/css-selectors.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import {getVersionUpgradeData, UpgradeData} from '../upgrade-data';
2020
*/
2121
export class CssSelectorsMigration extends Migration<UpgradeData> {
2222
/** Change data that upgrades to the specified target version. */
23-
data = getVersionUpgradeData(this, 'cssSelectors');
23+
data: CssSelectorUpgradeData[] = getVersionUpgradeData(this, 'cssSelectors');
2424

2525
// Only enable the migration rule if there is upgrade data.
2626
enabled = this.data.length !== 0;
@@ -33,7 +33,7 @@ export class CssSelectorsMigration extends Migration<UpgradeData> {
3333

3434
visitTemplate(template: ResolvedResource): void {
3535
this.data.forEach(data => {
36-
if (data.whitelist && !data.whitelist.html) {
36+
if (data.replaceIn && !data.replaceIn.html) {
3737
return;
3838
}
3939

@@ -45,7 +45,7 @@ export class CssSelectorsMigration extends Migration<UpgradeData> {
4545

4646
visitStylesheet(stylesheet: ResolvedResource): void {
4747
this.data.forEach(data => {
48-
if (data.whitelist && !data.whitelist.stylesheet) {
48+
if (data.replaceIn && !data.replaceIn.stylesheet) {
4949
return;
5050
}
5151

@@ -64,7 +64,7 @@ export class CssSelectorsMigration extends Migration<UpgradeData> {
6464
const filePath = this.fileSystem.resolve(node.getSourceFile().fileName);
6565

6666
this.data.forEach(data => {
67-
if (data.whitelist && !data.whitelist.strings) {
67+
if (data.replaceIn && !data.replaceIn.tsStringLiterals) {
6868
return;
6969
}
7070

‎src/cdk/schematics/ng-update/migrations/input-names.ts‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,17 +44,17 @@ export class InputNamesMigration extends Migration<UpgradeData> {
4444

4545
visitTemplate(template: ResolvedResource): void {
4646
this.data.forEach(name => {
47-
const whitelist = name.whitelist;
47+
const limitedTo = name.limitedTo;
4848
const relativeOffsets: number[] = [];
4949

50-
if (whitelist.attributes) {
50+
if (limitedTo.attributes) {
5151
relativeOffsets.push(
52-
...findInputsOnElementWithAttr(template.content, name.replace, whitelist.attributes));
52+
...findInputsOnElementWithAttr(template.content, name.replace, limitedTo.attributes));
5353
}
5454

55-
if (whitelist.elements) {
55+
if (limitedTo.elements) {
5656
relativeOffsets.push(
57-
...findInputsOnElementWithTag(template.content, name.replace, whitelist.elements));
57+
...findInputsOnElementWithTag(template.content, name.replace, limitedTo.elements));
5858
}
5959

6060
relativeOffsets.map(offset => template.start + offset)

‎src/cdk/schematics/ng-update/migrations/output-names.ts‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,17 @@ export class OutputNamesMigration extends Migration<UpgradeData> {
3030

3131
visitTemplate(template: ResolvedResource): void {
3232
this.data.forEach(name => {
33-
const whitelist = name.whitelist;
33+
const limitedTo = name.limitedTo;
3434
const relativeOffsets: number[] = [];
3535

36-
if (whitelist.attributes) {
36+
if (limitedTo.attributes) {
3737
relativeOffsets.push(
38-
...findOutputsOnElementWithAttr(template.content, name.replace, whitelist.attributes));
38+
...findOutputsOnElementWithAttr(template.content, name.replace, limitedTo.attributes));
3939
}
4040

41-
if (whitelist.elements) {
41+
if (limitedTo.elements) {
4242
relativeOffsets.push(
43-
...findOutputsOnElementWithTag(template.content, name.replace, whitelist.elements));
43+
...findOutputsOnElementWithTag(template.content, name.replace, limitedTo.elements));
4444
}
4545

4646
relativeOffsets.map(offset => template.start + offset)

‎src/cdk/schematics/ng-update/migrations/property-names.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export class PropertyNamesMigration extends Migration<UpgradeData> {
3838
return;
3939
}
4040

41-
if (!data.whitelist || data.whitelist.classes.includes(typeName)) {
41+
if (!data.limitedTo || data.limitedTo.classes.includes(typeName)) {
4242
this.fileSystem.edit(this.fileSystem.resolve(node.getSourceFile().fileName))
4343
.remove(node.name.getStart(), node.name.getWidth())
4444
.insertRight(node.name.getStart(), data.replaceWith);

‎src/cdk/schematics/ng-update/update-schematic.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ export const propertyNames: VersionChanges<MaterialPropertyNameData> = {
132132
{
133133
replace: 'color',
134134
replaceWith: 'newColor',
135-
whitelist: {
135+
limitedTo: {
136136
classes: ['MatRipple']
137137
}
138138
}

0 commit comments

Comments
 (0)