Fix gutenberg/gutenberg-coding-standards licensing issues #61913

anton-vlasenko · 2024-05-23T16:34:29Z

What?

This PR:

removes third-party code from the gutenberg/gutenberg-coding-standards (GBCS) package and removes unused code;
switches GBCS to the GPL-2.0-or-later license as it provides more freedoms and access to licensees than MIT-license code.

Why?

Ensure the package does not use any third-party code.

How?

change the license to GPL-2.0-or-later;
Remove third-party code from the SinceTagSniff::find_docblock() method;
Remove third-party code from the SinceTagSniff::is_function_call() method;
Remove the SinceTagSniff::find_hook_docblock() method and add the new find_previous_line_token() method (refactoring);
Fix typo in the SinceTagSniff::process() method;
Remove unused code from bootstrap.php and make variables use snake case;
Add the License section to the README.md file;

Testing Instructions

Review the code changes and ensure that all CI jobs pass successfully.
Navigate to test/php/gutenberg-coding-standards/.
Run composer update.
Run composer run check-all.
Ensure there are no errors in the console.

Testing Instructions for Keyboard

Screenshots or screencast

github-actions · 2024-05-23T17:00:47Z

Flaky tests detected in 2716212.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/9214390920
📝 Reported issues:

[Flaky Test] Clicking on inserter while on zoom-out should open the patterns tab on the inserter #61806 in /test/e2e/specs/site-editor/zoom-out.spec.js

github-actions · 2024-06-05T17:35:28Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: anton-vlasenko <antonvlasenko@git.wordpress.org>
Co-authored-by: rodrigoprimo <rodrigosprimo@git.wordpress.org>
Co-authored-by: azaozz <azaozz@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

rodrigoprimo

Good job, @anton-vlasenko! I reviewed this PR and left a few comments. There is just one detail that might need to be addressed before merging this PR which is updating a docblock description to reflect the changes made to a method.

I checked the code changes. I don't know about the legal aspects of the licenses, so I don't know if the changes in this PR fix the licensing issues as indicated in the PR title.

test/php/gutenberg-coding-standards/Gutenberg/Sniffs/Commenting/SinceTagSniff.php

...tenberg-coding-standards/Gutenberg/Sniffs/CodeAnalysis/ForbiddenFunctionsAndClassesSniff.php

rodrigoprimo · 2024-07-11T14:15:52Z

test/php/gutenberg-coding-standards/Gutenberg/Tests/AbstractSniffUnitTest.php

