@pwa/core
v0.5.4
Published
> PWA's core configuration builder. — [_View Docs_](https://pwa.cafe)
Downloads
45
Readme
@pwa/core
PWA's core configuration builder. — View Docs
$ npm install --save-dev @pwa/core
API
core(src, opts)
Returns:
WebpackCompiler
Returns an instance of Webpack.
Attaches a PWA_CONFIG
key on the WebpackCompiler
directly, containing the parsed pwa.config.js
file, if any.
Will also mutate opts
will additional keys:
src
– the resolvedsrc
value Equivalent toWebpackCompiler.options.context
value.webpack
- therequire('webpack')
instance in use For reuse / convenience elsewhere; eg, Plugins.
src
Type: String
Default: 'src'
The name of your "source" directory within the opts.cwd
. This will be set as the context
for Webpack.
Important: Reverts to the
opts.cwd
if the directory could not be found.
opts.cwd
Type: String
Default: '.'
The current working directory.
opts.dest
Type: String
Default: 'build'
The name of the output
directory.
opts.analyze
Type: Boolean
Default: false
When this and opts.production
are both true
, attaches and starts Webpack Bundle Analyzer for bundle inspection.
opts.production
Type: Boolean
Default: false
If building configuration for production.
opts.template
Type: String
The name or path to a custom template for HTML Webpack Plugin.
If nothing is provided, then PWA will look for a index.{html,hbs,ejs}
file within your src
directory.
If an index.(html|hbs|ejs)
couldn't be found, then the internal template will be used.
License
MIT © Luke Edwards