Skip to content

Commit

Permalink
build: rename @deletion-target to @Breaking-Change (#12421)
Browse files Browse the repository at this point in the history
As discussed, renames the `@deletion-target` tag to `@breaking-change` to make the intentions of the tag clearer. Also adds an extra check to the tslint rule to catch any leftover `@deletion-target` tags.
  • Loading branch information
crisbeto authored and mmalerba committed Jul 29, 2018
1 parent 4e358c3 commit 877de56
Show file tree
Hide file tree
Showing 58 changed files with 128 additions and 115 deletions.
4 changes: 2 additions & 2 deletions src/cdk/a11y/aria-describer/aria-describer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -225,12 +225,12 @@ export class AriaDescriber implements OnDestroy {
}


/** @docs-private @deprecated @deletion-target 7.0.0 */
/** @docs-private @deprecated @breaking-change 7.0.0 */
export function ARIA_DESCRIBER_PROVIDER_FACTORY(parentDispatcher: AriaDescriber, _document: any) {
return parentDispatcher || new AriaDescriber(_document);
}

/** @docs-private @deprecated @deletion-target 7.0.0 */
/** @docs-private @deprecated @breaking-change 7.0.0 */
export const ARIA_DESCRIBER_PROVIDER = {
// If there is already an AriaDescriber available, use that. Otherwise, provide a new one.
provide: AriaDescriber,
Expand Down
4 changes: 2 additions & 2 deletions src/cdk/a11y/focus-monitor/focus-monitor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -402,13 +402,13 @@ export class CdkMonitorFocus implements OnDestroy {
}
}

/** @docs-private @deprecated @deletion-target 7.0.0 */
/** @docs-private @deprecated @breaking-change 7.0.0 */
export function FOCUS_MONITOR_PROVIDER_FACTORY(
parentDispatcher: FocusMonitor, ngZone: NgZone, platform: Platform) {
return parentDispatcher || new FocusMonitor(ngZone, platform);
}

/** @docs-private @deprecated @deletion-target 7.0.0 */
/** @docs-private @deprecated @breaking-change 7.0.0 */
export const FOCUS_MONITOR_PROVIDER = {
// If there is already a FocusMonitor available, use that. Otherwise, provide a new one.
provide: FocusMonitor,
Expand Down
4 changes: 2 additions & 2 deletions src/cdk/a11y/focus-trap/focus-trap.ts
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ export class FocusTrap {
`[cdk-focus-${bound}]`) as NodeListOf<HTMLElement>;

for (let i = 0; i < markers.length; i++) {
// @deletion-target 7.0.0
// @breaking-change 7.0.0
if (markers[i].hasAttribute(`cdk-focus-${bound}`)) {
console.warn(`Found use of deprecated attribute 'cdk-focus-${bound}', ` +
`use 'cdkFocusRegion${bound}' instead. The deprecated ` +
Expand Down Expand Up @@ -181,7 +181,7 @@ export class FocusTrap {
`[cdkFocusInitial]`) as HTMLElement;

if (redirectToElement) {
// @deletion-target 7.0.0
// @breaking-change 7.0.0
if (redirectToElement.hasAttribute(`cdk-focus-initial`)) {
console.warn(`Found use of deprecated attribute 'cdk-focus-initial', ` +
`use 'cdkFocusInitial' instead. The deprecated attribute ` +
Expand Down
2 changes: 1 addition & 1 deletion src/cdk/a11y/key-manager/list-key-manager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ export class ListKeyManager<T extends ListKeyManagerOption> {
* Allows setting of the activeItemIndex without any other effects.
* @param index The new activeItemIndex.
* @deprecated Use `updateActiveItem` instead.
* @deletion-target 7.0.0
* @breaking-change 7.0.0
*/
updateActiveItemIndex(index: number): void {
this.updateActiveItem(index);
Expand Down
4 changes: 2 additions & 2 deletions src/cdk/a11y/live-announcer/live-announcer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -132,14 +132,14 @@ export class CdkAriaLive implements OnDestroy {
}


/** @docs-private @deprecated @deletion-target 7.0.0 */
/** @docs-private @deprecated @breaking-change 7.0.0 */
export function LIVE_ANNOUNCER_PROVIDER_FACTORY(
parentDispatcher: LiveAnnouncer, liveElement: any, _document: any) {
return parentDispatcher || new LiveAnnouncer(liveElement, _document);
}


/** @docs-private @deprecated @deletion-target 7.0.0 */
/** @docs-private @deprecated @breaking-change 7.0.0 */
export const LIVE_ANNOUNCER_PROVIDER: Provider = {
// If there is already a LiveAnnouncer available, use that. Otherwise, provide a new one.
provide: LiveAnnouncer,
Expand Down
4 changes: 2 additions & 2 deletions src/cdk/overlay/keyboard/overlay-keyboard-dispatcher.ts
Original file line number Diff line number Diff line change
Expand Up @@ -96,13 +96,13 @@ export class OverlayKeyboardDispatcher implements OnDestroy {
}


/** @docs-private @deprecated @deletion-target 7.0.0 */
/** @docs-private @deprecated @breaking-change 7.0.0 */
export function OVERLAY_KEYBOARD_DISPATCHER_PROVIDER_FACTORY(
dispatcher: OverlayKeyboardDispatcher, _document: any) {
return dispatcher || new OverlayKeyboardDispatcher(_document);
}

/** @docs-private @deprecated @deletion-target 7.0.0 */
/** @docs-private @deprecated @breaking-change 7.0.0 */
export const OVERLAY_KEYBOARD_DISPATCHER_PROVIDER = {
// If there is already an OverlayKeyboardDispatcher available, use that.
// Otherwise, provide a new one.
Expand Down
4 changes: 2 additions & 2 deletions src/cdk/overlay/overlay-container.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,13 @@ export class OverlayContainer implements OnDestroy {
}


/** @docs-private @deprecated @deletion-target 7.0.0 */
/** @docs-private @deprecated @breaking-change 7.0.0 */
export function OVERLAY_CONTAINER_PROVIDER_FACTORY(parentContainer: OverlayContainer,
_document: any) {
return parentContainer || new OverlayContainer(_document);
}

/** @docs-private @deprecated @deletion-target 7.0.0 */
/** @docs-private @deprecated @breaking-change 7.0.0 */
export const OVERLAY_CONTAINER_PROVIDER = {
// If there is already an OverlayContainer available, use that. Otherwise, provide a new one.
provide: OverlayContainer,
Expand Down
2 changes: 1 addition & 1 deletion src/cdk/overlay/overlay-directives.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ const defaultPositionList: ConnectedPosition[] = [
export const CDK_CONNECTED_OVERLAY_SCROLL_STRATEGY =
new InjectionToken<() => ScrollStrategy>('cdk-connected-overlay-scroll-strategy');

/** @docs-private @deprecated @deletion-target 7.0.0 */
/** @docs-private @deprecated @breaking-change 7.0.0 */
export function CDK_CONNECTED_OVERLAY_SCROLL_STRATEGY_FACTORY(overlay: Overlay):
() => ScrollStrategy {
return (config?: RepositionScrollStrategyConfig) => overlay.scrollStrategies.reposition(config);
Expand Down
2 changes: 1 addition & 1 deletion src/cdk/overlay/overlay-module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export class OverlayModule {}

/**
* @deprecated Use `OverlayModule` instead.
* @deletion-target 7.0.0
* @breaking-change 7.0.0
*/
export const OVERLAY_PROVIDERS: Provider[] = [
Overlay,
Expand Down
4 changes: 2 additions & 2 deletions src/cdk/overlay/position/connected-position-strategy.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import {OverlayReference} from '../overlay-reference';
* a basic dropdown is connecting the bottom-left corner of the origin to the top-left corner
* of the overlay.
* @deprecated Use `FlexibleConnectedPositionStrategy` instead.
* @deletion-target 7.0.0
* @breaking-change 7.0.0
*/
export class ConnectedPositionStrategy implements PositionStrategy {
/**
Expand Down Expand Up @@ -61,7 +61,7 @@ export class ConnectedPositionStrategy implements PositionStrategy {
connectedTo: ElementRef,
viewportRuler: ViewportRuler,
document: Document,
// @deletion-target 7.0.0 `platform` parameter to be made required.
// @breaking-change 7.0.0 `platform` parameter to be made required.
platform?: Platform) {

// Since the `ConnectedPositionStrategy` is deprecated and we don't want to maintain
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ export class FlexibleConnectedPositionStrategy implements PositionStrategy {
connectedTo: ElementRef | HTMLElement,
private _viewportRuler: ViewportRuler,
private _document: Document,
// @deletion-target 7.0.0 `_platform` and `_overlayContainer` parameters to be made required.
// @breaking-change 7.0.0 `_platform` and `_overlayContainer` parameters to be made required.
private _platform?: Platform,
private _overlayContainer?: OverlayContainer) {
this.setOrigin(connectedTo);
Expand Down Expand Up @@ -171,7 +171,7 @@ export class FlexibleConnectedPositionStrategy implements PositionStrategy {
*/
apply(): void {
// We shouldn't do anything if the strategy was disposed or we're on the server.
// @deletion-target 7.0.0 Remove `_platform` null check once it's guaranteed to be defined.
// @breaking-change 7.0.0 Remove `_platform` null check once it's guaranteed to be defined.
if (this._isDisposed || (this._platform && !this._platform.isBrowser)) {
return;
}
Expand Down Expand Up @@ -842,7 +842,7 @@ export class FlexibleConnectedPositionStrategy implements PositionStrategy {
overlayPoint = this._pushOverlayOnScreen(overlayPoint, this._overlayRect);
}

// @deletion-target 7.0.0 Currently the `_overlayContainer` is optional in order to avoid a
// @breaking-change 7.0.0 Currently the `_overlayContainer` is optional in order to avoid a
// breaking change. The null check here can be removed once the `_overlayContainer` becomes
// a required parameter.
let virtualKeyboardOffset = this._overlayContainer ?
Expand Down
4 changes: 2 additions & 2 deletions src/cdk/overlay/position/global-position-strategy.ts
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ export class GlobalPositionStrategy implements PositionStrategy {
* Sets the overlay width and clears any previously set width.
* @param value New width for the overlay
* @deprecated Pass the `width` through the `OverlayConfig`.
* @deletion-target 7.0.0
* @breaking-change 7.0.0
*/
width(value: string = ''): this {
if (this._overlayRef) {
Expand All @@ -109,7 +109,7 @@ export class GlobalPositionStrategy implements PositionStrategy {
* Sets the overlay height and clears any previously set height.
* @param value New height for the overlay
* @deprecated Pass the `height` through the `OverlayConfig`.
* @deletion-target 7.0.0
* @breaking-change 7.0.0
*/
height(value: string = ''): this {
if (this._overlayRef) {
Expand Down
4 changes: 2 additions & 2 deletions src/cdk/overlay/position/overlay-position-builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export class OverlayPositionBuilder {
constructor(
private _viewportRuler: ViewportRuler,
@Inject(DOCUMENT) private _document: any,
// @deletion-target 7.0.0 `_platform` and `_overlayContainer` parameters to be made required.
// @breaking-change 7.0.0 `_platform` and `_overlayContainer` parameters to be made required.
@Optional() private _platform?: Platform,
@Optional() private _overlayContainer?: OverlayContainer) { }

Expand All @@ -40,7 +40,7 @@ export class OverlayPositionBuilder {
* @param originPos
* @param overlayPos
* @deprecated Use `flexibleConnectedTo` instead.
* @deletion-target 7.0.0
* @breaking-change 7.0.0
*/
connectedTo(
elementRef: ElementRef,
Expand Down
2 changes: 1 addition & 1 deletion src/cdk/platform/platform.ts
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ export class Platform {
SAFARI: boolean = this.isBrowser && /safari/i.test(navigator.userAgent) && this.WEBKIT;

/**
* @deletion-target v7.0.0 remove optional decorator
* @breaking-change v7.0.0 remove optional decorator
*/
constructor(@Optional() @Inject(PLATFORM_ID) private _platformId?: Object) {
}
Expand Down
4 changes: 2 additions & 2 deletions src/cdk/scrolling/scroll-dispatcher.ts
Original file line number Diff line number Diff line change
Expand Up @@ -170,13 +170,13 @@ export class ScrollDispatcher implements OnDestroy {
}


/** @docs-private @deprecated @deletion-target 7.0.0 */
/** @docs-private @deprecated @breaking-change 7.0.0 */
export function SCROLL_DISPATCHER_PROVIDER_FACTORY(
parentDispatcher: ScrollDispatcher, ngZone: NgZone, platform: Platform) {
return parentDispatcher || new ScrollDispatcher(ngZone, platform);
}

/** @docs-private @deprecated @deletion-target 7.0.0 */
/** @docs-private @deprecated @breaking-change 7.0.0 */
export const SCROLL_DISPATCHER_PROVIDER = {
// If there is already a ScrollDispatcher available, use that. Otherwise, provide a new one.
provide: ScrollDispatcher,
Expand Down
4 changes: 2 additions & 2 deletions src/cdk/scrolling/viewport-ruler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -123,14 +123,14 @@ export class ViewportRuler implements OnDestroy {
}


/** @docs-private @deprecated @deletion-target 7.0.0 */
/** @docs-private @deprecated @breaking-change 7.0.0 */
export function VIEWPORT_RULER_PROVIDER_FACTORY(parentRuler: ViewportRuler,
platform: Platform,
ngZone: NgZone) {
return parentRuler || new ViewportRuler(platform, ngZone);
}

/** @docs-private @deprecated @deletion-target 7.0.0 */
/** @docs-private @deprecated @breaking-change 7.0.0 */
export const VIEWPORT_RULER_PROVIDER = {
// If there is already a ViewportRuler available, use that. Otherwise, provide a new one.
provide: ViewportRuler,
Expand Down
2 changes: 1 addition & 1 deletion src/cdk/stepper/stepper.ts
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ export class CdkStepper implements AfterViewInit, OnDestroy {
/** The step that is selected. */
@Input()
get selected(): CdkStep {
// @deletion-target 7.0.0 Change return type to `CdkStep | undefined`.
// @breaking-change 7.0.0 Change return type to `CdkStep | undefined`.
return this._steps ? this._steps.toArray()[this.selectedIndex] : undefined!;
}
set selected(step: CdkStep) {
Expand Down
4 changes: 2 additions & 2 deletions src/cdk/table/table.ts
Original file line number Diff line number Diff line change
Expand Up @@ -478,7 +478,7 @@ export class CdkTable<T> implements AfterContentChecked, CollectionViewer, OnDes
* table's content is checked.
* @docs-private
* @deprecated Use `addHeaderRowDef` and `removeHeaderRowDef` instead
* @deletion-target 8.0.0
* @breaking-change 8.0.0
*/
setHeaderRowDef(headerRowDef: CdkHeaderRowDef) {
this._customHeaderRowDefs = new Set([headerRowDef]);
Expand All @@ -491,7 +491,7 @@ export class CdkTable<T> implements AfterContentChecked, CollectionViewer, OnDes
* table's content is checked.
* @docs-private
* @deprecated Use `addFooterRowDef` and `removeFooterRowDef` instead
* @deletion-target 8.0.0
* @breaking-change 8.0.0
*/
setFooterRowDef(footerRowDef: CdkFooterRowDef) {
this._customFooterRowDefs = new Set([footerRowDef]);
Expand Down
2 changes: 1 addition & 1 deletion src/lib/autocomplete/autocomplete-trigger.ts
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ export class MatAutocompleteTrigger implements ControlValueAccessor, OnDestroy {
@Optional() private _dir: Directionality,
@Optional() @Host() private _formField: MatFormField,
@Optional() @Inject(DOCUMENT) private _document: any,
// @deletion-target 7.0.0 Make `_viewportRuler` required.
// @breaking-change 7.0.0 Make `_viewportRuler` required.
private _viewportRuler?: ViewportRuler) {}

ngOnDestroy() {
Expand Down
2 changes: 1 addition & 1 deletion src/lib/button-toggle/button-toggle.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ export const MAT_BUTTON_TOGGLE_GROUP_VALUE_ACCESSOR: any = {

/**
* @deprecated Use `MatButtonToggleGroup` instead.
* @deletion-target 7.0.0
* @breaking-change 7.0.0
*/
export class MatButtonToggleGroupMultiple {}

Expand Down
6 changes: 3 additions & 3 deletions src/lib/button/button.ts
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,12 @@ export class MatButton extends _MatButtonMixinBase
constructor(elementRef: ElementRef,
/**
* @deprecated Platform checks for SSR are no longer needed
* @deletion-target 7.0.0
* @breaking-change 7.0.0
*/
// tslint:disable-next-line:no-unused-variable
private _platform: Platform,
private _focusMonitor: FocusMonitor,
// @deletion-target 7.0.0 `_animationMode` parameter to be made required.
// @breaking-change 7.0.0 `_animationMode` parameter to be made required.
@Optional() @Inject(ANIMATION_MODULE_TYPE) public _animationMode?: string) {
super(elementRef);

Expand Down Expand Up @@ -173,7 +173,7 @@ export class MatAnchor extends MatButton {
platform: Platform,
focusMonitor: FocusMonitor,
elementRef: ElementRef,
// @deletion-target 7.0.0 `animationMode` parameter to be made required.
// @breaking-change 7.0.0 `animationMode` parameter to be made required.
@Optional() @Inject(ANIMATION_MODULE_TYPE) animationMode?: string) {
super(elementRef, platform, focusMonitor, animationMode);
}
Expand Down
2 changes: 1 addition & 1 deletion src/lib/chips/chip-input.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ export class MatChipInput {
/**
* The input's placeholder text.
* @deprecated Bind to the `placeholder` attribute directly.
* @deletion-target 7.0.0
* @breaking-change 7.0.0
*/
@Input() placeholder: string = '';

Expand Down
2 changes: 1 addition & 1 deletion src/lib/core/datetime/date-adapter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export function MAT_DATE_LOCALE_FACTORY(): string {
* No longer needed since MAT_DATE_LOCALE has been changed to a scoped injectable.
* If you are importing and providing this in your code you can simply remove it.
* @deprecated
* @deletion-target 7.0.0
* @breaking-change 7.0.0
*/
export const MAT_DATE_LOCALE_PROVIDER = {provide: MAT_DATE_LOCALE, useExisting: LOCALE_ID};

Expand Down
2 changes: 1 addition & 1 deletion src/lib/core/gestures/gesture-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ export class GestureConfig extends HammerGestureConfig {
// `this.events` to the set we support, instead of conditionally setting it to `[]` if
// `HAMMER_LOADER` is present (and then throwing an Error here if `window.Hammer` is
// undefined).
// @deletion-target 7.0.0
// @breaking-change 7.0.0
return noopHammerInstance;
}

Expand Down
2 changes: 1 addition & 1 deletion src/lib/core/ripple/ripple-renderer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export type RippleConfig = {
terminateOnPointerUp?: boolean;
/**
* @deprecated Use the `animation` property instead.
* @deletion-target 7.0.0
* @breaking-change 7.0.0
*/
speedFactor?: number;
};
Expand Down
4 changes: 2 additions & 2 deletions src/lib/core/ripple/ripple.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export interface RippleGlobalOptions {
* setting it to 0.5 will cause the ripple fade-in animation to take twice as long.
* A changed speedFactor will not affect the fade-out duration of the ripples.
* @deprecated Use the `animation` global option instead.
* @deletion-target 7.0.0
* @breaking-change 7.0.0
*/
baseSpeedFactor?: number;

Expand Down Expand Up @@ -91,7 +91,7 @@ export class MatRipple implements OnInit, OnDestroy, RippleTarget {
* setting it to 0.5 will cause the animations to take twice as long.
* A changed speedFactor will not modify the fade-out duration of the ripples.
* @deprecated Use the [matRippleAnimation] binding instead.
* @deletion-target 7.0.0
* @breaking-change 7.0.0
*/
@Input('matRippleSpeedFactor') speedFactor: number = 1;

Expand Down
12 changes: 6 additions & 6 deletions src/lib/core/theming/_palette.scss
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,22 @@


// @deprecated renamed to $dark-primary-text.
// @deletion-target 7.0.0
// @breaking-change 7.0.0
$black-87-opacity: rgba(black, 0.87);
// @deprecated renamed to $light-primary-text.
// @deletion-target 7.0.0
// @breaking-change 7.0.0
$white-87-opacity: rgba(white, 0.87);
// @deprecated use $dark-[secondary-text,disabled-text,dividers,focused] instead.
// @deletion-target 7.0.0
// @breaking-change 7.0.0
$black-12-opacity: rgba(black, 0.12);
// @deprecated use $light-[secondary-text,disabled-text,dividers,focused] instead.
// @deletion-target 7.0.0
// @breaking-change 7.0.0
$white-12-opacity: rgba(white, 0.12);
// @deprecated use $dark-[secondary-text,disabled-text,dividers,focused] instead.
// @deletion-target 7.0.0
// @breaking-change 7.0.0
$black-6-opacity: rgba(black, 0.06);
// @deprecated use $light-[secondary-text,disabled-text,dividers,focused] instead.
// @deletion-target 7.0.0
// @breaking-change 7.0.0
$white-6-opacity: rgba(white, 0.06);

$dark-primary-text: rgba(black, 0.87);
Expand Down
Loading

0 comments on commit 877de56

Please sign in to comment.