feat: default export & preMessage (#437)

* chore: preMessage

* test: master export

* test: update test case

* chore: more export

Author: zombieJ

package.json

@@ -15,6 +15,8 @@
     "url": "[email protected]:react-component/util.git"
   },
   "license": "MIT",
+  "main": "./lib/index",
+  "module": "./es/index",
   "files": [
     "lib",
     "es"

src/index.ts

@@ -0,0 +1,4 @@
+export { default as useMergedState } from './hooks/useMergedState';
+export { default as get } from './utils/get';
+export { default as set } from './utils/set';
+export { default as warning } from './warning';

src/warning.ts

@@ -1,17 +1,54 @@
 /* eslint-disable no-console */
 let warned: Record<string, boolean> = {};
 
+export type preMessageFn = (
+  message: string,
+  type: 'warning' | 'note',
+) => string | null | undefined | number;
+
+const preWarningFns: preMessageFn[] = [];
+
+/**
+ * Pre warning enable you to parse content before console.error.
+ * Modify to null will prevent warning.
+ */
+export const preMessage = (fn: preMessageFn) => {
+  preWarningFns.push(fn);
+};
+
 export function warning(valid: boolean, message: string) {
   // Support uglify
-  if (process.env.NODE_ENV !== 'production' && !valid && console !== undefined) {
-    console.error(`Warning: ${message}`);
+  if (
+    process.env.NODE_ENV !== 'production' &&
+    !valid &&
+    console !== undefined
+  ) {
+    const finalMessage = preWarningFns.reduce(
+      (msg, preMessageFn) => preMessageFn(msg ?? '', 'warning'),
+      message,
+    );
+
+    if (finalMessage) {
+      console.error(`Warning: ${finalMessage}`);
+    }
   }
 }
 
 export function note(valid: boolean, message: string) {
   // Support uglify
-  if (process.env.NODE_ENV !== 'production' && !valid && console !== undefined) {
-    console.warn(`Note: ${message}`);
+  if (
+    process.env.NODE_ENV !== 'production' &&
+    !valid &&
+    console !== undefined
+  ) {
+    const finalMessage = preWarningFns.reduce(
+      (msg, preMessageFn) => preMessageFn(msg ?? '', 'note'),
+      message,
+    );
+
+    if (finalMessage) {
+      console.warn(`Note: ${finalMessage}`);
+    }
   }
 }
 
@@ -38,5 +75,9 @@ export function noteOnce(valid: boolean, message: string) {
   call(note, valid, message);
 }
 
+warningOnce.preMessage = preMessage;
+warningOnce.resetWarned = resetWarned;
+warningOnce.noteOnce = noteOnce;
+
 export default warningOnce;
 /* eslint-enable */

tests/warning.test.js

@@ -1,8 +1,10 @@
-import React from 'react';
 import { render } from '@testing-library/react';
-import warning, { resetWarned, noteOnce } from '../src/warning';
+import React from 'react';
+import { warning } from '../src';
 import unsafeLifecyclesPolyfill from '../src/unsafeLifecyclesPolyfill';
 
+const { resetWarned, noteOnce } = warning;
+
 describe('warning', () => {
   beforeEach(() => {
     resetWarned();
@@ -67,4 +69,31 @@ describe('warning', () => {
     );
     warnSpy.mockRestore();
   });
+
+  describe('preMessage', () => {
+    it('modify message', () => {
+      const errSpy = jest.spyOn(console, 'error').mockImplementation(() => {});
+      const warnSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
+
+      warning.preMessage((msg, type) => {
+        if (type === 'warning') {
+          return `WW-${msg}`;
+        }
+        if (type === 'note') {
+          return `NN-${msg}`;
+        }
+
+        return null;
+      });
+
+      warning(false, 'warn');
+      warning.noteOnce(false, 'note');
+
+      expect(errSpy).toHaveBeenCalledWith('Warning: WW-warn');
+      expect(warnSpy).toHaveBeenCalledWith('Note: NN-note');
+
+      errSpy.mockRestore();
+      warnSpy.mockRestore();
+    });
+  });
 });