feat(overmind): improve warning on development exp and new option to turn off proxy value logging

Author: christianalfoni

packages/node_modules/overmind/src/index.ts

@@ -113,22 +113,30 @@ export class Overmind<Config extends Configuration> implements Configuration {
     */
 
     if (!IS_PRODUCTION && typeof window !== 'undefined') {
-      const originalConsoleLog = console.log
-      console.log = (...args) =>
-        originalConsoleLog.apply(
-          console,
-          args.map((arg) => (arg && arg[IS_PROXY] ? arg[VALUE] : arg))
-        )
+      let warning = 'OVERMIND: You are running in DEVELOPMENT mode.'
+      if (options.logProxies !== true) {
+        const originalConsoleLog = console.log
+
+        console.log = (...args) =>
+          originalConsoleLog.apply(
+            console,
+            args.map((arg) => (arg && arg[IS_PROXY] ? arg[VALUE] : arg))
+          )
+        warning +=
+          '\n\n - To improve debugging experience "console.log" will NOT log proxies from Overmind, but the actual value. Please see docs to turn off this behaviour'
+      }
+
       if (
         options.devtools ||
         (location.hostname === 'localhost' && options.devtools !== false)
       ) {
         this.initializeDevtools(options.devtools, eventHub, proxyStateTree)
       } else {
-        console.warn(
-          'OVERMIND: You are running in development mode, but not on localhost. You will have to manually define the devtools option to connect'
-        )
+        warning +=
+          '\n\n - You are not running on localhost. You will have to manually define the devtools option to connect'
       }
+
+      console.warn(warning)
     }
 
     eventHub.on(EventType.OPERATOR_ASYNC, (data) => {

packages/node_modules/overmind/src/internalTypes.ts

@@ -9,6 +9,7 @@ export type SubType<Base, Condition> = Pick<
 export type Options = {
   name?: string
   devtools?: string | boolean
+  logProxies?: boolean
 }
 
 export enum EventType {

packages/overmind-website/api/overmind.md

@@ -22,4 +22,11 @@ By default the application connects to the devtools on **localhost:3031**, but y
 
 ```marksy
 h(Example, { name: "api/app_options_devtools" })
+```
+
+## options.logProxies
+By default, in **development**, Overmind will make sure that any usage of **console.log** will log out the actual object/array, instead of any proxy wrapping it. This is most likely what you want. If you want to turn off this behaviour, set this option to **true**.
+
+```marksy
+h(Example, { name: "api/app_options_logproxies" })
 ```

packages/overmind-website/examples/api/app_options_logproxies.ts

@@ -0,0 +1,26 @@
+export default (ts) =>
+  ts
+    ? [
+        {
+          fileName: 'app/index.ts',
+          code: `
+...
+
+export const app = new Overmind(config, {
+  logProxies: false
+})
+        `,
+        },
+      ]
+    : [
+        {
+          fileName: 'app/index.js',
+          code: `
+...
+
+export const app = new Overmind(config, {
+  logProxies: false
+})
+`,
+        },
+      ]