chore: deprecate minimalist renderer (#7210)

* chore: deprecate the minimalist renderer

* chore: add renamings
This commit is contained in:
Beka Westberg
2023-06-26 14:30:06 -07:00
committed by GitHub
parent d6848de645
commit b189b1989c
5 changed files with 55 additions and 0 deletions

View File

@@ -8,13 +8,27 @@ import * as goog from '../../../closure/goog/goog.js';
goog.declareModuleId('Blockly.minimalist.ConstantProvider');
import {ConstantProvider as BaseConstantProvider} from '../common/constants.js';
import * as deprecation from '../../utils/deprecation.js';
/**
* An object that provides constants for rendering blocks in the minimalist
* renderer.
*
* @deprecated Use Blockly.blockRendering.ConstantProvider instead.
* To be removed in v11.
*/
export class ConstantProvider extends BaseConstantProvider {
/**
* @deprecated Use Blockly.blockRendering.ConstantProvider instead.
* To be removed in v11.
*/
constructor() {
super();
deprecation.warn(
'Blockly.minimalist.ConstantProvider',
'v10',
'v11',
'Blockly.blockRendering.ConstantProvider'
);
}
}

View File

@@ -9,19 +9,32 @@ goog.declareModuleId('Blockly.minimalist.Drawer');
import type {BlockSvg} from '../../block_svg.js';
import {Drawer as BaseDrawer} from '../common/drawer.js';
import * as deprecation from '../../utils/deprecation.js';
import type {RenderInfo} from './info.js';
/**
* An object that draws a block based on the given rendering information.
*
* @deprecated Use Blockly.blockRendering.Drawer instead.
* To be removed in v11.
*/
export class Drawer extends BaseDrawer {
/**
* @param block The block to render.
* @param info An object containing all information needed to render this
* block.
*
* @deprecated Use Blockly.blockRendering.Drawer instead.
* To be removed in v11.
*/
constructor(block: BlockSvg, info: RenderInfo) {
super(block, info);
deprecation.warn(
'Blockly.minimalist.Drawer',
'v10',
'v11',
'Blockly.blockRendering.Drawer'
);
}
}

View File

@@ -9,6 +9,7 @@ goog.declareModuleId('Blockly.minimalist.RenderInfo');
import type {BlockSvg} from '../../block_svg.js';
import {RenderInfo as BaseRenderInfo} from '../common/info.js';
import * as deprecation from '../../utils/deprecation.js';
import type {Renderer} from './renderer.js';
@@ -18,6 +19,9 @@ import type {Renderer} from './renderer.js';
* This measure pass does not propagate changes to the block (although fields
* may choose to rerender when getSize() is called). However, calling it
* repeatedly may be expensive.
*
* @deprecated Use Blockly.blockRendering.RenderInfo instead. To be removed
* in v11.
*/
export class RenderInfo extends BaseRenderInfo {
// Exclamation is fine b/c this is assigned by the super constructor.
@@ -26,9 +30,17 @@ export class RenderInfo extends BaseRenderInfo {
/**
* @param renderer The renderer in use.
* @param block The block to measure.
* @deprecated Use Blockly.blockRendering.RenderInfo instead. To be removed
* in v11.
*/
constructor(renderer: Renderer, block: BlockSvg) {
super(renderer, block);
deprecation.warn(
'Blockly.minimalist.RenderInfo',
'v10',
'v11',
'Blockly.blockRendering.RenderInfo'
);
}
/**

View File

@@ -11,6 +11,7 @@ import type {BlockSvg} from '../../block_svg.js';
import * as blockRendering from '../common/block_rendering.js';
import type {RenderInfo as BaseRenderInfo} from '../common/info.js';
import {Renderer as BaseRenderer} from '../common/renderer.js';
import * as deprecation from '../../utils/deprecation.js';
import {ConstantProvider} from './constants.js';
import {Drawer} from './drawer.js';
@@ -18,13 +19,24 @@ import {RenderInfo} from './info.js';
/**
* The minimalist renderer.
*
* @deprecated Use Blockly.blockRendering.Renderer instead. To be removed
* in v11.
*/
export class Renderer extends BaseRenderer {
/**
* @param name The renderer name.
* @deprecated Use Blockly.blockRendering.Renderer instead. To be removed
* in v11.
*/
constructor(name: string) {
super(name);
deprecation.warn(
'Blockly.minimalist.Renderer',
'v10',
'v11',
'Blockly.blockRendering.Renderer'
);
}
/**

View File

@@ -1516,6 +1516,10 @@
oldName: 'Blockly.Bubble',
newName: 'Blockly.bubbles.Bubble',
},
{
oldName: 'Blockly.minimalist',
newPath: 'Blockly.blockRendering',
},
// The following renamings serve two purposes:
// - Record that the langGenerator instances have moved to a
// different module (though this is not actually actioned by the