Create Block: Speed up scaffolding by omitting WordPress dependencies (…

…#37639) * Create Block: Speed up scaffolding by omitting WordPress dependencies * Add CHANGELOG entries * Exclude bundled WP packages from the ignore list * Update packages/eslint-plugin/configs/recommended-with-formatting.js
WordPress · Dec 29, 2021 · 2294dee · 2294dee
1 parent a5cb5b6
commit 2294dee
Show file tree

Hide file tree

Showing 11 changed files with 30 additions and 20 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -49,6 +49,7 @@ module.exports = {
  jsdoc: {
  mode: 'typescript',
  },
+ 'import/internal-regex': null,
  'import/resolver': require.resolve( './tools/eslint/import-resolver' ),
  },
  rules: {

diff --git a/packages/create-block-tutorial-template/CHANGELOG.md b/packages/create-block-tutorial-template/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Enhancement
+
+- Speed up scaffolding process by omitting WordPress dependencies in the template ([#37639](https://github.com/WordPress/gutenberg/pull/37639)).
+
 ## 1.3.0 (2021-07-21)
 
 ### Enhancement

diff --git a/packages/create-block-tutorial-template/index.js b/packages/create-block-tutorial-template/index.js
@@ -22,12 +22,6 @@ module.exports = {
  supports: {
  html: false,
  },
- npmDependencies: [
- '@wordpress/block-editor',
- '@wordpress/blocks',
- '@wordpress/components',
- '@wordpress/i18n',
- ],
  },
  templatesPath: join( __dirname, 'templates' ),
  assetsPath: join( __dirname, 'assets' ),

diff --git a/packages/create-block/CHANGELOG.md b/packages/create-block/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Enhancement
+
+- Speed up scaffolding process by omitting WordPress dependencies in the template ([#37639](https://github.com/WordPress/gutenberg/pull/37639)).
+
 ### Internal
 
 - The bundled `npm-package-arg` dependency has been updated from requiring `^8.0.1` to requiring `^8.1.5` ([#37395](https://github.com/WordPress/gutenberg/pull/37395)).

diff --git a/packages/create-block/lib/init-package-json.js b/packages/create-block/lib/init-package-json.js
@@ -48,7 +48,7 @@ module.exports = async ( {
  )
  );
 
- if ( size( npmDependencies ) ) {
+ if ( wpScripts && size( npmDependencies ) ) {
  info( '' );
  info(
  'Installing npm dependencies. It might take a couple of minutes...'

diff --git a/packages/create-block/lib/templates.js b/packages/create-block/lib/templates.js
@@ -44,11 +44,6 @@ const predefinedBlockTemplates = {
  supports: {
  html: false,
  },
- npmDependencies: [
- '@wordpress/block-editor',
- '@wordpress/blocks',
- '@wordpress/i18n',
- ],
  },
  templatesPath: join( __dirname, 'templates', 'esnext' ),
  },

diff --git a/packages/eslint-plugin/CHANGELOG.md b/packages/eslint-plugin/CHANGELOG.md
@@ -12,6 +12,10 @@
 - The bundled `eslint-plugin-jsdoc` dependency has been updated from requiring `^36.0.8` to requiring `^37.0.3` ([#36283](https://github.com/WordPress/gutenberg/pull/36283)).
 - The bundled `globals` dependency has been updated from requiring `^12.0.0` to requiring `^13.12.0` ([#36283](https://github.com/WordPress/gutenberg/pull/36283)).
 
+### Enhancement
+
+- Omit verification for WordPress dependencies in the import statements since they get externalized when used with WordPress ([#37639](https://github.com/WordPress/gutenberg/pull/37639)).
+
 ### Bug Fix
 
 - Fix Babel config resolution when a custom ESLint config present ([#37406](https://github.com/WordPress/gutenberg/pull/37406)). Warning: it won't recognize the `babel.config.json` file present in the project until the upstream bug in `cosmiconfig` is fixed.

diff --git a/packages/eslint-plugin/configs/custom.js b/packages/eslint-plugin/configs/custom.js
@@ -27,9 +27,4 @@ module.exports = {
  },
  },
  ],
- settings: {
- react: {
- version: '16.6',
- },
- },
 };
diff --git a/packages/eslint-plugin/configs/react.js b/packages/eslint-plugin/configs/react.js
@@ -6,7 +6,9 @@ module.exports = {
  },
  },
  settings: {
- 'import/extensions': [ '.js', '.jsx' ],
+ react: {
+ version: 'detect',
+ },
  },
  plugins: [ '@wordpress', 'react', 'react-hooks' ],
  rules: {

diff --git a/packages/eslint-plugin/configs/recommended-with-formatting.js b/packages/eslint-plugin/configs/recommended-with-formatting.js
@@ -3,6 +3,9 @@
  */
 const { isPackageInstalled } = require( '../utils' );
 
+// Exclude bundled WordPress packages from the list.
+const wpPackagesRegExp = '^@wordpress/(?!(icons|interface))';
+
 const config = {
  extends: [
  require.resolve( './jsx-a11y.js' ),
@@ -20,14 +23,23 @@ const config = {
  document: true,
  wp: 'readonly',
  },
+ settings: {
+ 'import/internal-regex': wpPackagesRegExp,
+ 'import/extensions': [ '.js', '.jsx' ],
+ },
  rules: {
  'import/no-extraneous-dependencies': [
  'error',
  {
  peerDependencies: true,
  },
  ],
- 'import/no-unresolved': 'error',
+ 'import/no-unresolved': [
+ 'error',
+ {
+ ignore: [ wpPackagesRegExp ],
+ },
+ ],
  'import/default': 'warn',
  'import/named': 'warn',
  },

diff --git a/packages/eslint-plugin/configs/recommended.js b/packages/eslint-plugin/configs/recommended.js
@@ -34,7 +34,6 @@ if ( isPackageInstalled( 'typescript' ) ) {
  extensions: [ '.js', '.jsx', '.ts', '.tsx' ],
  },
  },
- 'import/core-modules': [ 'react' ],
  };
  config.extends.push( 'plugin:@typescript-eslint/eslint-recommended' );
  config.ignorePatterns = [ '**/*.d.ts' ];