deprecate: the debug renderer (#5961)

* deprecate: the debug renderer

* chore: run format

* chore: remove @deprecated for functions still used in core
This commit is contained in:
alschmiedt
2022-02-28 17:59:28 -08:00
committed by GitHub
parent fa14e9d6de
commit 9ba2571a38
2 changed files with 24 additions and 3 deletions

View File

@@ -56,11 +56,13 @@ const {Types} = goog.require('Blockly.blockRendering.Types');
* @return {boolean} Whether the debugger is turned on.
* @alias Blockly.blockRendering.isDebuggerEnabled
* @package
* @deprecated
*/
const isDebuggerEnabled = function() {
deprecation.warn(
'Blockly.blockRendering.isDebuggerEnabled()', 'September 2021',
'September 2022', 'Blockly.blockRendering.debug.isDebuggerEnabled()');
'September 2022',
'the debug renderer in @blockly/dev-tools (See https://www.npmjs.com/package/@blockly/dev-tools.)');
return debug.isDebuggerEnabled();
};
exports.isDebuggerEnabled = isDebuggerEnabled;
@@ -91,11 +93,13 @@ exports.unregister = unregister;
* Turn on the blocks debugger.
* @package
* @alias Blockly.blockRendering.startDebugger
* @deprecated
*/
const startDebugger = function() {
deprecation.warn(
'Blockly.blockRendering.startDebugger()', 'September 2021',
'September 2022', 'Blockly.blockRendering.debug.startDebugger()');
'September 2022',
'the debug renderer in @blockly/dev-tools (See https://www.npmjs.com/package/@blockly/dev-tools.)');
debug.startDebugger();
};
exports.startDebugger = startDebugger;
@@ -104,11 +108,13 @@ exports.startDebugger = startDebugger;
* Turn off the blocks debugger.
* @package
* @alias Blockly.blockRendering.stopDebugger
* @deprecated
*/
const stopDebugger = function() {
deprecation.warn(
'Blockly.blockRendering.stopDebugger()', 'September 2021',
'September 2022', 'Blockly.blockRendering.debug.stopDebugger()');
'September 2022',
'the debug renderer in @blockly/dev-tools (See https://www.npmjs.com/package/@blockly/dev-tools.)');
debug.stopDebugger();
};
exports.stopDebugger = stopDebugger;

View File

@@ -15,6 +15,8 @@
*/
goog.module('Blockly.blockRendering.debug');
const deprecation = goog.require('Blockly.utils.deprecation');
/**
* Whether or not the debugger is turned on.
@@ -28,6 +30,11 @@ let useDebugger = false;
* @package
*/
const isDebuggerEnabled = function() {
deprecation.warn(
'Blockly.blockRendering.debug.isDebuggerEnabled()', 'February 2022',
'September 2022',
'the debug renderer in @blockly/dev-tools (See https://www.npmjs.com/package/@blockly/dev-tools.)');
return useDebugger;
};
exports.isDebuggerEnabled = isDebuggerEnabled;
@@ -38,6 +45,10 @@ exports.isDebuggerEnabled = isDebuggerEnabled;
* @alias Blockly.blockRendering.debug.startDebugger
*/
const startDebugger = function() {
deprecation.warn(
'Blockly.blockRendering.debug.startDebugger()', 'February 2022',
'September 2022',
'the debug renderer in @blockly/dev-tools (See https://www.npmjs.com/package/@blockly/dev-tools.)');
useDebugger = true;
};
exports.startDebugger = startDebugger;
@@ -48,6 +59,10 @@ exports.startDebugger = startDebugger;
* @alias Blockly.blockRendering.debug.stopDebugger
*/
const stopDebugger = function() {
deprecation.warn(
'Blockly.blockRendering.debug.stopDebugger()', 'February 2022',
'September 2022',
'the debug renderer in @blockly/dev-tools (See https://www.npmjs.com/package/@blockly/dev-tools.)');
useDebugger = false;
};
exports.stopDebugger = stopDebugger;