Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add generator tests for the text_multiline block #2232

Merged
merged 2 commits into from
Mar 6, 2024
Merged

feat: add generator tests for the text_multiline block #2232

merged 2 commits into from
Mar 6, 2024

Conversation

rachel-fenichel
Copy link
Collaborator

The basics

The details

Resolves

Part of #2154

Proposed Changes

Clean up imports to import from blockly/core wherever possible, to reduce unnecessary imports and provide example code for writing plugins.

Add generator tests to field multiline input plugin.

The test:

  • Uninstall old blocks and generators.
  • Install new blocks and generators.
  • Load a specific set of blocks (provided as JSON).
  • Run each language generator in turn.
  • Compare the generated code to a golden file for each language.
    • I created the golden file by running the old generators in the playground.

Reason for Changes

Verify that generators are the same after moving them from core to samples. This is primarily change detection in case of later cleanup.

Test Coverage

Added tests in plugins/field-multilineinput/test/blocks-test.mocha

@rachel-fenichel rachel-fenichel requested a review from a team as a code owner March 5, 2024 20:01
@rachel-fenichel rachel-fenichel requested review from NeilFraser and removed request for a team March 5, 2024 20:01
NeilFraser
NeilFraser reviewed Mar 5, 2024
View reviewed changes
Copy link
Contributor

@NeilFraser NeilFraser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a question about the golden files, why are the line feeds as separate strings? No problem, just unusual.

Much as I adore Jabberwocky, it might be a good idea to choose a test string which triggers escaping with both types of quotes. Something like:

Picard said, "Beam me up!".
O'Brien made it so.

@rachel-fenichel
Copy link
Collaborator Author

Just a question about the golden files, why are the line feeds as separate strings? No problem, just unusual.

Not sure, but the golden files are generated from the fields currently in core Blockly, so it's consistent.

I updated the test string as you suggested, and updated goldens accordingly.

