Skip to content

Commit 324d715

Browse files
authored
fixed some comments in order to be coherent with docs
I fixed some comments in order to be coherent with symfony docs and with the output produced when some configuration is missing. E.g. Error: Cannot determine how to prefix the keys in manifest.json. Call Encore.setManifestKeyPrefix() to choose what path (e.g. build/) to use when building your manifes t keys. This is happening because you passed an absolute URL to setPublicPath().
1 parent 2684b7a commit 324d715

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

index.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ const publicApi = {
3939
/**
4040
* The directory where your files should be output.
4141
*
42-
* If relative (e.g. /web/build), it will be set relative
42+
* If relative (e.g. web/build), it will be set relative
4343
* to the directory where your package.json lives.
4444
*
4545
* @param {string} outputPath
@@ -55,13 +55,13 @@ const publicApi = {
5555
* The public version of outputPath: the public path to outputPath.
5656
*
5757
* For example, if "web" is your document root, then:
58-
* .setOutputPath('/web/build')
58+
* .setOutputPath('web/build')
5959
* .setPublicPath('/build')
6060
*
6161
* This can also be set to an absolute URL if you're using
6262
* a CDN: publicPath is used as the prefix to all asset paths
6363
* in the manifest.json file and internally in webpack:
64-
* .setOutputPath('/web/build')
64+
* .setOutputPath('web/build')
6565
* .setPublicPath('https://coolcdn.com')
6666
* // needed when public path is absolute
6767
* .setManifestKeyPrefix('/build')
@@ -85,14 +85,14 @@ const publicApi = {
8585
* But if publicPath is absolute, then we require you to set this.
8686
* For example:
8787
*
88-
* .setOutputPath('/web/build')
88+
* .setOutputPath('web/build')
8989
* .setPublicPath('https://coolcdn.com/FOO')
90-
* .setManifestKeyPrefix('/build')
90+
* .setManifestKeyPrefix('build/')
9191
*
9292
* The manifest.json file would look something like this:
9393
*
9494
* {
95-
* "/build/main.js": "https://coolcdn.com/FOO/main.a54f3ccd2.js"
95+
* "build/main.js": "https://coolcdn.com/FOO/main.a54f3ccd2.js"
9696
* }
9797
*
9898
* @param {string} manifestKeyPrefix

0 commit comments

Comments
 (0)