Enforcing that the manifest keys NEVER start with "/"

Author: weaverryan

CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 0.12.0
+
+ * The `setManifestKeyPrefix()` method now forbids the key to
+   start with a `/` - #105.
+
 ## 0.11.0
 
  * The `webpack` package was upgraded from version 2.2 to 3.1 #53. The

lib/WebpackConfig.js

@@ -113,6 +113,18 @@ class WebpackConfig {
     }
 
     setManifestKeyPrefix(manifestKeyPrefix) {
+        /*
+         * Normally, we make sure that the manifest keys don't start
+         * with an opening "/" ever... for consistency. If you need
+         * to manually specify the manifest key (e.g. because you're
+         * publicPath is absolute), we're *still* adding this restriction,
+         * to help avoid a user accidentally adding an opening "/"
+         * and changing their keys from what they looked like before.
+         */
+        if (manifestKeyPrefix.indexOf('/') === 0) {
+            throw new Error(`For consistency, the value passed to setManifestKeyPrefix() cannot start with "/". Try setManifestKeyPrefix('${manifestKeyPrefix.replace(/^\//, '')}') instead.`);
+        }
+
         // guarantee a single trailing slash, except for blank strings
         if (manifestKeyPrefix !== '') {
             manifestKeyPrefix = manifestKeyPrefix.replace(/\/$/, '');

test/WebpackConfig.js

@@ -119,10 +119,10 @@ describe('WebpackConfig object', () => {
 
         it('You can set it!', () => {
             const config = createConfig();
-            config.setManifestKeyPrefix('/foo');
+            config.setManifestKeyPrefix('foo');
 
             // trailing slash added
-            expect(config.manifestKeyPrefix).to.equal('/foo/');
+            expect(config.manifestKeyPrefix).to.equal('foo/');
         });
 
         it('You can set it blank', () => {
@@ -132,6 +132,14 @@ describe('WebpackConfig object', () => {
             // trailing slash not added
             expect(config.manifestKeyPrefix).to.equal('');
         });
+
+        it('You cannot use an opening slash', () => {
+            const config = createConfig();
+
+            expect(() => {
+                config.setManifestKeyPrefix('/foo/');
+            }).to.throw('the value passed to setManifestKeyPrefix() cannot start with "/"');
+        });
     });
 
     describe('addEntry', () => {