21 Mar 17:38

cpcallen

b0430d5

blockly-v11.0.0-beta.6 Pre-release

Pre-release

This is the ~~fourth~~ fifth in an ongoing series of beta releases for the future v11 of Blockly. See information about the Blockly v11 Beta Program.

Due to errors in the publication process, the contents of the blockly@11.0.0-beta.5 package were not as intended (and did not correspond with the release notes), and that version has been withdrawn. This version, -beta.6, supersedes it.

Highlights in v11.0.0-beta.6 (was beta.5)

This release was created to publish the fix in PR #7955 for issue #7952, which caused errors when importing langfiles (e.g. blockly/msg/en) in TypeScript modules. Thanks to @clementcontet for reporting this issue in -beta.4 so promptly—and sorry that we didn't catch it despite the extensive testing carried out on the offending PR, #7822!

It also contains unrelated ongoing work on refactoring workspace comments.

What's Changed

New features ✨

feat: rendered workspace comment by @BeksOmega in #7918
feat: have RenderedWorkspaceComment implement IBoundedElement and IRenderedElement by @BeksOmega in #7919
feat: add JSON serialization for workspace comments by @BeksOmega in #7927

Bug fixes 🐛

fix: comment have XML save and load new workspace comments classes by @BeksOmega in #7931
fix(typings): Restore inadvertently-deleted typings/msg/msg.d.ts; add TS import test by @cpcallen in #7955

Full Changelog: blockly-v11.0.0-beta.4...blockly-v11.0.0.-beta.6

Contributors

cpcallen, clementcontet, and BeksOmega

Assets 2

19 Mar 00:15

cpcallen

blockly-v11.0.0-beta.4

250cf90

blockly-v11.0.0-beta.4 Pre-release

Pre-release

This is the third in an ongoing series of beta releases for the future v11 of Blockly. See information about the Blockly v11 Beta Program.

Wait, -beta.4? What happened to .2 and .3?

The keen npmjs.com watches amongst you (hi, @dependabot!) will have noted that, since the last publicly-announce beta, v11.0.0-beta.1, there have been two additional betas published to npmjs.com. These were created to facilitate development and testing of work in the blockly-samples repository, and all the changes from those two unpublicised releases are rolled into the changelist below.

Highlights in v11.0.0-beta.4

Valid entrypoints specified by `exports` directive in `package.json`

The most important change in v11.0.0-beta.4 is actually a change to the packaging, rather than the contents of the package.

Specifically, we have added an exports directive, to the package.json file, which definitively enumerates the valid entrypoints for the package. The purpose of this change is to prepare for the publication of ES module entrypoints, that will supplement (and ultimately supplant) the existing CommonJS module entrypoints, in future versions of Blockly.

Adding an exports section:

Allows us to definitively enumerate the permitted entrypoints for the package, disallowing direct importation of any other files.
Allows us to change which file each individual entrypoint actually loads without it necessarily being a breaking change.
Allows us to specify separate ESM entrypoints for subpaths (like blockly/javascript); without exports all subpath entrypoints must be either ESM or CJS and it is not possible to provide both.

Aside: module resolution

Module resolution is ultimately at the discretion of each JS runtime or build tool. Browsers, node.js, Webpack, Closure Compiler, etc. each have their own module resolution and loading implementations. The package.json file was originally for the benefit of npm in its role of installing packages and their dependencies, but now contains additional information (like the browser, exports, main, umd, and unpkg directives) that are honoured to varying degrees by different tools. It is therefore hard to say categorically what file(s) will be loaded by which tools without consulting each tool's documentation (and/or implementation), but amongst tools that have some kind of support for NPM packages, the exports directive appears to be widely and consistently supported.

Here is some of the relevant documentation for tools we expect Blockly developers are likely to use:

node.js's package entry points and CJS and ESM module resolution algorithms.
webpack's package.json exports support and module resolution and loaders.
Closure Compiler's support for modules.

Valid entrypoints and what they provide

BREAKING CHANGE: The introduction of an exports directive means that correctly-behaved tools (node.js, bundlers like webpack, etc.) will only allow importing of the specified entrypoints. Here is the full list of permitted entrypoints that can be imported or required:

blockly
blockly/core
blockly/blocks
blockly/dart
blockly/lua
blockly/javascript
blockly/php
blockly/python
blockly/msg/<lang>, for all supported language codes <lang> (e.g blockly/msg/en, blockly/msg/fr, blockly/msg/de, etc.)

If you previously imported any other paths from the blockly package you will need to update your imports. Here are the most common paths that may have been used, and their correct replacements:

If you previously imported:	Import instead:
`blockly/index.js`	`blockly`
`blockly/node.js`	`blockly`
`blockly/browser.js`	`blockly`
`blockly/blockly.min`	This file should only be loaded as a `<script>`.
`blockly/core.js`	`blockly/core`
`blockly/core-browser.js`	`blockly/core`
`blockly/blockly_compressed.js`	`blockly/core`
`blockly/blocks.js`	`blockly/blocks`
`blockly/blocks_compressed.js`	`blockly/blocks`
`blockly/dart.js`	`blockly/dart`
`blockly/dart_compressed.js`	`blockly/dart`
`blockly/lua.js`	`blockly/lua`
`blockly/lua_compressed.js`	`blockly/lua`
`blockly/javascript.js`	`blockly/javascript`
`blockly/javascript_compressed.js`	`blockly/javascript`
`blockly/php.js`	`blockly/php`
`blockly/php_compressed.js`	`blockly/php`
`blockly/python.js`	`blockly/python`
`blockly/python_compressed.js`	`blockly/python`
`blockly/msg/en.js`	`blockly/msg/en`

If you are loading Blockly as a script you should continue to load the compiled chunks (blockly_compressed.js, blocks_compressed.js, javascript_compressed.js, etc.) directly, or load blockly.min.js which is just a concatenation of blockly_compressed.js, msg/en.js, blocks_compressed.js, and javascript_generator.js.

(Prior to v11 there were various entrypoint wrappers provided in the form of UMD modules (e.g. blockly.js, javascript.js, etc.) but loading these as as scripts never did anything useful and, as they are no longer needed, they have been deleted.)

BREAKING CHANGE: Prior to v11, importing the main blockly package would import blockly/core, blockly/blocks, blockly/msg/en and blockly/javascript—and additionally, in node.js, also blockly/dart, blockly/lua, blockly/php and blockly/python.

Now the main blockly package entrypoint never loads any of the generators.

This change has been made because of changes to generator exports made in blockly v9.0.0 that make necessary to always separately import generator modules in order to use them.

Note that this change does not affect loading the blockly package via <script src="https://unpkg.com/blockly">; that continues to load to blockly.min.js, which continues to include javascript_compressed.js which (when loaded as a script) makes itself available via Blockly.JavaScript for backwards compatibility.

Field, block and generator changes

BREAKING CHANGE: The angle, colour and multiline input fields (FieldAngle, FieldColour and FieldMultilineInput respectively) have been deleted from Blockly. All three are now provided as plugins. The blocks associated with the colour field and multiline text field have been moved to the field plugins, which now provide documentation on how to install the blocks.

BREAKING CHANGE: Code emitted by the LuaGenerator now uses nil instead of None. This may break some user's downstream block programs if they are assigning to a variable called None and then initializing lists with empty inputs expecting them to contain the value assigned to None.

Other changes

There were also breaking changes to block disposal and to certain CSS classes, as well as other changes made for v11 and/or rolled up from v10; see below for the complete list.

What's Changed