Update CHANGELOG.md

CHANGELOG.md

@@ -4,6 +4,130 @@
 
 
 
+
+## [major-refactor branch](https://github.com/vatro/svelthree/tree/major-refactor)
+*tracked after [major-refactor-0.135.0-alpha.2](https://github.com/vatro/svelthree/tree/major-refactor-0.135.0-alpha.2)*
+
+### 🏷 major-refactor-0.135.0-alpha.3
+
+#### Refactored logging system
+
+Optimized for SvelteKit / Vite, depending on `VITE_SVELTHREE_VERBOSE` environment variable (*set in an .env file used as Vite `mode` configuration*) + per component logging configuration (via component attributes):
+
+- No `console.log(...)` entries only `.info`, `.debug`, `.warn` and `.error` (*most of it `.debug`, `.info` only with lifecycle related logs*).
+- Better styled console logs.
+
+- Building with `VITE_SVELTHREE_VERBOSE = 1`  will generate a **verbose version**  (e.g. build for **development**).. Logging can be controled per component via following component attributes:
+
+  - `log_all: boolean` logs everything or nothing. This behavior can be further limited or extended by adding:
+
+    - `log_dev: { all?: boolean; prop_utils?: boolean }`
+      Configures logging of all development logs (*various stuff*) with the option to turn on / off logging of the `PropUtils` class.
+
+    - `log_rs: boolean`
+      Configures logging of all **reactive statement related** logs.
+
+    - `log_lc: { all?: boolean; om?: boolean; bu?: boolean; au?: boolean; od?: boolean } `
+
+      Configures logging of all **lifecycle related** logs: `onMount`, `beforeUpdate`, `afterUpdate`, `onDestroy`. This is used to clearly mark lifecycle events inside the console (*optimized for Chrome-Dev-Tools console*) and should help understanding / debugging lifecycle related logic.
+
+    - `log_mau: boolean`
+
+      **WIP**: Configures logging of all **`matrixAutoUpdate` related** logic. This is currently primarily used for development of a new feature / functionality.
+
+- Building **without** `VITE_SVELTHREE_VERBOSE` (e.g. when running standard `svelte-kit dev` or `svelte-kit build`) or with `VITE_SVELTHREE_VERBOSE = 0`  will strip all logs from code.
+
+
+
+**Example SveltKit-App configuration** in order this to work as expected:
+
+```javascript
+/* svelte.config.js */
+
+import vercel from '@sveltejs/adapter-vercel';
+import preprocess from 'svelte-preprocess';
+
+/** @type {import('@sveltejs/kit').Config} */
+const config = {
+	// Consult https://github.com/sveltejs/svelte-preprocess
+	// for more information about preprocessors
+	preprocess: preprocess(),
+
+	kit: {
+		adapter: vercel(),
+
+		// hydrate the <div id="svelte"> element in src/app.html
+		target: '#svelte',
+		ssr: process.env.NODE_ENV === 'production',
+
+		// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+		vite: () => {
+			if (process.env.SVELTHREE_VERBOSE) {
+				if (process.env.NODE_ENV === 'development') {
+					return {
+						// see .env.svelthree-dev-verbose
+						mode: 'svelthree-dev-verbose'
+					}
+				} else if (process.env.NODE_ENV === 'production') {
+					return {
+						// see .env.svelthree-prod-verbose
+						mode: 'svelthree-prod-verbose'
+					}
+				} else {
+					// no .env.svelthree-xxx-verbose
+					console.error(`ERROR: svelte.config.js: No verbose svelthree-mode defined for process.env.NODE_ENV=${process.env.NODE_ENV}, svelthree will be silent.`)
+				}
+			} else {
+				return {}
+			}
+		}
+	},
+	// SvelteKit uses vite-plugin-svelte. Its options can be provided directly here.
+	// See the available options at https://github.com/sveltejs/vite-plugin-svelte/blob/main/docs/config.md
+	hot: {
+		acceptAccessors: true
+	}
+};
+
+export default config;
+```
+
+```text
+/* package.json (Windows 10)*/
+
+...
+"scripts": {
+    ...
+    "dev": "svelte-kit dev", //svelthree will be silent (not verbose)
+    "build": "svelte-kit build", //svelthree will be silent (not verbose)
+    "dev-svelthree-verbose": "set SVELTHREE_VERBOSE=1&& svelte-kit dev", //svelthree will be verbose
+    "build-svelthree-verbose": "set SVELTHREE_VERBOSE=1&& svelte-kit build", //svelthree will be verbose
+    ...
+},
+...
+```
+
+```text
+# file: '.env.svelthree-dev-verbose' in project root
+# defines Vite mode: 'svelthree-dev-verbose' -> develop in verbose mode (most probably needed)
+NODE_ENV=development
+VITE_SVELTHREE_VERBOSE=1
+```
+
+```
+# file: '.env.svelthree-prod-verbose' in project root
+# defines Vite mode: 'svelthree-prod-verbose' -> production build in verbose mode (might be needed for some reason)
+NODE_ENV=production
+VITE_SVELTHREE_VERBOSE=1
+```
+
+#### Miscellaneous
+
+- Added `onMount`, `beforeUpdate` and `afterUpdate` in all components where those were missing / might be needed (in most cases `beforeUpdate` and `afterUpdate`).
+- Minor Code refactorings / comment additions / changes etc.
+
+
+
 ## 0.119.0-5
 
 **✓ SAFE** *None API breaking changes*