Skip to content

Commit b189b19

Browse files
authored
chore: deprecate minimalist renderer (#7210)
* chore: deprecate the minimalist renderer * chore: add renamings
1 parent d6848de commit b189b19

5 files changed

Lines changed: 55 additions & 0 deletions

File tree

core/renderers/minimalist/constants.ts

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,27 @@ import * as goog from '../../../closure/goog/goog.js';
88
goog.declareModuleId('Blockly.minimalist.ConstantProvider');
99

1010
import {ConstantProvider as BaseConstantProvider} from '../common/constants.js';
11+
import * as deprecation from '../../utils/deprecation.js';
1112

1213
/**
1314
* An object that provides constants for rendering blocks in the minimalist
1415
* renderer.
16+
*
17+
* @deprecated Use Blockly.blockRendering.ConstantProvider instead.
18+
* To be removed in v11.
1519
*/
1620
export class ConstantProvider extends BaseConstantProvider {
21+
/**
22+
* @deprecated Use Blockly.blockRendering.ConstantProvider instead.
23+
* To be removed in v11.
24+
*/
1725
constructor() {
1826
super();
27+
deprecation.warn(
28+
'Blockly.minimalist.ConstantProvider',
29+
'v10',
30+
'v11',
31+
'Blockly.blockRendering.ConstantProvider'
32+
);
1933
}
2034
}

core/renderers/minimalist/drawer.ts

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,32 @@ goog.declareModuleId('Blockly.minimalist.Drawer');
99

1010
import type {BlockSvg} from '../../block_svg.js';
1111
import {Drawer as BaseDrawer} from '../common/drawer.js';
12+
import * as deprecation from '../../utils/deprecation.js';
1213

1314
import type {RenderInfo} from './info.js';
1415

1516
/**
1617
* An object that draws a block based on the given rendering information.
18+
*
19+
* @deprecated Use Blockly.blockRendering.Drawer instead.
20+
* To be removed in v11.
1721
*/
1822
export class Drawer extends BaseDrawer {
1923
/**
2024
* @param block The block to render.
2125
* @param info An object containing all information needed to render this
2226
* block.
27+
*
28+
* @deprecated Use Blockly.blockRendering.Drawer instead.
29+
* To be removed in v11.
2330
*/
2431
constructor(block: BlockSvg, info: RenderInfo) {
2532
super(block, info);
33+
deprecation.warn(
34+
'Blockly.minimalist.Drawer',
35+
'v10',
36+
'v11',
37+
'Blockly.blockRendering.Drawer'
38+
);
2639
}
2740
}

core/renderers/minimalist/info.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ goog.declareModuleId('Blockly.minimalist.RenderInfo');
99

1010
import type {BlockSvg} from '../../block_svg.js';
1111
import {RenderInfo as BaseRenderInfo} from '../common/info.js';
12+
import * as deprecation from '../../utils/deprecation.js';
1213

1314
import type {Renderer} from './renderer.js';
1415

@@ -18,6 +19,9 @@ import type {Renderer} from './renderer.js';
1819
* This measure pass does not propagate changes to the block (although fields
1920
* may choose to rerender when getSize() is called). However, calling it
2021
* repeatedly may be expensive.
22+
*
23+
* @deprecated Use Blockly.blockRendering.RenderInfo instead. To be removed
24+
* in v11.
2125
*/
2226
export class RenderInfo extends BaseRenderInfo {
2327
// Exclamation is fine b/c this is assigned by the super constructor.
@@ -26,9 +30,17 @@ export class RenderInfo extends BaseRenderInfo {
2630
/**
2731
* @param renderer The renderer in use.
2832
* @param block The block to measure.
33+
* @deprecated Use Blockly.blockRendering.RenderInfo instead. To be removed
34+
* in v11.
2935
*/
3036
constructor(renderer: Renderer, block: BlockSvg) {
3137
super(renderer, block);
38+
deprecation.warn(
39+
'Blockly.minimalist.RenderInfo',
40+
'v10',
41+
'v11',
42+
'Blockly.blockRendering.RenderInfo'
43+
);
3244
}
3345

3446
/**

core/renderers/minimalist/renderer.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,32 @@ import type {BlockSvg} from '../../block_svg.js';
1111
import * as blockRendering from '../common/block_rendering.js';
1212
import type {RenderInfo as BaseRenderInfo} from '../common/info.js';
1313
import {Renderer as BaseRenderer} from '../common/renderer.js';
14+
import * as deprecation from '../../utils/deprecation.js';
1415

1516
import {ConstantProvider} from './constants.js';
1617
import {Drawer} from './drawer.js';
1718
import {RenderInfo} from './info.js';
1819

1920
/**
2021
* The minimalist renderer.
22+
*
23+
* @deprecated Use Blockly.blockRendering.Renderer instead. To be removed
24+
* in v11.
2125
*/
2226
export class Renderer extends BaseRenderer {
2327
/**
2428
* @param name The renderer name.
29+
* @deprecated Use Blockly.blockRendering.Renderer instead. To be removed
30+
* in v11.
2531
*/
2632
constructor(name: string) {
2733
super(name);
34+
deprecation.warn(
35+
'Blockly.minimalist.Renderer',
36+
'v10',
37+
'v11',
38+
'Blockly.blockRendering.Renderer'
39+
);
2840
}
2941

3042
/**

scripts/migration/renamings.json5

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1516,6 +1516,10 @@
15161516
oldName: 'Blockly.Bubble',
15171517
newName: 'Blockly.bubbles.Bubble',
15181518
},
1519+
{
1520+
oldName: 'Blockly.minimalist',
1521+
newPath: 'Blockly.blockRendering',
1522+
},
15191523
// The following renamings serve two purposes:
15201524
// - Record that the langGenerator instances have moved to a
15211525
// different module (though this is not actually actioned by the

0 commit comments

Comments
 (0)