feat: add json definition generator functions #2188
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
NeilFraser
approved these changes
Feb 5, 2024
| generator.valueToCode(block, 'TOOLTIP', Order.ATOMIC), | ||
| ); | ||
| const helpUrl = JSON.parse( | ||
| generator.valueToCode(block, 'HELPURL', Order.ATOMIC), |
There was a problem hiding this comment.
I've heard of trailing commas on object literals, but trailing commas on function parameters is new to me.
There was a problem hiding this comment.
yeah, this was a relatively recent change by the formatter. I think they used the same logic for trailing commas elsewhere and applied it to multiline function definitions as well (smaller diffs when adding or removing parameters, etc).
| * | ||
| * @param workspace Workspace to generate code from. | ||
| */ | ||
| init(workspace: Blockly.Workspace) { |
There was a problem hiding this comment.
Do we want commented out code here? Over time the origin of this code will drift away from the commented out code. I'm not sure it can be trusted in the future.
There was a problem hiding this comment.
No, we don't. I'll remove it all before I merge this branch into develop. I just haven't gotten far enough along to where I know which parts I want to delete and which parts I actually want to uncomment. But I won't do the final merge with this in here
maribethb
added a commit
to maribethb/blockly-samples
that referenced
this pull request
Jun 12, 2024
maribethb
added a commit
that referenced
this pull request
Jun 28, 2024
* feat: add basic infrastructure of developer-tools * chore: add eof newline where missing * fix: formatting, license, css attributes * feat: add block factory blocks and toolbox (#2155) * feat: add block factory blocks and toolbox * fix: pr comments * fix: change type to connection check * fix: formatting and comments * chore: lint and format developer-tools (#2185) * chore: autofix lint * chore: manually fix most of the lint * chore: format * feat: add basic saving and loading and start block state (#2187) * feat: add json definition generator (#2188) * feat: add javascript definition generators for blocks (#2196) * feat: add javascript definition generators for blocks * chore: format * fix: switch statement style Co-authored-by: Christopher Allen <[email protected]> * fix: update to latest blockly to use JavascriptGenerator class * fix: fix img dropdown option --------- Co-authored-by: Christopher Allen <[email protected]> * feat: add controllers and models to switch between definitions (#2219) * feat: add code header generation for imports and script tags (#2286) * feat: add save, load, and delete functionality to dev-tools (#2285) * feat: add save, load, and delete functionality to dev-tools * chore: format * chore: update load name * feat: add generator stubs to block factory (#2295) * feat: add generator stub generator and output * feat: add generator headers * chore: add more tsdoc * chore: minor refactoring of template strings * feat: save block factory settings (#2297) * feat: save block factory settings * chore: const to named functions * feat: add ability to convert old block factory json to new (#2304) * feat: add ability to convert old block factory json to new * chore: format and use constant * fix: use better typings, minor refactoring * feat: add shadow blocks for connection checks and real colour block (#2307) * feat: add file upload for block factory (#2320) * feat: add file upload for block factory * chore: fix questionable html formatting * chore: rename and comments * feat: add angle and colour fields to block factory (#2325) * feat: add angle and colour fields to block factory * fix: call register fields in script header * feat: support uploading file from old block factory (#2336) * feat: support uploading file from old block factory * feat: support multiple file input, minor pr fixes * feat: update to blockly v11 & improve style (#2388) * fix: styling * fix: changes for v11 * fix: set max height in narrow mode * fix: min height of code divs * chore: format * chore: remove log * feat: use a js legal name for the block in code output (#2392) * feat: use a js legal name for the block in code output * fix: legal js name probably * feat: add help button and favicon (#2396) * feat: include developer-tools when publishing to gh-pages (#2395) --------- Co-authored-by: Christopher Allen <[email protected]>
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
Works on Block Factory
Proposed Changes
blocks/type.tsfile toblocks/connection_check.tsto match the new name which was renamed in a previous PRThis PR depends on #2187 , but only barely. It's only the changes in
index.tsand I'm adding to the change listener that was added in that PR. So you can still review this PR for content and I'll rebase when that PR goes in. The bulk of this PR is not dependent on that one.Note that many parts of the
JsonDefinitionGeneratorare commented out. I plan to clean this up once I've written a) the other types of generators and b) implemented checking the block name doesn't conflict with a different block name and is a valid json identifier, which I am hoping to use the machinery for valid names in generators to do so. So I will need parts that are currently commented out and others I am not sure about yet. I got the bulk of this code from copying thejavascriptGeneratorfrom core and modifying as needed.Reason for Changes
Test Coverage
Manual testing. I've started working on an automated test that would exercise this generator but there's no mechanism for running tests in
examples/right now so that's a bigger project and in a different PR.Documentation
Additional Information