@libp2p/logger 1.0.0 → 1.0.4

package/README.md

@@ -31,12 +31,19 @@ const log = logger('libp2p:my:component:name')
 
 log('something happened: %s', 'it was ok')
 log.error('something bad happened: %o', err)
+
+log('with this peer: %p', aPeerId)
+log('and this base58btc: %b', aUint8Array)
+log('and this base32: %t', aUint8Array)
 ```
 
 ```console
 $ DEBUG=libp2p:* node index.js
 something happened: it was ok
 something bad happened: <stack trace>
+with this peer: 12D3Foo
+with this base58btc: Qmfoo
+with this base32: bafyfoo
 ```
 
 ## License

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,MAAM;IACrB,CAAC,SAAS,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IACtC,KAAK,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;IAC/C,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,wBAAgB,MAAM,CAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAI5C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAgCA,MAAM,WAAW,MAAM;IACrB,CAAC,SAAS,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IACtC,KAAK,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;IAC/C,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,wBAAgB,MAAM,CAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAI5C"}

package/dist/src/index.js

@@ -1,4 +1,26 @@
 import debug from 'debug';
+import { base58btc } from 'multiformats/bases/base58';
+import { base32 } from 'multiformats/bases/base32';
+// Add a formatter for converting to a base58 string
+debug.formatters.b = (v) => {
+    return base58btc.baseEncode(v);
+};
+// Add a formatter for converting to a base32 string
+debug.formatters.t = (v) => {
+    return base32.baseEncode(v);
+};
+// Add a formatter for stringifying peer ids
+debug.formatters.p = (p) => {
+    return p.toString(base58btc);
+};
+// Add a formatter for stringifying CIDs
+debug.formatters.c = (c) => {
+    return c.toString();
+};
+// Add a formatter for stringifying Datastore keys
+debug.formatters.k = (k) => {
+    return k.toString();
+};
 export function logger(name) {
     return Object.assign(debug(name), {
         error: debug(`${name}:error`)

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAQzB,MAAM,UAAU,MAAM,CAAE,IAAY;IAClC,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;QAChC,KAAK,EAAE,KAAK,CAAC,GAAG,IAAI,QAAQ,CAAC;KAC9B,CAAC,CAAA;AACJ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAKlD,oDAAoD;AACpD,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAa,EAAE,EAAE;IACrC,OAAO,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;AAChC,CAAC,CAAA;AAED,oDAAoD;AACpD,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAa,EAAE,EAAE;IACrC,OAAO,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;AAC7B,CAAC,CAAA;AAED,4CAA4C;AAC5C,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAS,EAAE,EAAE;IACjC,OAAO,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;AAC9B,CAAC,CAAA;AAED,wCAAwC;AACxC,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAM,EAAE,EAAE;IAC9B,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAA;AACrB,CAAC,CAAA;AAED,kDAAkD;AAClD,KAAK,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAM,EAAE,EAAE;IAC9B,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAA;AACrB,CAAC,CAAA;AAQD,MAAM,UAAU,MAAM,CAAE,IAAY;IAClC,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;QAChC,KAAK,EAAE,KAAK,CAAC,GAAG,IAAI,QAAQ,CAAC;KAC9B,CAAC,CAAA;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/logger",
-  "version": "1.0.0",
+  "version": "1.0.4",
   "description": "A logging component for use in js-libp2p components",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-logger#readme",
@@ -120,10 +120,10 @@
   },
   "scripts": {
     "lint": "aegir lint",
-    "dep-check": "aegir dep-check dist/src/**/*.js",
+    "dep-check": "aegir dep-check dist/src/**/*.js dist/test/**/*.js",
     "build": "tsc",
     "pretest": "npm run build",
-    "test": "aegir test -f ./dist/test/**/*.js",
+    "test": "aegir test -f ./dist/test/*.js -f ./dist/test/**/*.js",
     "test:chrome": "npm run test -- -t browser",
     "test:chrome-webworker": "npm run test -- -t webworker",
     "test:firefox": "npm run test -- -t browser -- --browser firefox",
@@ -133,7 +133,9 @@
   },
   "dependencies": {
     "@libp2p/interfaces": "^1.0.0",
-    "debug": "^4.3.3"
+    "debug": "^4.3.3",
+    "interface-datastore": "^6.1.0",
+    "multiformats": "^9.6.3"
   },
   "devDependencies": {
     "@types/debug": "^4.1.7",

package/src/index.ts

@@ -1,4 +1,34 @@
 import debug from 'debug'
+import { base58btc } from 'multiformats/bases/base58'
+import { base32 } from 'multiformats/bases/base32'
+import type { PeerId } from '@libp2p/interfaces/peer-id'
+import type { CID } from 'multiformats/cid'
+import type { Key } from 'interface-datastore'
+
+// Add a formatter for converting to a base58 string
+debug.formatters.b = (v: Uint8Array) => {
+  return base58btc.baseEncode(v)
+}
+
+// Add a formatter for converting to a base32 string
+debug.formatters.t = (v: Uint8Array) => {
+  return base32.baseEncode(v)
+}
+
+// Add a formatter for stringifying peer ids
+debug.formatters.p = (p: PeerId) => {
+  return p.toString(base58btc)
+}
+
+// Add a formatter for stringifying CIDs
+debug.formatters.c = (c: CID) => {
+  return c.toString()
+}
+
+// Add a formatter for stringifying Datastore keys
+debug.formatters.k = (k: Key) => {
+  return k.toString()
+}
 
 export interface Logger {
   (formatter: any, ...args: any[]): void