From fb9a739e3d09b84f1f501110394ac9ee97a0476d Mon Sep 17 00:00:00 2001 From: Grzegorz Ziolkowski Date: Thu, 24 May 2018 12:34:06 +0200 Subject: [PATCH 1/3] Build: Add new Webpack plugin to handle library default export --- lib/client-assets.php | 2 +- .../.npmrc | 1 + .../README.md | 45 +++++++++++++++++++ .../package.json | 31 +++++++++++++ .../src/index.js | 36 +++++++++++++++ webpack.config.js | 3 ++ 6 files changed, 117 insertions(+), 1 deletion(-) create mode 100644 packages/library-export-default-webpack-plugin/.npmrc create mode 100644 packages/library-export-default-webpack-plugin/README.md create mode 100644 packages/library-export-default-webpack-plugin/package.json create mode 100644 packages/library-export-default-webpack-plugin/src/index.js diff --git a/lib/client-assets.php b/lib/client-assets.php index b8f8eb024c973d..5424313886d064 100644 --- a/lib/client-assets.php +++ b/lib/client-assets.php @@ -1059,7 +1059,7 @@ function gutenberg_editor_scripts_and_styles( $hook ) { $script .= <<

Code is Poetry.

diff --git a/packages/library-export-default-webpack-plugin/package.json b/packages/library-export-default-webpack-plugin/package.json new file mode 100644 index 00000000000000..7444a8c0d573e4 --- /dev/null +++ b/packages/library-export-default-webpack-plugin/package.json @@ -0,0 +1,31 @@ +{ + "name": "@wordpress/library-export-default-webpack-plugin", + "version": "0.0.1", + "description": "Webpack plugin for exporting default property for selected libraries", + "author": "WordPress", + "license": "GPL-2.0-or-later", + "keywords": [ + "wordpress", + "webpack", + "webpack-plugin" + ], + "homepage": "https://github.com/WordPress/gutenberg/tree/master/packages/library-export-default-webpack-plugin/README.md", + "repository": { + "type": "git", + "url": "https://github.com/WordPress/gutenberg.git" + }, + "bugs": { + "url": "https://github.com/WordPress/gutenberg/issues" + }, + "main": "src/index.js", + "dependencies": { + "lodash": "4.17.5", + "webpack-sources": "1.1.0" + }, + "peerDependencies": { + "webpack": "^4.0.0" + }, + "publishConfig": { + "access": "public" + } +} diff --git a/packages/library-export-default-webpack-plugin/src/index.js b/packages/library-export-default-webpack-plugin/src/index.js new file mode 100644 index 00000000000000..bfb711bd1f4219 --- /dev/null +++ b/packages/library-export-default-webpack-plugin/src/index.js @@ -0,0 +1,36 @@ +/** + * External dependencies + */ +const { includes } = require( 'lodash' ); +const { ConcatSource } = require( 'webpack-sources' ); + +module.exports = class LibraryExportDefaultPlugin { + constructor( entryPointNames ) { + this.entryPointNames = entryPointNames; + } + + apply( compiler ) { + compiler.hooks.compilation.tap( 'LibraryExportDefaultPlugin', ( compilation ) => { + const { mainTemplate, chunkTemplate } = compilation; + + const onRenderWithEntry = ( source, chunk ) => { + if ( ! includes( this.entryPointNames, chunk.id ) ) { + return source; + } + return new ConcatSource( source, '["default"]' ); + }; + + for ( const template of [ mainTemplate, chunkTemplate ] ) { + template.hooks.renderWithEntry.tap( + 'LibraryExportDefaultPlugin', + onRenderWithEntry + ); + } + + mainTemplate.hooks.hash.tap( 'LibraryExportDefaultPlugin', ( hash ) => { + hash.update( 'export property' ); + hash.update( 'default' ); + } ); + } ); + } +}; diff --git a/webpack.config.js b/webpack.config.js index 87e3e939c64a98..ea455672100dc7 100644 --- a/webpack.config.js +++ b/webpack.config.js @@ -3,6 +3,7 @@ */ const ExtractTextPlugin = require( 'extract-text-webpack-plugin' ); const WebpackRTLPlugin = require( 'webpack-rtl-plugin' ); + const { get } = require( 'lodash' ); const { basename } = require( 'path' ); @@ -10,6 +11,7 @@ const { basename } = require( 'path' ); * WordPress dependencies */ const CustomTemplatedPathPlugin = require( '@wordpress/custom-templated-path-webpack-plugin' ); +const LibraryExportDefaultPlugin = require( './packages/library-export-default-webpack-plugin' ); // Main CSS loader for everything but blocks.. const mainCSSExtractTextPlugin = new ExtractTextPlugin( { @@ -273,6 +275,7 @@ const config = { return path; }, } ), + new LibraryExportDefaultPlugin( [ 'dom-ready' ].map( camelCaseDash ) ), ], stats: { children: false, From e9f5780a46f94544cc33b8ed3d01ba058ddbbdf8 Mon Sep 17 00:00:00 2001 From: Grzegorz Ziolkowski Date: Thu, 24 May 2018 14:28:38 +0200 Subject: [PATCH 2/3] Tests: Add tests for LibraryExportDefaultPlugin --- .../README.md | 2 +- .../package.json | 4 +++ .../test/fixtures/boo/index.js | 3 ++ .../test/fixtures/foo/index.js | 3 ++ .../test/fixtures/webpack.config.js | 22 +++++++++++++ .../test/index.js | 33 +++++++++++++++++++ 6 files changed, 66 insertions(+), 1 deletion(-) create mode 100644 packages/library-export-default-webpack-plugin/test/fixtures/boo/index.js create mode 100644 packages/library-export-default-webpack-plugin/test/fixtures/foo/index.js create mode 100644 packages/library-export-default-webpack-plugin/test/fixtures/webpack.config.js create mode 100644 packages/library-export-default-webpack-plugin/test/index.js diff --git a/packages/library-export-default-webpack-plugin/README.md b/packages/library-export-default-webpack-plugin/README.md index 100d1293f77635..f3521641c93431 100644 --- a/packages/library-export-default-webpack-plugin/README.md +++ b/packages/library-export-default-webpack-plugin/README.md @@ -30,7 +30,7 @@ module.exports = { }, output: { - filename: './build/[basename]/index.js', + filename: 'build/[name].js', path: __dirname, library: [ 'wp', '[name]' ], libraryTarget: 'this', diff --git a/packages/library-export-default-webpack-plugin/package.json b/packages/library-export-default-webpack-plugin/package.json index 7444a8c0d573e4..30e9d662dd715d 100644 --- a/packages/library-export-default-webpack-plugin/package.json +++ b/packages/library-export-default-webpack-plugin/package.json @@ -22,6 +22,10 @@ "lodash": "4.17.5", "webpack-sources": "1.1.0" }, + "devDependencies": { + "rimraf": "2.6.2", + "webpack": "4.8.3" + }, "peerDependencies": { "webpack": "^4.0.0" }, diff --git a/packages/library-export-default-webpack-plugin/test/fixtures/boo/index.js b/packages/library-export-default-webpack-plugin/test/fixtures/boo/index.js new file mode 100644 index 00000000000000..7a3f6c4baab50a --- /dev/null +++ b/packages/library-export-default-webpack-plugin/test/fixtures/boo/index.js @@ -0,0 +1,3 @@ +export default function boo() { + return 'boo'; +} diff --git a/packages/library-export-default-webpack-plugin/test/fixtures/foo/index.js b/packages/library-export-default-webpack-plugin/test/fixtures/foo/index.js new file mode 100644 index 00000000000000..7e78ec110b1bec --- /dev/null +++ b/packages/library-export-default-webpack-plugin/test/fixtures/foo/index.js @@ -0,0 +1,3 @@ +export default function foo() { + return 'foo'; +} diff --git a/packages/library-export-default-webpack-plugin/test/fixtures/webpack.config.js b/packages/library-export-default-webpack-plugin/test/fixtures/webpack.config.js new file mode 100644 index 00000000000000..b0c48fb101ba4f --- /dev/null +++ b/packages/library-export-default-webpack-plugin/test/fixtures/webpack.config.js @@ -0,0 +1,22 @@ +/** + * Internal dependencies + */ +const LibraryExportDefaultPlugin = require( '../../' ); + +module.exports = { + mode: 'development', + context: __dirname, + entry: { + boo: './boo', + foo: './foo', + }, + output: { + filename: 'build/[name].js', + path: __dirname, + library: [ 'wp', '[name]' ], + libraryTarget: 'global', + }, + plugins: [ + new LibraryExportDefaultPlugin( [ 'boo' ] ), + ], +}; diff --git a/packages/library-export-default-webpack-plugin/test/index.js b/packages/library-export-default-webpack-plugin/test/index.js new file mode 100644 index 00000000000000..83f839791ec91a --- /dev/null +++ b/packages/library-export-default-webpack-plugin/test/index.js @@ -0,0 +1,33 @@ +/** + * External dependencies + */ +const path = require( 'path' ); +const { promisify } = require( 'util' ); +const rimraf = promisify( require( 'rimraf' ) ); +const webpack = promisify( require( 'webpack' ) ); + +/** + * Internal dependencies + */ +const config = require( './fixtures/webpack.config.js' ); + +describe( 'LibraryExportDefaultPlugin', () => { + const buildDir = path.join( __dirname, '/fixtures/build' ); + + beforeAll( async () => { + await rimraf( buildDir ); + await webpack( config ); + } ); + + test( 'the default export of boo entry point is assigned to the library target', () => { + require( './fixtures/build/boo' ); + + expect( window.wp.boo() ).toBe( 'boo' ); + } ); + + test( 'the default export of foo entry point is not assigned to the library target', () => { + require( './fixtures/build/foo' ); + + expect( window.wp.foo.default() ).toBe( 'foo' ); + } ); +} ); From f71b6090a6d42305fe7803b1fa33ead29831011a Mon Sep 17 00:00:00 2001 From: Grzegorz Ziolkowski Date: Thu, 24 May 2018 14:45:22 +0200 Subject: [PATCH 3/3] Build: Fix the issue for production build for LibraryExportDefaultPlugin --- packages/library-export-default-webpack-plugin/src/index.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/library-export-default-webpack-plugin/src/index.js b/packages/library-export-default-webpack-plugin/src/index.js index bfb711bd1f4219..16b9dfb3eef7e7 100644 --- a/packages/library-export-default-webpack-plugin/src/index.js +++ b/packages/library-export-default-webpack-plugin/src/index.js @@ -14,7 +14,7 @@ module.exports = class LibraryExportDefaultPlugin { const { mainTemplate, chunkTemplate } = compilation; const onRenderWithEntry = ( source, chunk ) => { - if ( ! includes( this.entryPointNames, chunk.id ) ) { + if ( ! includes( this.entryPointNames, chunk.name ) ) { return source; } return new ConcatSource( source, '["default"]' );