chore: clean up

openedx · Jun 3, 2023 · d987b08 · d987b08
1 parent 2a78f67
commit d987b08
Show file tree

Hide file tree

Showing 7 changed files with 133 additions and 28 deletions.
diff --git a/config/data/paragonUtils.js b/config/data/paragonUtils.js
@@ -134,7 +134,12 @@ function getParagonCacheGroups(paragonThemeCss) {
 
 /**
  * @param {ParagonThemeCss} paragonThemeCss The Paragon theme CSS metadata.
- * @returns {Object.<string, string>} The entry points for the Paragon theme CSS.
+ * @returns {Object.<string, string>} The entry points for the Paragon theme CSS. Example: ```
+ * {
+ *   "paragon.theme.core": "/path/to/node_modules/@edx/paragon/dist/core.min.css",
+ *   "paragon.theme.variants.light": "/path/to/node_modules/@edx/paragon/dist/light.min.css"
+ * }
+ * ```
  */
 function getParagonEntryPoints(paragonThemeCss) {
   const entryPoints = {};

diff --git a/config/webpack.common.config.js b/config/webpack.common.config.js
@@ -13,6 +13,13 @@ const paragonThemeCss = getParagonThemeCss(process.cwd());
 module.exports = {
   entry: {
     app: path.resolve(process.cwd(), './src/index'),
+    /**
+     * The entry points for the Paragon theme CSS. Example: ```
+     * {
+     *   "paragon.theme.core": "/path/to/node_modules/@edx/paragon/dist/core.min.css",
+     *   "paragon.theme.variants.light": "/path/to/node_modules/@edx/paragon/dist/light.min.css"
+     * }
+     */
     ...getParagonEntryPoints(paragonThemeCss),
   },
   output: {

diff --git a/config/webpack.prod.config.js b/config/webpack.prod.config.js
@@ -16,6 +16,7 @@ const path = require('path');
 const PostCssAutoprefixerPlugin = require('autoprefixer');
 const PostCssRTLCSS = require('postcss-rtlcss');
 const PostCssCustomMediaCSS = require('postcss-custom-media');
+const CompressionPlugin = require('compression-webpack-plugin');
 
 // Reduce CSS file size by ~70%
 const purgecss = require('@fullhuman/postcss-purgecss');
@@ -210,6 +211,10 @@ module.exports = merge(commonConfig, {
       path: path.resolve(process.cwd(), '.env'),
       systemvars: true,
     }),
+    new CompressionPlugin({
+      algorithm: 'gzip',
+      test: /.js$|.css$/,
+    }),
     new BundleAnalyzerPlugin({
       analyzerMode: 'static',
       openAnalyzer: false,

diff --git a/example/package-lock.json b/example/package-lock.json
diff --git a/example/package.json b/example/package.json
@@ -15,7 +15,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@edx/paragon": "21.0.0-alpha.30",
+    "@edx/paragon": "^21.0.0-alpha.31",
     "react": "16.14.0",
     "react-dom": "16.14.0"
   },

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -45,6 +45,7 @@
     "babel-plugin-transform-imports": "2.0.0",
     "babel-polyfill": "6.26.0",
     "clean-webpack-plugin": "4.0.0",
+    "compression-webpack-plugin": "^10.0.0",
     "css-loader": "5.2.7",
     "cssnano": "6.0.1",
     "dotenv": "8.6.0",