fix!(generators): Fix generator typings #7727
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cpcallen
added
component: generators
breaking change
github-actions
bot
added
PR: fix
BeksOmega
reviewed
Dec 19, 2023
| @@ -348,7 +348,6 @@ function packageDTS() { | |||
| return gulp.src(handwrittenSrcs, {base: 'typings'}) | |||
| .pipe(gulp.src(`${TYPINGS_BUILD_DIR}/**/*.d.ts`, {ignore: [ | |||
| `${TYPINGS_BUILD_DIR}/blocks/**/*`, | |||
| `${TYPINGS_BUILD_DIR}/generators/**/*`, | |||
There was a problem hiding this comment.
Shouldn't this still exist if this is where the reexports are coming from?
There was a problem hiding this comment.
It is being deleted from the ignore: clause, thus causing it to be included in what gets copied from build/ to dist/.
There was a problem hiding this comment.
haha ok sweet sorry about that.
BeksOmega
approved these changes
Dec 19, 2023
|
Darn it: this PR should have had a "!" in its title, and so especially should the squash commit, which didn't get a "BREAKING CHANGE:" text in the description. I'm going to rename the PR in the hopes that that is enough to make the release notes come out correctly. 🤞 |
cpcallen
changed the title
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The basics
The details
Resolves
Fixes #7652.
Proposed Changes
package_tasks.jsto includetsc-generated.d.tsfiles for the generators indistwhen building theblocklyNPM package..d.tsfiles for the generator chunks with ones that reexport the types from the correspondingtsc-generated.d.tsfile.Reason for Changes
Publish accurate typings for the generators.
Additional Information
BREAKING CHANGE: Previously the
dartGenerator,luaGenerator,javascriptGenerator,phpGenerator, andpythonGeneratorexports (from theblockly/dart,blockly/lua,blockly/javascript,blockly/phpandblockly/pythonentrypoints respectively) were being typedany. Now their types are correct. There is no change to their runtime behaviour, but developers who have written code in TypeScript that manipulates generators (adding custom block generator functions, for example) may find they need to correct type error in their code in order for it to compile correctly with Blockly v11.Notably, block generator functions to be installed in the
javascriptGenerator.forBlockdictionary should be typed—and similarly for each of the other four languages we support.