Chore: Add a comment how to analyze webpack bundle

styleguidist · Nov 8, 2018 · 84be452 · 84be452
1 parent 5c35029
commit 84be452
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -17,3 +17,4 @@ yarn.lock
 /cypress/
 test/cypress/screenshots/
 test/cypress/videos/
+stats.json
diff --git a/examples/sections/styleguide.config.js b/examples/sections/styleguide.config.js
@@ -74,6 +74,11 @@ module.exports = {
 				},
 			],
 		},
+		// How to analyze what's in the bundle:
+		// 1. Comment `hints: 'error'` line below
+		// 2. Uncomment a line with `stats.json` in src/scripts/build.js
+		// 3. npm run build:sections
+		// 4. npx webpack-bundle-analyzer stats.json
 		performance:
 			env === 'development'
 				? false