Scripts: Add support for start and build scripts to the package #12837
Conversation
gziolo
added
[Status] In Progress
gziolo
force-pushed
the
add/scripts-build-start
branch
2 times, most recently
from
3a3c365
to
34649e5
Compare
gziolo
force-pushed
the
add/scripts-build-start
branch
from
6832676
to
9d8e17b
Compare
gziolo
force-pushed
the
add/scripts-build-start
branch
from
9d8e17b
to
c6f06ea
Compare
gziolo
force-pushed
the
add/scripts-build-start
branch
from
c6f06ea
to
dbeed60
Compare
|
@youknowriad are we fine to land it as part of 5.0 (Gutenberg)? |
|
I'm personally fine, but would love some inputs from people that tried building custom plugins and if this solves their need cc @aduth ? |
|
Discussed in today's #core-js meeting (link requires registration): https://wordpress.slack.com/archives/C5UNMSU4R/p1548165732173600 |
|
|
||
| if ( hasWebpackConfig ) { | ||
| // Sets environment to production. | ||
| process.env.NODE_ENV = 'production'; |
There was a problem hiding this comment.
It's a bit strange to me for the script to be explicitly assigning an environment variable, though I think it's likely the most effective way to capture how most configurations would consider the current environment.
There was a problem hiding this comment.
It replicates what Gutenberg does as of today. There is a similar trick used for unit tests where NODE_ENV is forced to test.
* Scripts: Add build and start scripts to wp-script * Introduce start and build scripts in scripts package * Use Webpack for builds in scripts package * Add documentation for start and build commands * Address feedback from review
* Scripts: Add build and start scripts to wp-script * Introduce start and build scripts in scripts package * Use Webpack for builds in scripts package * Add documentation for start and build commands * Address feedback from review
Description
Inspired by work done by @griffbrad in #12685 where he tries to extract the big chunk of Webpack config for the usage outside of Gutenberg. This PR offers two new
@wordpress/scriptscommands to help with maintaining ESNext codebase:wp-scripts buildwp-scripts startThis PR doesn't provide the default Webpack config. I'm leaving it for #12685.
It uses Parcel by default to make it easy to start using build tools for plugin developers. It should work for plugins without any Babel config provided. However, it would be nice to recommend using@wordpress/babel-preset-defaultto get everything aligned with core development.Edit: I removed Parcel integration from this PR as it can't be zero-config for WordPress development because of the need to provide Babel config override manually. Parcel also doesn't allow to list the packages which won't be bundled - we need that for all WordPress packages that are being already served by WordPress core.
For advanced usage it uses Webpack when accompanying config file is provided using on of the following:
--configCLI optionwebpack.config.jswebpack.config.babel.jsThis PR is still in progress. It needs the following:Tasks finished:@wordpress/scriptspackage@wordpress/scriptsto be updatedHow has this been tested?
npm run dev./node_modules/.bin/wp-scripts startnpm run build./node_modules/.bin/wp-scripts build