feat: add simple logging interface (js only at the moment) (#209)

package/example/Shared/index.js

@@ -6,6 +6,22 @@ import { StrictMode } from 'react'
 import { version } from 'react-native-worklets-core/package.json'
 console.log(`Using react-native-worklets-core@${version}`)
 
+// Setup a logger for filament
+import { setLogger } from 'react-native-filament'
+// A function that can wrap a console log call to add a prefix
+const prefix = '[filament-logger]'
+const prefixLog = (logFn) => (...messages) => {
+  const date = new Date()
+  logFn(prefix, `[${date.toLocaleTimeString()} ${date.getMilliseconds().toString().padStart(3, 0)}]`, ...messages)
+}
+setLogger({
+  debug: prefixLog(console.debug),
+  log: prefixLog(console.log),
+  info: prefixLog(console.info),
+  warn: prefixLog(console.warn),
+  error: prefixLog(console.error),
+})
+
 // Run filament tests
 import { runTests } from 'react-native-filament-test'
 runTests()

package/example/Shared/src/AnimationTransitions.tsx

@@ -19,7 +19,7 @@ import { DefaultLight } from './components/DefaultLight'
 const animationInterpolationTime = 5
 
 function Renderer() {
-  const { view, scene } = useFilamentContext()
+  const { view } = useFilamentContext()
 
   const model = useModel(DroneGlb)
   const modelAnimator = useAnimator(model)

package/src/index.tsx

@@ -19,6 +19,8 @@ export * from './hooks/useCameraManipulator'
 // utilities
 export * from './utilities/getAssetFromModel'
 export * from './utilities/withCleanupScope'
+export * from './utilities/logger/LoggingInterface'
+export { setLogger } from './utilities/logger/Logger'
 
 // Bullet 3
 export * from './bullet'

package/src/utilities/logger/Logger.ts

@@ -0,0 +1,21 @@
+import { LoggerInterface } from './LoggingInterface'
+
+let loggerInstance: LoggerInterface | null = null
+
+export const setLogger = (logger: LoggerInterface) => {
+  loggerInstance = logger
+}
+
+export const getLogger = (): LoggerInterface => {
+  if (loggerInstance == null) {
+    const noopLogger: LoggerInterface = {
+      debug: () => {},
+      info: () => {},
+      warn: () => {},
+      error: () => {},
+    }
+    return noopLogger
+  }
+
+  return loggerInstance
+}

package/src/utilities/logger/LoggingInterface.ts

@@ -0,0 +1 @@
+export type LoggerInterface = Pick<typeof console, 'debug' | 'info' | 'warn' | 'error'>