framework/js-packages/webpack-config
2024-09-28 14:04:50 +01:00
..
src fix: new webpack config doesn't work on windows (#4030) 2024-09-28 14:04:50 +01:00
tests feat: export registry (#3842) 2023-06-29 18:57:53 +01:00
.gitignore feat: add support for Plug'n'Play package managers (#14) 2021-11-08 23:53:18 +00:00
.prettierrc.json Fix Flarum on iOS 10 and below (#9) 2021-05-04 00:39:10 +01:00
babel.config.cjs feat: export registry (#3842) 2023-06-29 18:57:53 +01:00
LICENSE feat: messages extension (#4028) 2024-09-28 11:12:52 +01:00
package.json fix: 2.0 bugs (#4011) 2024-08-02 12:49:34 +01:00
README.md feat: export registry (#3842) 2023-06-29 18:57:53 +01:00

Webpack config for Flarum JS/TS compilation

This package generates a Webpack config object that will compile JavaScript for use in Flarum.

Usage

webpack.config.js

var config = require('flarum-webpack-config');

module.exports = config(options);

To merge in custom Webpack config options, use webpack-merge.

Webpack Bundle Analyzer

You can view a visual representation of your JS Bundle by building with Webpack Bundle Analyzer.

Add another build script to your package.json like the one below:

{
  "analyze": "npx cross-env ANALYZER=true npm run build"
}

Typescript

You'll need to configure a tsconfig.json file to ensure your IDE sets up Typescript support correctly.

For details about this, see the flarum/flarum-tsconfig repository