feat: replace warnings by configure({ debug: true })

Author: gregberge

Diff for: README.md

@@ -275,6 +275,16 @@ We're also gathering
 **[Troubleshooting Recipes](https://github.com/gaearon/react-hot-loader/blob/next/docs/Troubleshooting.md)**
 so send a PR if you have a lesson to share!
 
+### Activate debug mode
+
+Debug mode adds additional warnings and can tells you why React Hot Loader is
+not working properly in your application.
+
+```js
+import { configure } from 'react-hot-loader'
+configure({ debug: true })
+```
+
 ## License
 
 MIT

Diff for: packages/react-hot-loader/README.md

@@ -12,10 +12,6 @@ npm install react-hot-loader
 
 Mark a component as hot.
 
-Available options are:
-
-* `warnings`: Enable some warnings (default to `true`)
-
 ```js
 import { hot } from 'react-hot-loader'
 

Diff for: packages/react-hot-loader/react-hot-loader.d.ts

@@ -10,7 +10,6 @@ declare module 'react-hot-loader' {
     errorReporter?:
       | React.ComponentClass<ErrorReporterProps>
       | React.StatelessComponent<ErrorReporterProps>
-    warnings?: boolean
   }
 
   export class AppContainer extends React.Component<

Diff for: packages/react-hot-loader/src/AppContainer.dev.js

@@ -9,10 +9,6 @@ class AppContainer extends React.Component {
   constructor(props) {
     super(props)
 
-    if (typeof __REACT_HOT_LOADER__ !== 'undefined') {
-      __REACT_HOT_LOADER__.warnings = props.warnings
-    }
-
     this.state = {
       error: null,
       generation: 0,
@@ -88,11 +84,6 @@ AppContainer.propTypes = {
     return undefined
   },
   errorReporter: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
-  warnings: PropTypes.bool,
-}
-
-AppContainer.defaultProps = {
-  warnings: true,
 }
 
 export default AppContainer

Diff for: packages/react-hot-loader/src/index.dev.js

@@ -1,5 +1,5 @@
 export { default as AppContainer } from './AppContainer.dev'
-export { hot, areComponentsEqual } from './utils.dev'
+export * from './utils.dev'
 
 export default function warnAboutIncorrectUsage(arg) {
   if (this && this.callback) {

Diff for: packages/react-hot-loader/src/index.prod.js

@@ -1,2 +1,2 @@
 export { default as AppContainer } from './AppContainer.prod'
-export { hot, areComponentsEqual } from './utils.prod'
+export * from './utils.prod'

Diff for: packages/react-hot-loader/src/patch.dev.js

@@ -30,7 +30,7 @@ const hooks = {
     resetProxies(useWeakMap)
   },
 
-  warnings: true,
+  debug: false,
   disableComponentProxy: false,
 }
 

Diff for: packages/react-hot-loader/src/reconciler/hotReplacementRender.js

@@ -199,7 +199,7 @@ const hotReplacementRender = (instance, stack) => {
         updateProxyById(stackChild.instance[PROXY_KEY], childType)
 
         next(stackChild.instance)
-      } else if (__REACT_HOT_LOADER__.warnings) {
+      } else if (__REACT_HOT_LOADER__.debug) {
         console.warn(
           `React-hot-loader: a ${getDisplayName(
             childType,

Diff for: packages/react-hot-loader/src/utils.dev.js

@@ -36,7 +36,7 @@ const makeHotExport = (sourceModule, getInstances) => {
   }
 }
 
-const hot = sourceModule => {
+export const hot = sourceModule => {
   let instances = []
   makeHotExport(sourceModule, () => instances)
   // TODO: Ensure that all exports from this file are react components.
@@ -73,6 +73,9 @@ const hot = sourceModule => {
   }
 }
 
-const areComponentsEqual = (a, b) => getProxyByType(a) === getProxyByType(b)
+export const areComponentsEqual = (a, b) =>
+  getProxyByType(a) === getProxyByType(b)
 
-export { hot, areComponentsEqual }
+export const configure = ({ debug }) => {
+  __REACT_HOT_LOADER__.debug = debug
+}

Diff for: packages/react-hot-loader/src/utils.prod.js

@@ -1,2 +1,3 @@
 export const areComponentsEqual = (a, b) => a === b
 export const hot = () => Component => Component
+export const configure = () => {}

Diff for: packages/react-hot-loader/test/AppContainer.dev.test.js

@@ -1393,27 +1393,6 @@ function runAllTests(useWeakMap) {
         expect(wrapper.text()).toBe('new render + old state + 20')
       })
     })
-
-    describe('container props', () => {
-      it('can disable warnings', () => {
-        mount(
-          <AppContainer>
-            <div>hey</div>
-          </AppContainer>,
-        )
-
-        expect(RHL.warnings).toBe(true)
-
-        mount(
-          <AppContainer warnings={false}>
-            <div>hey</div>
-          </AppContainer>,
-        )
-
-        expect(RHL.warnings).toBe(false)
-        delete RHL.warnings
-      })
-    })
   })
 }
 

Diff for: packages/react-hot-loader/test/patch.dev.test.js

@@ -145,26 +145,6 @@ function runAllTests(useWeakMap) {
       }
     })
 
-    it("doesn't report disabled warnings", () => {
-      const f1 = () => <div>123</div>
-      const dynamic = () => () => <div>123</div>
-      const spy = jest.spyOn(console, 'warn').mockImplementation(() => {})
-
-      try {
-        RHL.warnings = false
-
-        RHL.register(f1, 'f1', '/wow/test.js')
-        React.createElement(dynamic())
-        RHL.register(f1, 'f1', '/wow/test.js')
-        React.createElement(dynamic())
-
-        expect(console.warn.mock.calls.length).toBe(0)
-      } finally {
-        spy.mockRestore()
-        delete RHL.warnings
-      }
-    })
-
     it('resolves registered types by their last ID', () => {
       RHL.register(A1, 'a', 'test.js')
       const A = <A1 />.type

Diff for: packages/react-hot-loader/test/reconciler.test.js

@@ -84,7 +84,7 @@ describe('reconciler', () => {
       )
 
       const wrapper = mount(
-        <AppContainer warnings={false}>
+        <AppContainer>
           <App />
         </AppContainer>,
       )