Scripts: Improve recommended settings included in the package

[gziolo]

Description

Fixes #17016.
Closes #17061.

Known Issues

When running npm run lint-js I see the following errors:

/Users/gziolo/PhpstormProjects/gutenberg-examples/test/examples.js
  10:1  error  'test' is not defined    no-undef
  11:2  error  'expect' is not defined  no-undef
  14:1  error  'test' is not defined    no-undef
  15:2  error  'expect' is not defined  no-undef

✖ 4 problems (4 errors, 0 warnings)

To solve it I had to add:

+ /* global test, expect */

at the top of the file which should work out of the box. This should work out of the box when using @wordpress/scripts.

I also had to put:

+ /**
+  * WordPress dependencies
+  */
import { Button } from '@wordpress/components';

above the import statement to fix the following issue:

 1:1  error  Expected preceding "WordPress dependencies" comment block  @wordpress/dependency-group

which I don't think we want to enforce outside of Gutenberg.

WordPress/gutenberg-examples#84 (review)

I think that having @wordpress/components as a dependency brings @wordpress/element as well. Ideally, we bring it as part of @wordpress/babel-preset-default which is the default handler for React regardless.

Changes Applied

@wordpress/babel-preset-default

Bug fix:

• Added missing @wordpress/element dependency which is used internally.

@wordpress/eslint-plugin

Breaking changes:

• New ruleset test-e2e added for end-to-end tests validation.
• New ruleset test-unit added for unit tests validation.

Enhancement:

• Remove @wordpress/dependency-group and @wordpress/gutenberg-phase rules from the custom and recommended configs and leave them as opt-in features.

All those changes directly influence @wordpress/scripts and improves the experience around its setup.

How has this been tested?

npm run lint-js

Types of changes

Checklist:

• My code is tested.
• My code follows the WordPress code style.
• My code follows the accessibility standards.
• My code has proper inline documentation.
• I've included developer documentation if appropriate.

[gziolo]

@ntwb, I was referring to this changes in #17061 (comment). I linked wrong PR 😃

[gziolo]

@youknowriad - can we include this change in Gutenberg 6.4 release so we could batch all breaking changes related to @wordpress/scripts package and all its dependencies?

[youknowriad]

Sure, I'd appreciate a review from someone actually using the scripts package. Maybe @swissspidy @ntwb or @nerrad

[nerrad]

I had a question but on the whole these changes look good.

[nerrad]

So does this change essentially mean that packages consuming wp-script don't need @babel/core as a dependency anymore?

[gziolo]

At some point, it was added as a regular dependencies so it is redundant here.

[nerrad]

👍 This is mostly a breaking change for consumers that are using these rules. Most consumers won't want/need them so I like.

[gziolo]

Do you think it should be highlighted as breaking change? I wasn’t sure where to put it. Given that, there are other breaking changes, we can more freely move it if necessary 😃

[nerrad]

I'm not sure either. The scope of when it's considered a breaking change is fairly narrow and it's only breaking in the sense the rules won't be applied automatically anymore.