Rename _PrintTypes to ComponentLifecycleLabels

Author: dolfbarr

src/index.tsx

@@ -11,7 +11,7 @@ import {
   UseLogConfig,
   UseLogReturn,
   LogConfig,
-  _PrintTypes,
+  ComponentLifecycleLabels,
   _PrintConfig,
   Printer,
 } from './types'
@@ -98,15 +98,15 @@ export function useLog({
 
         useEffect(function onMount() {
           print({
-            type: _PrintTypes.Mount,
+            type: ComponentLifecycleLabels.Mount,
             ...printProps,
           })
 
           prevValueRef.current = value
 
           return function onUnmount() {
             print({
-              type: _PrintTypes.Unmount,
+              type: ComponentLifecycleLabels.Unmount,
               prevValue: prevValueRef.current,
               ...printProps,
             })
@@ -116,7 +116,7 @@ export function useLog({
         useEffect(
           function onChange() {
             print({
-              type: _PrintTypes.Change,
+              type: ComponentLifecycleLabels.Change,
               prevValue: prevValueRef.current,
               ...printProps,
             })

src/types.ts

@@ -76,7 +76,7 @@ export interface UseLogReturn {
 export interface _PrintConfig<T> {
   value: T
   prevValue?: T
-  type?: _PrintTypes
+  type?: ComponentLifecycleLabels
   styles?: Styles
   componentName: string
   flags?: _PrintFlags
@@ -99,9 +99,9 @@ export type _PrintFlags =
     }
 
 /**
- * Label types of print groups
+ * Label types of component lifecycle stages
  */
-export enum _PrintTypes {
+export enum ComponentLifecycleLabels {
   Mount = 'Mount',
   Unmount = 'Unmount',
   Change = 'Change',

src/utils.test.ts

@@ -1,19 +1,21 @@
 import * as utils from './utils'
-import { _PrintConfig, _PrintTypes, Printer } from './types'
+import { _PrintConfig, ComponentLifecycleLabels, Printer } from './types'
 
 const { getGroupLabel, getComponentName, print, getPrinter, getMessage } = utils
 
 describe('utils', () => {
   jest.spyOn(utils, 'getCurrentTime').mockReturnValue('09:38 PM')
   describe('getGroupLabel', () => {
     it('renders', () => {
-      expect(getGroupLabel(_PrintTypes.Change)).toEqual('Change @ 09:38 PM')
+      expect(getGroupLabel(ComponentLifecycleLabels.Change)).toEqual(
+        'Change @ 09:38 PM',
+      )
     })
 
     it('renders with component name', () => {
-      expect(getGroupLabel(_PrintTypes.Mount, 'TestComponent')).toEqual(
-        'Mount in <TestComponent /> @ 09:38 PM',
-      )
+      expect(
+        getGroupLabel(ComponentLifecycleLabels.Mount, 'TestComponent'),
+      ).toEqual('Mount in <TestComponent /> @ 09:38 PM')
     })
   })
 

src/utils.ts

@@ -1,5 +1,10 @@
 import * as utils from './utils'
-import { Printer, _PrintConfig, _PrintTypes, _SupportedConsole } from './types'
+import {
+  Printer,
+  _PrintConfig,
+  ComponentLifecycleLabels,
+  _SupportedConsole,
+} from './types'
 import {
   CURRENT_VALUE_LABEL,
   DEFAULT_LABEL_SIZE,
@@ -16,7 +21,7 @@ export function stylePlaceholder(withCss?: boolean): string {
   return withCss ? '%c' : ''
 }
 
-export function getLabel(type: _PrintTypes): string {
+export function getLabel(type: ComponentLifecycleLabels): string {
   return `On ${type}`
 }
 
@@ -33,7 +38,7 @@ export function getMessage<T>(
 }
 
 export function getGroupLabel(
-  type: _PrintTypes,
+  type: ComponentLifecycleLabels,
   componentName?: string,
   withComponentCSS?: boolean,
   withSubValueCSS?: boolean,
@@ -89,7 +94,7 @@ export function print<T>({
     isCollapsed: false,
     isGrouped: true,
   },
-  type = _PrintTypes.Change,
+  type = ComponentLifecycleLabels.Change,
   styles: { componentCSS, subValueCSS, changeCSS } = {},
   printer = {},
   logLevel = 'log',