Bläddra i källkod

chore: short logger methods

alvarosabu 1 år sedan
förälder
incheckning
46d53639b0

+ 2 - 2
src/components/TresCanvas.vue

@@ -67,7 +67,7 @@ const props = withDefaults(defineProps<TresCanvasProps>(), {
   failIfMajorPerformanceCaveat: undefined,
 })
 
-const { logWarning } = useLogger()
+const { warn } = useLogger()
 
 const canvas = ref<HTMLCanvasElement>()
 
@@ -175,7 +175,7 @@ onMounted(() => {
   )
 
   if (!camera.value) {
-    logWarning(
+    warn(
       'No camera found. Creating a default perspective camera. '
         + 'To have full control over a camera, please add one to the scene.',
     )

+ 2 - 2
src/composables/useLoader/index.ts

@@ -71,7 +71,7 @@ export async function useLoader<T extends LoaderProto<T>, U extends string | str
   onProgress?: (event: ProgressEvent<EventTarget>) => void,
   cb?: (proto: TresLoader<T>) => void,
 ) {
-  const { logError } = useLogger()
+  const { err } = useLogger()
   const proto = new Loader()
   if (cb) {
     cb(proto)
@@ -95,7 +95,7 @@ export async function useLoader<T extends LoaderProto<T>, U extends string | str
             resolve(data)
           },
           onProgress,
-          (error: ErrorEvent) => reject(logError('[useLoader] - Failed to load resource', error as unknown as Error)),
+          (error: ErrorEvent) => reject(err('[useLoader] - Failed to load resource', error as unknown as Error)),
         )
       }),
   )

+ 9 - 9
src/composables/useLogger.ts

@@ -4,21 +4,21 @@ export const isProd = import.meta.env.MODE === 'production'
 const logPrefix = '[TresJS ▲ ■ ●] '
 
 interface LoggerComposition {
-  logError: (message: string, error?: Error | ErrorEvent) => void
-  logWarning: (message: string) => void
-  logMessage: (name: string, value: any) => void
+  err: (message: string, error?: Error | ErrorEvent) => void
+  warn: (message: string) => void
+  msg: (name: string, value: any) => void
 }
 
 export function useLogger(): LoggerComposition {
-  function logError(message: string, error?: Error | ErrorEvent) {
+  function err(message: string, error?: Error | ErrorEvent) {
     console.error(`${logPrefix} ${message}`, error || '')
   }
 
-  function logWarning(message: string) {
+  function warn(message: string) {
     console.warn(`${logPrefix} ${message}`)
   }
 
-  function logMessage(name: string, value: any) {
+  function msg(name: string, value: any) {
     if (!isProd) {
       console.log(`${logPrefix} - ${name}:`, value)
     }
@@ -26,8 +26,8 @@ export function useLogger(): LoggerComposition {
   /*eslint-enable no-console */
 
   return {
-    logError,
-    logWarning,
-    logMessage,
+    err,
+    warn,
+    msg,
   }
 }

+ 2 - 2
src/composables/useRenderer/index.ts

@@ -157,7 +157,7 @@ export function useRenderer(
     renderer.value.setPixelRatio(pixelRatio.value)
   })
 
-  const { logError } = useLogger()
+  const { err } = useLogger()
 
   const getThreeRendererDefaults = () => {
 
@@ -184,7 +184,7 @@ export function useRenderer(
 
     if (rendererPreset) {
       if (!(rendererPreset in rendererPresets))
-        logError(`Renderer Preset must be one of these: ${Object.keys(rendererPresets).join(', ')}`)
+        err(`Renderer Preset must be one of these: ${Object.keys(rendererPresets).join(', ')}`)
 
       merge(renderer.value, rendererPresets[rendererPreset])
     }

+ 3 - 3
src/composables/useSeek/index.ts

@@ -20,7 +20,7 @@ export interface UseSeekReturn {
  * @return {*}  {UseSeekReturn}
  */
 export function useSeek(): UseSeekReturn {
-  const { logWarning } = useLogger()
+  const { warn } = useLogger()
 
   /**
    * Returns a child object of the parent given a property
@@ -40,7 +40,7 @@ export function useSeek(): UseSeekReturn {
     })
 
     if (!foundChild) {
-      logWarning(`Child with ${property} '${value}' not found.`)
+      warn(`Child with ${property} '${value}' not found.`)
     }
 
     return foundChild
@@ -64,7 +64,7 @@ export function useSeek(): UseSeekReturn {
     })
 
     if (!foundChildren.length) {
-      logWarning(`Children with ${property} '${value}' not found.`)
+      warn(`Children with ${property} '${value}' not found.`)
     }
 
     return foundChildren

+ 3 - 3
src/core/nodeOps.ts

@@ -14,7 +14,7 @@ function noop(fn: string): any {
 
 let scene: TresScene | null = null
 
-const { logError } = useLogger()
+const { err } = useLogger()
 
 const supportedPointerEvents = [
   'onClick',
@@ -36,7 +36,7 @@ export const nodeOps: RendererOptions<TresObject, TresObject> = {
     let instance
 
     if (tag === 'primitive') {
-      if (props?.object === undefined) logError('Tres primitives need a prop \'object\'')
+      if (props?.object === undefined) err('Tres primitives need a prop \'object\'')
       const object = props.object as TresObject
       name = object.type
       instance = Object.assign(object, { type: name, attach: props.attach, primitive: true })
@@ -44,7 +44,7 @@ export const nodeOps: RendererOptions<TresObject, TresObject> = {
     else {
       const target = catalogue.value[name]
       if (!target) {
-        logError(`${name} is not defined on the THREE namespace. Use extend to add it to the catalog.`)
+        err(`${name} is not defined on the THREE namespace. Use extend to add it to the catalog.`)
       }
       instance = new target(...props.args)
     }