Merge pull request #4 from cca-io/rescript

re-logger -> rescript-logger

Author: cknitt

README.md

@@ -1,24 +1,29 @@
-# re-logger
+# rescript-logger
 
-Simple logger library for [Reason](https://reasonml.github.io)/[BuckleScript](https://bucklescript.github.io) apps.
+Simple logger library for [ReScript](https://rescript-lang.org/) apps.
+
+## Design Goals
+
+1. Do not require a PPX, but still provide a way to include the module name in the log output.
+2. Pluggable logger implementation so that code shared between e.g. React and React Native can use a platform-specific implementation.
 
 ## Installation
 
 ```shell
 # yarn
-yarn add @cca-io/re-logger
+yarn add @cca-io/rescript-logger
 
 # or npm
-npm install @cca-io/re-logger
+npm install @cca-io/rescript-logger
 ```
 
-Then add re-logger to the dependencies in your `bsconfig.json`, e.g.:
+Then add rescript-logger to the dependencies in your `bsconfig.json`, e.g.:
 
 ```
 {
   "name": "my-app",
   ...
-  "bs-dependencies": ["reason-react", "@cca-io/re-logger"],
+  "bs-dependencies": ["@rescript/react", "@cca-io/rescript-logger"],
   ...
 }
 ```
@@ -27,18 +32,18 @@ Then add re-logger to the dependencies in your `bsconfig.json`, e.g.:
 
 Example:
 
-```reason
-module Log = (val ReLogger.make(__MODULE__));
+```rescript
+module Log = unpack(ResLogger.make(__MODULE__))
 
-Log.info("Starting");
+Log.info("Starting")
 
-/* ... */
+// ...
 
-Log.error2("Startup error", error);
+Log.error2("Startup error", error)
 ```
 
 The actual logger implementation is pluggable, so it can be swapped out e.g. for usage with React Native:
 
-```reason
-ReLogger.setLoggerImpl((module MyNativeLoggerImpl));
+```rescript
+ResLogger.setLoggerImpl(module(MyNativeLoggerImpl))
 ```

bsconfig.json

@@ -1,8 +1,8 @@
 {
-  "name": "@cca-io/re-logger",
+  "name": "@cca-io/rescript-logger",
   "sources": ["src"],
   "package-specs": {
-    "module": "commonjs",
+    "module": "es6",
     "in-source": true
   },
   "suffix": ".bs.js"

package.json

@@ -1,34 +1,32 @@
 {
-  "name": "@cca-io/re-logger",
-  "version": "1.2.0",
-  "description": "Simple logger library for Reason/BuckleScript apps",
-  "main": "src/ReLogger.bs.js",
-  "repository": "https://github.com/cca-io/re-logger.git",
+  "name": "@cca-io/rescript-logger",
+  "version": "2.0.0",
+  "description": "Simple logger library for ReScript apps",
+  "main": "src/ResLogger.res",
+  "repository": "https://github.com/cca-io/rescript-logger.git",
   "author": "Christoph Knittel <[email protected]>",
   "license": "MIT",
   "private": false,
   "scripts": {
-    "bs:build": "bsb",
-    "bs:clean": "bsb -clean",
-    "format": "bsrefmt --in-place src/*.re"
+    "build": "rescript build",
+    "watch": "rescript build -w",
+    "clean": "rescript clean",
+    "format": "rescript format -all"
   },
   "peerDependencies": {
-    "bs-platform": ">=5.0.4"
+    "rescript": ">=9.1.2"
   },
   "devDependencies": {
-    "bs-platform": "^8.0.0"
+    "rescript": "^9.1.2"
   },
   "files": [
     "src",
     "bsconfig.json"
   ],
   "keywords": [
-    "reason",
-    "reasonml",
+    "rescript",
     "log",
     "logger",
-    "logging",
-    "ocaml",
-    "bucklescript"
+    "logging"
   ]
 }

src/ReLogger.re

@@ -0,0 +1,117 @@
+type level =
+  | Debug
+  | Info
+  | Warn
+  | Error
+
+module type LoggerImpl = {
+  let log: (. level, string) => unit
+  let log2: (. level, string, 'a) => unit
+}
+
+module DefaultImpl: LoggerImpl = {
+  @val @scope("process.env") external nodeEnv: string = "NODE_ENV"
+  @send external padStart: (string, int, string) => string = "padStart"
+
+  let prependDate = message => {
+    let now = Js.Date.make()
+
+    let hours = now->Js.Date.getHours->Js.Float.toString->padStart(2, "0")
+    let minutes = now->Js.Date.getMinutes->Js.Float.toString->padStart(2, "0")
+    let seconds = now->Js.Date.getSeconds->Js.Float.toString->padStart(2, "0")
+
+    `${hours}:${minutes}:${seconds} ${message}`
+  }
+
+  let log = (. level: level, msg: string) => {
+    let msg = msg->prependDate
+
+    switch level {
+    | Debug =>
+      if nodeEnv === "development" {
+        Js.log(msg)
+      }
+    | Info => Js.Console.info(msg)
+    | Warn => Js.Console.warn(msg)
+    | Error => Js.Console.error(msg)
+    }
+  }
+
+  let log2 = (. level: level, msg: string, obj: 'a) => {
+    let msg = msg->prependDate
+
+    switch level {
+    | Debug =>
+      if nodeEnv === "development" {
+        Js.log2(msg, obj)
+      }
+    | Info => Js.Console.info2(msg, obj)
+    | Warn => Js.Console.warn2(msg, obj)
+    | Error => Js.Console.error2(msg, obj)
+    }
+  }
+}
+
+let loggerImpl: ref<module(LoggerImpl)> = ref(module(DefaultImpl: LoggerImpl))
+
+let setLoggerImpl = (impl: module(LoggerImpl)) => loggerImpl := impl
+
+module type Logger = {
+  let debug: string => unit
+  let info: string => unit
+  let warn: string => unit
+  let error: string => unit
+
+  let debug2: (string, 'a) => unit
+  let info2: (string, 'a) => unit
+  let warn2: (string, 'a) => unit
+  let error2: (string, 'a) => unit
+}
+
+let make = (moduleName: string): module(Logger) =>
+  module(
+    {
+      let prefix = `[${moduleName}] `
+      let prependModuleName = message => prefix ++ message
+
+      let debug = message => {
+        let module(I) = loggerImpl.contents
+        I.log(. Debug, message->prependModuleName)
+      }
+
+      let info = message => {
+        let module(I) = loggerImpl.contents
+        I.log(. Info, message->prependModuleName)
+      }
+
+      let warn = message => {
+        let module(I) = loggerImpl.contents
+        I.log(. Warn, message->prependModuleName)
+      }
+
+      let error = message => {
+        let module(I) = loggerImpl.contents
+        I.log(. Error, message->prependModuleName)
+      }
+
+      let debug2 = (message, obj) => {
+        let module(I) = loggerImpl.contents
+        I.log2(. Debug, message->prependModuleName, obj)
+      }
+
+      let info2 = (message, obj) => {
+        let module(I) = loggerImpl.contents
+        I.log2(. Info, message->prependModuleName, obj)
+      }
+
+      let warn2 = (message, obj) => {
+        let module(I) = loggerImpl.contents
+        I.log2(. Warn, message->prependModuleName, obj)
+      }
+
+      let error2 = (message, obj) => {
+        let module(I) = loggerImpl.contents
+        I.log2(. Error, message->prependModuleName, obj)
+      }
+    }
+  )