fix(dev): merge 'assets' and 'output' paths

- Remove the concept of the "assets" directory entirely, and set the
"output" directory to be just "web/".
- Remove the old logo asset from /web/ (pre-Venia rebrand!)
- Gitignore entire "web" directory
- Set JS files to output to 'web/js' subdirectory by adding directory
prefix to `output.filename` and `output.chunkFilename`
- Modify tests, documentation, and type expectations to remove
`paths.assets`

Author: zetlen

.eslintignore

@@ -1,3 +1,4 @@
 __fixtures__
 dist
 pwa-devdocs
+packages/venia-concept/web

.gitignore

@@ -11,3 +11,4 @@ test-report.xml
 test-results.json
 lerna-debug.log
 .env
+packages/venia-concept/web

.prettierignore

@@ -3,3 +3,4 @@ package-lock.json
 dist
 web/js
 pwa-devdocs
+packages/venia-concept/web

packages/pwa-buildpack/README.md

@@ -218,8 +218,7 @@ which reads an ini-formatted file to set the environment.
 
     const themePaths = {
         src: path.resolve(__dirname, 'src'),
-        assets: path.resolve(__dirname, 'web'),
-        output: path.resolve(__dirname, 'web/js')
+        output: path.resolve(__dirname, 'web')
     };
     ```
 

packages/pwa-buildpack/docs/PWADevServer.md

@@ -21,8 +21,7 @@ module.exports = async env => {
             backendDomain: 'https://magento2.localdomain',
             serviceWorkerFileName: 'sw.js',
             paths: {
-                output: path.resolve(__dirname, 'web/js'),
-                assets: path.resolve(__dirname, 'web')
+                output: path.resolve(__dirname, 'web/'),
             },
             id: 'magento-venia'
         })

packages/pwa-buildpack/docs/ServiceWorkerPlugin.md

@@ -33,8 +33,7 @@ module.exports = async env => {
                 },
 
                 paths: {
-                    output: path.resolve(__dirname, 'web/js'),
-                    assets: path.resolve(__dirname, 'web')
+                    output: path.resolve(__dirname, 'web')
                 },
                 enableServiceWorkerDebugging: true,
                 serviceWorkerFileName: 'sw.js',
@@ -63,9 +62,9 @@ Plugin constructor for the `ServiceWorkerPlugin` class.
 `paths: Object` **(Required)**
 The local absolute paths to theme folders.
 
-- `paths.assets: String`
+- `paths.output: String`
 
-   The directory for public static assets.
+   The directory for build output.
 
 `enableServiceWorkerDebugging: Boolean`
 When `true`, hot reloading is enabled and the ServiceWorker is active in the document root, regardless of the publicPath value.

packages/pwa-buildpack/src/WebpackTools/PWADevServer.js

@@ -19,7 +19,6 @@ const PWADevServer = {
         publicPath: 'string',
         backendDomain: 'string',
         'paths.output': 'string',
-        'paths.assets': 'string',
         serviceWorkerFileName: 'string'
     }),
     hostnamesById: new GlobalConfig({
@@ -165,7 +164,7 @@ const PWADevServer = {
             },
             after(app) {
                 // set static server to load and serve from different paths
-                app.use(config.publicPath, express.static(config.paths.assets));
+                app.use(config.publicPath, express.static(config.paths.output));
 
                 // proxy to backend
                 app.use(

packages/pwa-buildpack/src/WebpackTools/__tests__/PWADevServer.spec.js

@@ -218,15 +218,15 @@ test('.configure() throws errors on missing config', async () => {
             id: 'foo',
             publicPath: 'bar',
             backendDomain: 'https://dumb.domain',
-            paths: { output: 'output' }
+            paths: { output: 1234 }
         })
-    ).rejects.toThrow('paths.assets must be of type string');
+    ).rejects.toThrow('paths.output must be of type string');
     await expect(
         PWADevServer.configure({
             id: 'foo',
             publicPath: 'bar',
             backendDomain: 'https://dumb.domain',
-            paths: { output: 'foo', assets: 'bar' }
+            paths: { output: 'foo' }
         })
     ).rejects.toThrow('serviceWorkerFileName must be of type string');
 });
@@ -243,8 +243,7 @@ test('.configure() gets or creates an SSL cert', async () => {
     const server = await PWADevServer.configure({
         id: 'heckin',
         paths: {
-            output: 'good',
-            assets: 'boye'
+            output: 'good'
         },
         publicPath: 'bork',
         serviceWorkerFileName: 'doin',
@@ -267,8 +266,7 @@ test('.configure() returns a configuration object for the `devServer` property o
     const config = {
         id: 'Theme_Unique_Id',
         paths: {
-            output: 'path/to/static',
-            assets: 'path/to/assets'
+            output: 'path/to/static'
         },
         publicPath: 'full/path/to/publicPath',
         serviceWorkerFileName: 'swname.js',
@@ -307,8 +305,7 @@ test('.configure() returns a configuration object with before() and after() hand
     const config = {
         id: 'Theme_Unique_Id',
         paths: {
-            output: 'path/to/static',
-            assets: 'path/to/assets'
+            output: 'path/to/static'
         },
         publicPath: 'full/path/to/publicPath',
         serviceWorkerFileName: 'swname.js',
@@ -364,8 +361,7 @@ test('.configure() optionally adds OriginSubstitution middleware', async () => {
     const config = {
         id: 'Theme_Unique_Id',
         paths: {
-            output: 'path/to/static',
-            assets: 'path/to/assets'
+            output: 'path/to/static'
         },
         publicPath: 'full/path/to/publicPath',
         serviceWorkerFileName: 'swname.js',

packages/pwa-buildpack/src/WebpackTools/plugins/ServiceWorkerPlugin.js

@@ -7,7 +7,7 @@ class ServiceWorkerPlugin {
     static validateOptions = optionsValidator('ServiceWorkerPlugin', {
         'env.phase': 'string',
         serviceWorkerFileName: 'string',
-        'paths.assets': 'string'
+        'paths.output': 'string'
     });
     constructor(config) {
         ServiceWorkerPlugin.validateOptions('ServiceWorkerPlugin', config);
@@ -17,7 +17,7 @@ class ServiceWorkerPlugin {
         const config = {
             // `globDirectory` and `globPatterns` must match at least 1 file
             // otherwise workbox throws an error
-            globDirectory: this.config.paths.assets,
+            globDirectory: this.config.paths.output,
             // TODO: (feature) autogenerate glob patterns from asset manifest
             globPatterns: ['**/*.{gif,jpg,png,svg}'],
 

packages/pwa-buildpack/src/WebpackTools/plugins/__tests__/ServiceWorkerPlugin.spec.js

@@ -19,7 +19,7 @@ test('throws if options are missing', () => {
                 env: { phase: 'development' },
                 serviceWorkerFileName: 'file.name'
             })
-    ).toThrow('paths.assets must be of type string');
+    ).toThrow('paths.output must be of type string');
 });
 
 test('returns a valid Webpack plugin', () => {
@@ -31,7 +31,7 @@ test('returns a valid Webpack plugin', () => {
             serviceWorkerFileName: 'sw.js',
             runtimeCacheAssetPath: 'https://location/of/assets',
             paths: {
-                assets: 'path/to/assets'
+                output: 'path/to/assets'
             }
         })
     ).toHaveProperty('apply', expect.any(Function));
@@ -45,7 +45,7 @@ test('.apply calls WorkboxPlugin.GenerateSW in prod', () => {
         serviceWorkerFileName: 'sw.js',
         runtimeCacheAssetPath: 'https://location/of/assets',
         paths: {
-            assets: 'path/to/assets'
+            output: 'path/to/assets'
         }
     });
     const workboxApply = jest.fn();
@@ -75,7 +75,7 @@ test('.apply calls nothing but warns in console in dev', () => {
         serviceWorkerFileName: 'sw.js',
         runtimeCacheAssetPath: 'https://location/of/assets',
         paths: {
-            assets: 'path/to/assets'
+            output: 'path/to/assets'
         }
     });
     jest.spyOn(console, 'warn').mockImplementationOnce(() => {});
@@ -103,7 +103,7 @@ test('.apply generates and writes out a serviceworker when enableServiceWorkerDe
         serviceWorkerFileName: 'sw.js',
         runtimeCacheAssetPath: 'https://location/of/assets',
         paths: {
-            assets: 'path/to/assets'
+            output: 'path/to/assets'
         }
     });