@@ -65,7 +67,7 @@ public function setCliValues( $filename, $config ) {
 		if ( ! isset( $GLOBALS['PHP_CODESNIFFER_RULESETS']['Gutenberg'] )
 			|| ( ! $GLOBALS['PHP_CODESNIFFER_RULESETS']['Gutenberg'] instanceof Ruleset )
 		) {
-			throw new \RuntimeException( $error_message );
+			throw new \RuntimeException( $error_message ); //phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped -- this is non-production code.


Why this was not needed before and now it is needed?

The errors likely appeared because I used composer run check-cs this time, instead of just composer run lint as I had previously done.

Thanks for the additional details.

Just a nitpick, but I believe the recommended format for the ignore comment includes a space after the two forward slashes (https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage#ignoring-parts-of-a-file). So, // phpcs:ignore instead of //phpcs:ignore. The current version works so feel free to ignore this remark.

Also, not something to be addressed in this PR, but I wonder if composer run check-cs should be run in CI so that it is easier to catch future coding standard violations like this one?

Good to know. Fixed in 333ccc1.

Also, not something to be addressed in this PR, but I wonder if composer run check-cs should be run in CI so that it is easier to catch future coding standard violations like this one?

Yes, I thought about it, and that would be the right way to do it, in my opinion.
I just don't see it as a high-priority task since there is not a lot of development happening right now (all known issues have been addressed), and it's not likely that the GBCS package will grow significantly in the near future.

test/php/gutenberg-coding-standards/Tests/bootstrap.php

anton-vlasenko · 2024-07-19T19:46:11Z

Thank you for the code review, @rodrigoprimo.
I've replied to your comments. Please let me know if you have any additional notes or remarks.

rodrigoprimo

Sorry for the delay, @anton-vlasenko. I just replied to all of your comments. There is just one nitpick that I found, but feel free to ignore it.

This PR looks good to me. Similar to what I did in previous PRs that I reviewed, I'm not approving this one as I'm not part of the Gutenberg project and could be easily missing something important.

test/php/gutenberg-coding-standards/composer.json

azaozz

As far as I see this is good to go. Using the same dual-licensing GPL and MPL as the rest of Gutenberg seems best.

- remove third-party code from the SinceTagSniff::find_docblock() method; - remove third-party code from the SinceTagSniff::is_function_call() method; - remove the SinceTagSniff::find_hook_docblock() method and add the new find_previous_line_token() method (refactoring); - fix typo in the SinceTagSniff::process() method; - remove unused code from bootstrap.php and make variables use snake case;

…thod.

… environment variable in the context of Gutenberg.

…#r1704157375.

anton-vlasenko · 2024-08-12T11:07:27Z

Thank you everyone!

1. change the license to `GPL-2.0-or-later`; 2. remove third-party code from the `SinceTagSniff::find_docblock()` method; 3. remove third-party code from the `SinceTagSniff::is_function_call()` method; 4. remove the `SinceTagSniff::find_hook_docblock()` method and add the new `find_previous_line_token()` method (refactoring); 5. fix typo in the `SinceTagSniff::process()` method; 6. remove unused code from `bootstrap.php` and make variables use snake case; 7. add the `License` section to the `README.md` file. Co-authored-by: anton-vlasenko <antonvlasenko@git.wordpress.org> Co-authored-by: rodrigoprimo <rodrigosprimo@git.wordpress.org> Co-authored-by: azaozz <azaozz@git.wordpress.org>

anton-vlasenko added the [Type] Build Tooling Issues or PRs related to build tooling label May 23, 2024

anton-vlasenko force-pushed the fix/remove-3rd-party-code-from-gbcs branch from 5d89eb5 to 71c3429 Compare May 27, 2024 15:59

anton-vlasenko requested review from azaozz and ironprogrammer June 5, 2024 11:28

anton-vlasenko force-pushed the fix/remove-3rd-party-code-from-gbcs branch from 0d70552 to 4ce49e0 Compare June 5, 2024 17:34

WordPress deleted a comment from github-actions bot Jun 5, 2024

anton-vlasenko force-pushed the fix/remove-3rd-party-code-from-gbcs branch from 06edf90 to f734bfd Compare June 24, 2024 13:01

rodrigoprimo reviewed Jul 11, 2024

View reviewed changes

anton-vlasenko force-pushed the fix/remove-3rd-party-code-from-gbcs branch from cff54f7 to f1e6818 Compare July 19, 2024 18:03

anton-vlasenko requested a review from rodrigoprimo July 19, 2024 19:44

rodrigoprimo reviewed Aug 5, 2024

View reviewed changes

anton-vlasenko force-pushed the fix/remove-3rd-party-code-from-gbcs branch 2 times, most recently from 4050b2c to f843b61 Compare August 9, 2024 20:36

azaozz reviewed Aug 9, 2024

View reviewed changes

test/php/gutenberg-coding-standards/composer.json Show resolved Hide resolved

anton-vlasenko requested a review from azaozz August 9, 2024 21:01

azaozz approved these changes Aug 9, 2024

View reviewed changes

anton-vlasenko added 5 commits August 10, 2024 14:13

Update DocBlock to reflect changes to the find_previous_line_token me…

49becaf

…thod.

Update the inline comment as bootstrap.php doesn't need the PHPCS_DIR…

43dd7d2

… environment variable in the context of Gutenberg.

Add space per https://github.com/WordPress/gutenberg/pull/61913/files…

2fb65f9

…#r1704157375.

Add the #license section to the README.md (props to @azaozz).

ded90f0

anton-vlasenko force-pushed the fix/remove-3rd-party-code-from-gbcs branch from f843b61 to ded90f0 Compare August 10, 2024 12:14

anton-vlasenko merged commit ba8c2c0 into trunk Aug 12, 2024
60 checks passed

anton-vlasenko deleted the fix/remove-3rd-party-code-from-gbcs branch August 12, 2024 11:06

github-actions bot added this to the Gutenberg 19.1 milestone Aug 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix gutenberg/gutenberg-coding-standards licensing issues #61913

Fix gutenberg/gutenberg-coding-standards licensing issues #61913

anton-vlasenko commented May 23, 2024 •

edited

Loading

github-actions bot commented May 23, 2024 •

edited

Loading

github-actions bot commented Jun 5, 2024 •

edited

Loading

rodrigoprimo left a comment

rodrigoprimo Jul 11, 2024

anton-vlasenko Jul 19, 2024

rodrigoprimo Aug 5, 2024

anton-vlasenko Aug 5, 2024

anton-vlasenko commented Jul 19, 2024

rodrigoprimo left a comment

azaozz left a comment

anton-vlasenko commented Aug 12, 2024

Fix gutenberg/gutenberg-coding-standards licensing issues #61913

Fix gutenberg/gutenberg-coding-standards licensing issues #61913

Conversation

anton-vlasenko commented May 23, 2024 • edited Loading

What?

Why?

How?

Testing Instructions

Testing Instructions for Keyboard

Screenshots or screencast

github-actions bot commented May 23, 2024 • edited Loading

github-actions bot commented Jun 5, 2024 • edited Loading

rodrigoprimo left a comment

Choose a reason for hiding this comment

rodrigoprimo Jul 11, 2024

Choose a reason for hiding this comment

anton-vlasenko Jul 19, 2024

Choose a reason for hiding this comment

rodrigoprimo Aug 5, 2024

Choose a reason for hiding this comment

anton-vlasenko Aug 5, 2024

Choose a reason for hiding this comment

anton-vlasenko commented Jul 19, 2024

rodrigoprimo left a comment

Choose a reason for hiding this comment

azaozz left a comment

Choose a reason for hiding this comment

anton-vlasenko commented Aug 12, 2024

anton-vlasenko commented May 23, 2024 •

edited

Loading

github-actions bot commented May 23, 2024 •

edited

Loading

github-actions bot commented Jun 5, 2024 •

edited

Loading