CodingPirates/blockly
1
0
Fork 0
mirror of https://github.com/google/blockly.git synced 2026-01-10 02:17:09 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4051 from rachel-fenichel/deprecation_util

Browse Source 
Add deprecation helper + 2 uses
This commit is contained in:
Rachel Fenichel
2020-07-16 14:48:44 -07:00
committed by GitHub
parent 2b8208b1e2 5b393eed76
commit 44fe3ef367
4 changed files with 61 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
blockly_uncompressed.js
View File

@@ -21,12 +21,12 @@ this.BLOCKLY_DIR = (function(root) {
this.BLOCKLY_BOOT = function(root) {
// Execute after Closure has loaded.
goog.addDependency('../../core/block.js', ['Blockly.Block'], ['Blockly.ASTNode', 'Blockly.Blocks', 'Blockly.Connection', 'Blockly.Events', 'Blockly.Events.BlockChange', 'Blockly.Events.BlockCreate', 'Blockly.Events.BlockDelete', 'Blockly.Events.BlockMove', 'Blockly.Extensions', 'Blockly.Input', 'Blockly.Workspace', 'Blockly.fieldRegistry', 'Blockly.navigation', 'Blockly.utils', 'Blockly.utils.Coordinate', 'Blockly.utils.object', 'Blockly.utils.string'], {'lang': 'es5'});
goog.addDependency('../../core/block.js', ['Blockly.Block'], ['Blockly.ASTNode', 'Blockly.Blocks', 'Blockly.Connection', 'Blockly.Events', 'Blockly.Events.BlockChange', 'Blockly.Events.BlockCreate', 'Blockly.Events.BlockDelete', 'Blockly.Events.BlockMove', 'Blockly.Extensions', 'Blockly.Input', 'Blockly.Workspace', 'Blockly.fieldRegistry', 'Blockly.navigation', 'Blockly.utils', 'Blockly.utils.Coordinate', 'Blockly.utils.deprecation', 'Blockly.utils.object', 'Blockly.utils.string'], {'lang': 'es5'});
goog.addDependency('../../core/block_animations.js', ['Blockly.blockAnimations'], ['Blockly.utils.dom'], {});
goog.addDependency('../../core/block_drag_surface.js', ['Blockly.BlockDragSurfaceSvg'], ['Blockly.utils', 'Blockly.utils.Coordinate', 'Blockly.utils.dom'], {});
goog.addDependency('../../core/block_dragger.js', ['Blockly.BlockDragger'], ['Blockly.Events', 'Blockly.Events.BlockMove', 'Blockly.Events.Ui', 'Blockly.InsertionMarkerManager', 'Blockly.blockAnimations', 'Blockly.utils.Coordinate', 'Blockly.utils.dom'], {});
goog.addDependency('../../core/block_events.js', ['Blockly.Events.BlockBase', 'Blockly.Events.BlockChange', 'Blockly.Events.BlockCreate', 'Blockly.Events.BlockDelete', 'Blockly.Events.BlockMove', 'Blockly.Events.Change', 'Blockly.Events.Create', 'Blockly.Events.Delete', 'Blockly.Events.Move'], ['Blockly.Events', 'Blockly.Events.Abstract', 'Blockly.utils.Coordinate', 'Blockly.utils.object', 'Blockly.utils.xml'], {});
goog.addDependency('../../core/block_svg.js', ['Blockly.BlockSvg'], ['Blockly.ASTNode', 'Blockly.Block', 'Blockly.ContextMenu', 'Blockly.Events', 'Blockly.Events.BlockMove', 'Blockly.Events.Ui', 'Blockly.Msg', 'Blockly.RenderedConnection', 'Blockly.TabNavigateCursor', 'Blockly.Tooltip', 'Blockly.Touch', 'Blockly.blockAnimations', 'Blockly.blockRendering.IPathObject', 'Blockly.navigation', 'Blockly.utils', 'Blockly.utils.Coordinate', 'Blockly.utils.Rect', 'Blockly.utils.dom', 'Blockly.utils.object'], {});
goog.addDependency('../../core/block_svg.js', ['Blockly.BlockSvg'], ['Blockly.ASTNode', 'Blockly.Block', 'Blockly.ContextMenu', 'Blockly.ContextMenuRegistry', 'Blockly.Events', 'Blockly.Events.BlockMove', 'Blockly.Events.Ui', 'Blockly.Msg', 'Blockly.RenderedConnection', 'Blockly.TabNavigateCursor', 'Blockly.Tooltip', 'Blockly.Touch', 'Blockly.blockAnimations', 'Blockly.blockRendering.IPathObject', 'Blockly.navigation', 'Blockly.utils', 'Blockly.utils.Coordinate', 'Blockly.utils.Rect', 'Blockly.utils.dom', 'Blockly.utils.object'], {});
goog.addDependency('../../core/blockly.js', ['Blockly'], ['Blockly.Events', 'Blockly.Events.Ui', 'Blockly.Procedures', 'Blockly.Tooltip', 'Blockly.Touch', 'Blockly.Variables', 'Blockly.WidgetDiv', 'Blockly.WorkspaceSvg', 'Blockly.Xml', 'Blockly.constants', 'Blockly.inject', 'Blockly.navigation', 'Blockly.utils', 'Blockly.utils.Size', 'Blockly.utils.colour'], {});
goog.addDependency('../../core/blocks.js', ['Blockly.Blocks'], [], {});
goog.addDependency('../../core/bubble.js', ['Blockly.Bubble'], ['Blockly.Scrollbar', 'Blockly.Touch', 'Blockly.Workspace', 'Blockly.utils', 'Blockly.utils.Coordinate', 'Blockly.utils.dom', 'Blockly.utils.math', 'Blockly.utils.userAgent'], {});
@@ -40,7 +40,7 @@ goog.addDependency('../../core/connection.js', ['Blockly.Connection'], ['Blockly
goog.addDependency('../../core/connection_db.js', ['Blockly.ConnectionDB'], ['Blockly.RenderedConnection'], {});
goog.addDependency('../../core/constants.js', ['Blockly.constants'], [], {});
goog.addDependency('../../core/contextmenu.js', ['Blockly.ContextMenu'], ['Blockly.Events', 'Blockly.Events.BlockCreate', 'Blockly.Menu', 'Blockly.MenuItem', 'Blockly.Msg', 'Blockly.Xml', 'Blockly.utils', 'Blockly.utils.Coordinate', 'Blockly.utils.Rect', 'Blockly.utils.dom', 'Blockly.utils.userAgent'], {});
goog.addDependency('../../core/contextmenu_items.js', ['Blockly.ContextMenuItems'], [], {});
goog.addDependency('../../core/contextmenu_items.js', ['Blockly.ContextMenuItems'], [], {'lang': 'es5'});
goog.addDependency('../../core/contextmenu_registry.js', ['Blockly.ContextMenuRegistry'], ['Blockly.ContextMenuItems'], {'lang': 'es5'});
goog.addDependency('../../core/css.js', ['Blockly.Css'], [], {'lang': 'es5'});
goog.addDependency('../../core/dropdowndiv.js', ['Blockly.DropDownDiv'], ['Blockly.utils.dom', 'Blockly.utils.math', 'Blockly.utils.style'], {});
@@ -160,6 +160,7 @@ goog.addDependency('../../core/utils.js', ['Blockly.utils'], ['Blockly.Msg', 'Bl
goog.addDependency('../../core/utils/aria.js', ['Blockly.utils.aria'], [], {});
goog.addDependency('../../core/utils/colour.js', ['Blockly.utils.colour'], [], {});
goog.addDependency('../../core/utils/coordinate.js', ['Blockly.utils.Coordinate'], [], {});
goog.addDependency('../../core/utils/deprecation.js', ['Blockly.utils.deprecation'], [], {});
goog.addDependency('../../core/utils/dom.js', ['Blockly.utils.dom'], ['Blockly.utils.userAgent'], {});
goog.addDependency('../../core/utils/global.js', ['Blockly.utils.global'], [], {});
goog.addDependency('../../core/utils/idgenerator.js', ['Blockly.utils.IdGenerator'], [], {});

8
core/block.js
View File

@@ -25,6 +25,7 @@ goog.require('Blockly.fieldRegistry');
goog.require('Blockly.Input');
goog.require('Blockly.navigation');
goog.require('Blockly.utils');
goog.require('Blockly.utils.deprecation');
goog.require('Blockly.utils.Coordinate');
goog.require('Blockly.utils.object');
goog.require('Blockly.utils.string');
@@ -1242,8 +1243,11 @@ Blockly.Block.prototype.getOutputShape = function() {
* @deprecated May 2019
*/
Blockly.Block.prototype.setDisabled = function(disabled) {
console.warn('Deprecated call to Blockly.Block.prototype.setDisabled, ' +
'use Blockly.Block.prototype.setEnabled instead.');
Blockly.utils.deprecation.warn(
'Block.prototype.setDisabled',
'May 2019',
'May 2020',
'Block.prototype.setEnabled');
this.setEnabled(!disabled);
};

20
core/block_svg.js
View File

@@ -28,6 +28,7 @@ goog.require('Blockly.TabNavigateCursor');
goog.require('Blockly.Tooltip');
goog.require('Blockly.Touch');
goog.require('Blockly.utils');
goog.require('Blockly.utils.deprecation');
goog.require('Blockly.utils.Coordinate');
goog.require('Blockly.utils.dom');
goog.require('Blockly.utils.object');
@@ -239,6 +240,11 @@ Blockly.BlockSvg.prototype.getColourTertiary = function() {
* @deprecated Use style.colourSecondary. (2020 January 21)
*/
Blockly.BlockSvg.prototype.getColourShadow = function() {
Blockly.utils.deprecation.warn(
'BlockSvg.prototype.getColourShadow',
'January 2020',
'January 2021',
'style.colourSecondary');
return this.getColourSecondary();
};
@@ -252,6 +258,11 @@ Blockly.BlockSvg.prototype.getColourShadow = function() {
* @deprecated Use style.colourTertiary. (2020 January 21)
*/
Blockly.BlockSvg.prototype.getColourBorder = function() {
Blockly.utils.deprecation.warn(
'BlockSvg.prototype.getColourBorder',
'January 2020',
'January 2021',
'style.colourTertiary');
var colourTertiary = this.getColourTertiary();
return {
colourBorder: colourTertiary,
@@ -1066,7 +1077,7 @@ Blockly.BlockSvg.prototype.setWarningText = function(text, opt_id) {
collapsedParent.setWarningText(Blockly.Msg['COLLAPSED_WARNINGS_WARNING'],
Blockly.BlockSvg.COLLAPSED_WARNING_ID);
}
if (!this.warning) {
this.warning = new Blockly.Warning(this);
changedState = true;
@@ -1120,8 +1131,11 @@ Blockly.BlockSvg.prototype.setMutator = function(mutator) {
* @deprecated May 2019
*/
Blockly.BlockSvg.prototype.setDisabled = function(disabled) {
console.warn('Deprecated call to Blockly.BlockSvg.prototype.setDisabled, ' +
'use Blockly.BlockSvg.prototype.setEnabled instead.');
Blockly.utils.deprecation.warn(
'BlockSvg.prototype.setDisabled',
'May 2019',
'May 2020',
'BlockSvg.prototype.setEnabled');
this.setEnabled(!disabled);
};

34
core/utils/deprecation.js Normal file
View File

@@ -0,0 +1,34 @@
/**
* @license
* Copyright 2020 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @fileoverview Helper function for warning developers about deprecations.
* This method is not specific to Blockly.
* @author fenichel@google.com (Rachel Fenichel);
*/
'use strict';
goog.provide('Blockly.utils.deprecation');
/**
* Warn developers that a function is deprecated.
* @param {string} functionName The name of the function.
* @param {string} deprecationDate The date when the function was deprecated.
* Prefer 'month yyyy' or 'quarter yyyy' format.
* @param {string} deletionDate The date when the function will be deleted, in
* the same format as the deprecation date.
* @param {string=} opt_use The name of a function to use instead, if any.
* @package
*/
Blockly.utils.deprecation.warn = function(
functionName, deprecationDate, deletionDate, opt_use) {
var msg = functionName + ' was deprecated on ' + deprecationDate +
' and will be deleted on ' + deletionDate + '.';
if (opt_use) {
msg += '\nUse ' + opt_use + ' instead.';
}
console.warn(msg);
};