@rachel-fenichel rachel-fenichel merged commit 5718977 into google:blocks_for_fields Mar 6, 2024
8 checks passed
@rachel-fenichel rachel-fenichel deleted the field-multiline-generators branch March 6, 2024 20:31
rachel-fenichel added a commit that referenced this pull request Mar 29, 2024
@rachel-fenichel
feat: add generator tests for the text_multiline block (#2232)
7a4cd28 
* feat: add generator tests for the text_multiline block

* fix: updated test string to include multiple types of quotes
rachel-fenichel added a commit that referenced this pull request Apr 2, 2024
@rachel-fenichel
feat: add generator tests for the text_multiline block (#2232)
48ae1f9 
* feat: add generator tests for the text_multiline block

* fix: updated test string to include multiple types of quotes
rachel-fenichel added a commit that referenced this pull request Apr 2, 2024
@rachel-fenichel
feat: add generator tests for the text_multiline block (#2232)
78c52d4 
* feat: add generator tests for the text_multiline block

* fix: updated test string to include multiple types of quotes
maribethb pushed a commit that referenced this pull request Apr 2, 2024
@rachel-fenichel
feat!: add block definitions to fields (#2299)
c197af6 
* feat!: add block definitions to colour field plugin (#2162)

* feat: export functions to register some angle, colour, and multiline input fields

* feat: add block definitions to colour and multiline input fields

* feat: add block generators for the colour_picker block

* fix: use Blockly.common.defineBlocksWithJsonArray

* feat: add block generators for colour_random block

* feat: add generators type and standardize exports for block files

* chore: update to blockly@beta and fix types

* chore: move all colour blocks to separate files and add more generator-related types

* feat: finish adding block code generators for colour blocks

* fix: PR feedback

* fix: remove immediate registration of blocks and fields in field_colour

* chore: use named imports and numbered TODOs

* feat: add usage information about blocks to README

* chore: revert changes outside of field_colour

* chore: clean up tsdoc and exports

* cgire: clean up README

* chore: respond to PR feedback on names and comments

* feat(tests): add and improve tests

* chore(format): run formatter

* fix: respond to PR feedback about names and file structure

* fix: allow const variables to have UPPER_CASE names

* fix: respond to PR feedback

* chore: format

* fix: line length

* feat!: add block definition to multiline text field plugin (#2202)

* chore: force-install blockly 10.4.0-beta.1 for development

* feat: add text_multiline block and associated generators

* feat: update test page to use new block and field

* feat: README

* chore: respond to PR feedback

BREAKING CHANGE: The multiline text input field no longer registers itself on load. The developer must either manually register the field or install blocks, which will install the field. This is part of a move to have no side effects in field and block definitions, so that tree-shaking can remove unwanted fields and blocks.

* chore: format (#2221)

* feat!: Add registration function to field_angle and make it no longer install on file load (#2211)

* feat!: Add registration function to field_angle and make it no longer install on file load

* chore: formatting

BREAKING CHANGE: The angle field no longer registers itself on load. The developer must manually register the field. This is part of a move to have no side effects in field and block definitions, so that tree-shaking can remove unwanted fields and blocks.

* feat: add tests for per-block generators in field-colour (#2220)

* feat: add unit tests for generators

* fix: imports in tests

* chore: format

* feat: ignore golden files in plugin tests

* chore: fix lint

* feat: ignore golden files for linting

* fix: revert addition of fs and path packages

* fix: remove suite.only to make all tests run

* chore: handle review feedback

* fix: only import what you need in colour blocks

* feat: add generator tests for the text_multiline block (#2232)

* feat: add generator tests for the text_multiline block

* fix: updated test string to include multiple types of quotes

* fix: code style in generators for field colour blocks (#2233)

* feat!: update blockly version to 10.4.3 for colour and multilineinput (#2296)

* feat!: update blockly version to 10.4.3 for colour and multilineinput

* chore!: update peer dependencies

* chore: update package-lock.jsons

* chore: fix dependencies
gonfunko pushed a commit to gonfunko/blockly-samples that referenced this pull request Apr 15, 2024
@rachel-fenichel @gonfunko
feat!: add block definitions to fields (google#2299)
4c4feb8 
* feat!: add block definitions to colour field plugin (google#2162)

* feat: export functions to register some angle, colour, and multiline input fields

* feat: add block definitions to colour and multiline input fields

* feat: add block generators for the colour_picker block

* fix: use Blockly.common.defineBlocksWithJsonArray

* feat: add block generators for colour_random block

* feat: add generators type and standardize exports for block files

* chore: update to blockly@beta and fix types

* chore: move all colour blocks to separate files and add more generator-related types

* feat: finish adding block code generators for colour blocks

* fix: PR feedback

* fix: remove immediate registration of blocks and fields in field_colour

* chore: use named imports and numbered TODOs

* feat: add usage information about blocks to README

* chore: revert changes outside of field_colour

* chore: clean up tsdoc and exports

* cgire: clean up README

* chore: respond to PR feedback on names and comments

* feat(tests): add and improve tests

* chore(format): run formatter

* fix: respond to PR feedback about names and file structure

* fix: allow const variables to have UPPER_CASE names

* fix: respond to PR feedback

* chore: format

* fix: line length

* feat!: add block definition to multiline text field plugin (google#2202)

* chore: force-install blockly 10.4.0-beta.1 for development

* feat: add text_multiline block and associated generators

* feat: update test page to use new block and field

* feat: README

* chore: respond to PR feedback

BREAKING CHANGE: The multiline text input field no longer registers itself on load. The developer must either manually register the field or install blocks, which will install the field. This is part of a move to have no side effects in field and block definitions, so that tree-shaking can remove unwanted fields and blocks.

* chore: format (google#2221)

* feat!: Add registration function to field_angle and make it no longer install on file load (google#2211)

* feat!: Add registration function to field_angle and make it no longer install on file load

* chore: formatting

BREAKING CHANGE: The angle field no longer registers itself on load. The developer must manually register the field. This is part of a move to have no side effects in field and block definitions, so that tree-shaking can remove unwanted fields and blocks.

* feat: add tests for per-block generators in field-colour (google#2220)

* feat: add unit tests for generators

* fix: imports in tests

* chore: format

* feat: ignore golden files in plugin tests

* chore: fix lint

* feat: ignore golden files for linting

* fix: revert addition of fs and path packages

* fix: remove suite.only to make all tests run

* chore: handle review feedback

* fix: only import what you need in colour blocks

* feat: add generator tests for the text_multiline block (google#2232)

* feat: add generator tests for the text_multiline block

* fix: updated test string to include multiple types of quotes

* fix: code style in generators for field colour blocks (google#2233)

* feat!: update blockly version to 10.4.3 for colour and multilineinput (google#2296)

* feat!: update blockly version to 10.4.3 for colour and multilineinput

* chore!: update peer dependencies

* chore: update package-lock.jsons

* chore: fix dependencies
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@NeilFraser NeilFraser NeilFraser approved these changes

Assignees

@NeilFraser NeilFraser

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@rachel-fenichel @NeilFraser