Build Tooling: Configure Webpack to watch only build files #21489
Conversation
aduth
added
[Type] Build Tooling
|
Size Change: +13.1 kB (1%) Total Size: 903 kB
ℹ️ View Unchanged
|
|
Considering an alternative: we could just have the pattern match any file within
I'd need to test if |
|
Yes, the proposed alternative is quite nice. If it works it will cover the majority of cases 👍 |
|
It seems to work pretty well: Note: One thing I want to follow-up on is: I seem to recall we have some packages that have files in the root of the package. The pattern above only matches files in a subfolder. |
Nothing relevant for this pull request. const { join } = require( 'path' );
const { readdirSync, statSync, existsSync } = require( 'fs' );
const PACKAGES_DIR = join( __dirname, '../packages' );
const packages = readdirSync( PACKAGES_DIR ).filter( ( candidate ) =>
statSync( join( PACKAGES_DIR, candidate ) ).isDirectory()
);
console.log(
'unnecessary src',
packages.filter(
( dir ) =>
! require( join( PACKAGES_DIR, dir, 'package.json' ) ).module &&
existsSync( join( PACKAGES_DIR, dir, 'src' ) )
)
);
console.log(
'absent src',
packages.filter(
( dir ) =>
require( join( __dirname, '../package.json' ) ).dependencies[
'@wordpress/' + dir
] &&
! require( join( PACKAGES_DIR, dir, 'package.json' ) ).module &&
! (
require( join( PACKAGES_DIR, dir, 'package.json' ) ).main || ''
).startsWith( 'lib/' )
)
); |
Interesting, I was wrong. Fortunately, it doesn't have any impact because it doesn't contain any production code. |
|
Should it be merged? |
I think it can be. I'm planning to do a wave of merges tomorrow. |
This pull request seeks to revise the Webpack configuration to instruct the watcher to ignore all files which are outside a package's build output directories. The project is built in such a way that Webpack is responsible only for the part of the build where package output is transformed to be run in a browser. The package build (Babel, etc) is handled separately, where the output is directed to a package's
build,build-module, andbuild-stylefolder, and then "handed off" to Webpack. Thus, it should be safe to assume that Webpack is only concerned with changes within these files.The intention with these changes is to resolve cases where an operating system may have limited resources to watch files, either hitting a limit or maxing processor usage.
Related:
Implementation Notes:
Credit to @draganescu for identifying
watchOptions.ignoredas the configuration for addressing the underlying issue.Webpack uses
anymatchunder the hood, which in turn usesmicromatch. Refer to documentation for more detail about the syntax of the glob patterns:Testing Instructions:
Verify there are no regressions in watch behavior. Changing a source file within a package should trigger a Webpack rebuild.